TheRundown Documentation MCP

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Adds rich context beyond the annotations: the filesystem is a documentation-backed sandbox, not a real shell; no writes/network/process control; calls are stateless with cwd resetting to `/`; and output is truncated to 30KB per call. These details materially affect how an agent should invoke the tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but well-structured with bold sections, a workflow callout, command list, and concrete examples. It is front-loaded with the key mental model and usage path, though some repetition around paths and statelessness makes it slightly verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter filesystem-query tool with no output schema, the description covers the necessary mental model, command capabilities, path discovery, stateless behavior, output size limits, and example invocations. An agent has enough information to call it correctly without further clarification.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single `command` parameter is already documented in the schema. The description still adds substantial value by listing supported commands, giving example invocations, and explaining batching, truncation, and stateless execution constraints.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb/resource: a read-only shell-like query against a virtualized in-memory filesystem containing only TheRundown API documentation and OpenAPI specs. It explicitly distinguishes from the sibling search tool by saying broad/conceptual queries should start with search, while this tool is for exact keyword/regex matching and structural exploration.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit workflow guidance: start with the search tool for broad queries, use this tool for exact matching or reading a page by path, discover paths with tree/ls before guessing, and use rg to locate topics when a path is not known. It also names alternatives and when to prefer them.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world). Beyond that, the description discloses the return shape (contextual content with titles and direct links) and the exact follow-up workflow including path transformation to `.mdx`, which is non-obvious operational detail an agent otherwise couldn't infer.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then usage, then return behavior, then the sibling handoff. The final sentence is dense but every clause (suffix, example command, path mapping) carries actionable information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, yet the description explains what results look like (titles and direct links) and how to continue past them. For a single-parameter search tool with strong annotations, nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Only one parameter exists and schema coverage is 100%, so the schema fully documents `query`. The description does not add syntax, length, or phrasing guidance beyond restating the general purpose, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (search) and resource (TheRundown API knowledge base) plus the content types returned (code examples, API references, guides). It differentiates itself from the sibling query_docs_filesystem by explicitly assigning full-page reading to that tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit use cases ('answer questions about TheRundown API, find specific documentation, understand how features work') and names the alternative with a concrete handoff rule: use query_docs_filesystem with `head`/`cat` plus the `.mdx` suffix convention when full page content is needed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=true, and idempotentHint=false, so the write/effect profile is covered. The description adds useful outcome context ('so the docs team can fix it') but says nothing about confirmation, rate limits, or what happens to submitted feedback, so it only marginally extends the structured data.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the action and purpose, followed by trigger conditions and exclusions. Every sentence earns its place with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter feedback tool with no output schema, the definition covers purpose, triggers, exclusions, and target audience completely. Annotations handle the mutation/effect profile, so nothing an agent needs to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and both parameters are well documented in the schema itself (path format, feedback content). The description adds no parameter-level detail beyond what the schema provides, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Report a problem with this documentation site') and makes the target explicit ('feedback about the documentation content itself'). It is clearly distinguishable from the read-only sibling tools query_docs_filesystem and search_sorsa_developer_platform, which retrieve rather than submit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly enumerates the triggering conditions ('incorrect, outdated, confusing, incomplete, or has a broken example') and adds clear exclusions ('not for product support requests or feedback about this tool or assistant'). This is a textbook when-to-use / when-not-to-use statement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.