Read Jami doc page

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds genuinely new behavior: output is markdown with code samples intact, and long pages are paginated via offset with the result indicating where to continue.

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 the core action, then cleanly separated Args and Returns blocks with no filler sentences. Every line either defines a parameter or the return shape.

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?

An output schema exists, and the description still summarizes the return shape ({ title, url, markdown, offset, next_offset? }) and explains pagination, so an agent knows both how to call it and how to handle long pages. Nothing material is missing for a two-argument read tool.

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 0%, so the description must carry parameter meaning, and it does: it gives example path forms ("/docs/webhooks", "api/checkout", full URL), a special value for the overview, and explains offset as a continuation cursor with a default of 0 and a next_offset hint in the result.

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 and resource ("Read one JamiDev docs page as markdown") and adds the format detail that code samples are preserved. It implicitly separates itself from the sibling jami_search_docs by framing itself as reading a single page whose path comes from search.

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?

It tells the agent where the path argument comes from (jami_search_docs) and gives a concrete fallback ("Use '/docs' for the overview"), which establishes the intended workflow. It stops short of explicit when-not guidance, but the context for selecting this tool versus search is clear.

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