read_local_document

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

The description indicates a read-only operation ('Read the full markdown content') with no side effects. With no annotations provided, it carries the full burden and does so adequately, though it could mention error handling (e.g., missing URL) or output format more explicitly.

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?

A single sentence conveys the purpose clearly without any unnecessary words or repetition. It is front-loaded and efficient.

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?

While the tool is simple, the description does not explicitly state that the return value is the markdown content as a string, nor what happens if the URL is not found. Given no output schema, this information would help the agent understand the result format.

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 input schema has 100% description coverage. The parameter description adds valuable context by specifying that the URL should be obtained from search_local_docs or mass_extract_guide, which clarifies the source beyond the schema's minimal description.

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 clearly states it reads markdown content of a Salesforce documentation page from the local SQLite database. It distinguishes itself from siblings like export_local_documents, mass_extract_guide, scrape_single_page, and search_local_docs by specifying the action (read) and the source (already extracted).

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 usage after extraction by stating 'already been extracted,' and the parameter description hints at obtaining URLs from search or mass_extract. However, it lacks explicit guidance on when to use this tool versus alternatives, and no when-not-to-use information is provided.

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