Read a BeamNG documentation page

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

Annotations already declare readOnlyHint=true, and the description adds the useful context that the page is 'cached' and that only 'approved' URLs are accepted. However, it does not disclose return shape, error behavior, or what happens with stale cache entries, so it adds only modest behavioral context beyond the annotations.

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 a single, well-structured sentence with no filler. It is front-loaded with the action ('Read') and immediately conveys the key scope ('cached official page') and selection criteria.

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?

The tool is relatively simple, and the description covers the primary purpose and input method. But with no output schema, no parameter descriptions, and no guidance on 'approved URL' requirements or the 'heading' parameter, the description leaves some meaningful gaps for an agent trying to call the tool correctly.

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?

The description clarifies 'idOrUrl' by stating it accepts a document ID or approved documentation URL, which adds meaning beyond the bare schema. However, the optional 'heading' parameter is not explained at all, and with 0% schema description coverage the description only partially compensates for the missing parameter semantics.

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?

The description uses the specific verb 'Read' and names the exact resource ('cached official page'), while also specifying the selection mechanism ('by document ID or approved documentation URL'). This clearly distinguishes the tool from sibling tools like search or sync.

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?

The description implies the use case: when you have a document ID or approved URL and want to read the page content. However, it does not explicitly mention alternatives (e.g., beamng_docs_search) or provide when-not-to-use guidance, leaving the guidance implicit rather than explicit.

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