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
Domain: github.com
{"@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-profiling | 0 |
| react-import-map | react,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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:9093bb09-a8dd-8f2f-5b90-351ae314d6af |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BC32:330459:AEDA48:F77070:6AFB597C |
| html-safe-nonce | 714b7613a3ca586195e3ae2095e68f9d0a5a57e718f89bcf2db2334bb22d6b99 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQzMyOjMzMDQ1OTpBRURBNDg6Rjc3MDcwOjZBRkI1OTdDIiwidmlzaXRvcl9pZCI6IjI3OTk0NTczMDU5MTU3NzUzNTYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | d336f7b41e62c24575f8ee9a9ebd3e06667950cc8acfe39db3270a00b828d826 |
| hovercard-subject-tag | issue:5162145191 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/simstudioai/sim/6760/issue_layout |
| twitter:image | https://opengraph.githubassets.com/81eb4bbd1d3aa9202cb76a95592215a812cdf74424e58f925f817403304f390e/simstudioai/sim/issues/6760 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/81eb4bbd1d3aa9202cb76a95592215a812cdf74424e58f925f817403304f390e/simstudioai/sim/issues/6760 |
| og:image:alt | 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... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | waleedlatif1 |
| hostname | github.com |
| expected-hostname | github.com |
| None | ea33d13c96d0ff66bd8fa906b193d2213536b78cb06b0c50a4632c58b1418f94 |
| turbo-cache-control | no-preview |
| go-import | github.com/simstudioai/sim git https://github.com/simstudioai/sim.git |
| octolytics-dimension-user_id | 199344406 |
| octolytics-dimension-user_login | simstudioai |
| octolytics-dimension-repository_id | 912559512 |
| octolytics-dimension-repository_nwo | simstudioai/sim |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 912559512 |
| octolytics-dimension-repository_network_root_nwo | simstudioai/sim |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 59ef97164c52cf59bd10558ddec9c4f482763988 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width