René's URL Explorer Experiment


Title: docs generator: tool descriptions past a 600-char window publish as empty strings, silently · Issue #6760 · simstudioai/sim · GitHub

Open Graph Title: docs generator: tool descriptions past a 600-char window publish as empty strings, silently · Issue #6760 · simstudioai/sim

X Title: docs generator: tool descriptions past a 600-char window publish as empty strings, silently · Issue #6760 · simstudioai/sim

Description: Found while validating the CrowdStrike integration (#6746). Three tool descriptions were publishing as empty strings in integrations.json and the generated MDX, with no build failure and no warning. Cause buildToolDescriptionMap searches...

Open Graph Description: Found while validating the CrowdStrike integration (#6746). Three tool descriptions were publishing as empty strings in integrations.json and the generated MDX, with no build failure and no warning...

X Description: Found while validating the CrowdStrike integration (#6746). Three tool descriptions were publishing as empty strings in integrations.json and the generated MDX, with no build failure and no warning...

Opengraph URL: https://github.com/simstudioai/sim/issues/6760

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"docs generator: tool descriptions past a 600-char window publish as empty strings, silently","articleBody":"Found while validating the CrowdStrike integration (#6746). Three tool descriptions were publishing as **empty strings** in `integrations.json` and the generated MDX, with no build failure and no warning.\n\n## Cause\n\n`buildToolDescriptionMap` searches only **600 characters forward from the `id:` match** when locating a tool's `description`. Any tool whose `description` field sits past that window — long params blocks, long TSDoc, a verbose `oauth`/`hosting` config declared before `description` — yields no match, and the entry is emitted blank rather than erroring.\n\n## Why it matters\n\n- It is **silent**. Nothing fails: not `type-check`, not `check:audits`, not the docs build. The published catalog entry and docs page just lose their description.\n- It is **position-dependent**, so it can appear on an unrelated edit that merely pushes `description` further down a file.\n- It is **repo-wide**. CrowdStrike is where it was caught, but any integration with long tool descriptions is likely affected right now.\n\n## Suggested fix\n\nPrefer parsing to a bounded regex window — the generator already reads tool source, so resolving `description` from the AST removes the window entirely. Failing that:\n\n1. Raise/remove the window, **and**\n2. **Fail the build on a blank description** rather than emitting an empty string. The silence is the real defect; a wrong description is visible, a missing one is not.\n\nA regression test asserting no generated catalog entry has an empty `description` would catch every instance repo-wide in one pass.\n\n## Related docs-generator defects found in the same batch\n\nThree distinct issues, same component — worth looking at together:\n\n1. **This one** — 600-char window silently blanks descriptions.\n2. **Shared `outputs`/`params` consts vanish from published docs** — the generator parses tool *source*, so extracting duplicated output literals into a shared const deletes those rows from the MDX. `query_cases` and `query_host_groups` are missing documented output rows on `staging` today because of this.\n3. **`table.mdx` divergence** — the generator *drops* a `nextCursor` row the committed file has, so every regeneration \"loses\" it and contributors keep reverting the diff by hand.\n\nEscaped `\\'` in a description also truncates the generated MDX cell mid-row (already known, tracked separately) — a lint rule rejecting `\\'` in tool descriptions would close that one.","author":{"url":"https://github.com/waleedlatif1","@type":"Person","name":"waleedlatif1"},"datePublished":"2026-08-16T01:20:54Z","url":"https://github.com/simstudioai/sim/issues/6760"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:9093bb09-a8dd-8f2f-5b90-351ae314d6af
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idBC32:330459:AEDA48:F77070:6AFB597C
html-safe-nonce714b7613a3ca586195e3ae2095e68f9d0a5a57e718f89bcf2db2334bb22d6b99
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQzMyOjMzMDQ1OTpBRURBNDg6Rjc3MDcwOjZBRkI1OTdDIiwidmlzaXRvcl9pZCI6IjI3OTk0NTczMDU5MTU3NzUzNTYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmacd336f7b41e62c24575f8ee9a9ebd3e06667950cc8acfe39db3270a00b828d826
hovercard-subject-tagissue:5162145191
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/simstudioai/sim/6760/issue_layout
twitter:imagehttps://opengraph.githubassets.com/81eb4bbd1d3aa9202cb76a95592215a812cdf74424e58f925f817403304f390e/simstudioai/sim/issues/6760
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/81eb4bbd1d3aa9202cb76a95592215a812cdf74424e58f925f817403304f390e/simstudioai/sim/issues/6760
og:image:altFound while validating the CrowdStrike integration (#6746). Three tool descriptions were publishing as empty strings in integrations.json and the generated MDX, with no build failure and no warning...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamewaleedlatif1
hostnamegithub.com
expected-hostnamegithub.com
Noneea33d13c96d0ff66bd8fa906b193d2213536b78cb06b0c50a4632c58b1418f94
turbo-cache-controlno-preview
go-importgithub.com/simstudioai/sim git https://github.com/simstudioai/sim.git
octolytics-dimension-user_id199344406
octolytics-dimension-user_loginsimstudioai
octolytics-dimension-repository_id912559512
octolytics-dimension-repository_nwosimstudioai/sim
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id912559512
octolytics-dimension-repository_network_root_nwosimstudioai/sim
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release59ef97164c52cf59bd10558ddec9c4f482763988
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/simstudioai/sim/issues/6760#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fissues%2F6760
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fissues%2F6760
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=simstudioai%2Fsim
Reloadhttps://github.com/simstudioai/sim/issues/6760
Reloadhttps://github.com/simstudioai/sim/issues/6760
Reloadhttps://github.com/simstudioai/sim/issues/6760
simstudioaihttps://github.com/simstudioai
simhttps://github.com/simstudioai/sim
Codehttps://github.com/simstudioai/sim
Issues129 (129)https://github.com/simstudioai/sim/issues
Pull requests197 (197)https://github.com/simstudioai/sim/pulls
Actionshttps://github.com/simstudioai/sim/actions
Projectshttps://github.com/simstudioai/sim/projects
Security and qualityhttps://github.com/simstudioai/sim/security
Insightshttps://github.com/simstudioai/sim/pulse
https://github.com/simstudioai/sim
New issuehttps://github.com/login?return_to=https://github.com/simstudioai/sim/issues/6760
New issuehttps://github.com/login?return_to=https://github.com/simstudioai/sim/issues/6760
docs generator: tool descriptions past a 600-char window publish as empty strings, silentlyhttps://github.com/simstudioai/sim/issues/6760#top
https://github.com/waleedlatif1
waleedlatif1https://github.com/waleedlatif1
on Aug 16, 2026https://github.com/simstudioai/sim/issues/6760#issue-5162145191
#6746https://github.com/simstudioai/sim/pull/6746
waleedlatif1https://github.com/waleedlatif1
completedhttps://github.com/simstudioai/sim/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Aug 16, 2026https://github.com/simstudioai/sim/issues/6760#event-29518237936
Sign up for freehttps://github.com/signup?return_to=https://github.com/simstudioai/sim/issues/6760
Sign in to commenthttps://github.com/login?return_to=https://github.com/simstudioai/sim/issues/6760
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.