SalesSuite API guide

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds substantive context by enumerating what topics the guide covers, which functions as a proxy for return content since no output schema exists. It stops short of describing the guide's format or approximate size.

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?

Two sentences, front-loaded with what is returned, followed by the optional filter behavior. Every clause carries information and nothing is repeated from the schema verbatim.

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?

With no output schema, the description responsibly lists the guide's subject areas so an agent knows what it will get. For a zero-required-parameter documentation tool this is nearly complete; only the return format (markdown vs. structured) is left unspecified.

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 parameter is fully documented in the schema, including case-insensitivity and examples. The description restates only that filtering is optional and keyed to a section heading, adding little beyond the schema — baseline 3 is appropriate.

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?

Names a specific verb and resource ("Returns the SalesSuite API guide") and enumerates its contents — data model, property identification, note HTML, pagination, archived records, rate limits, webhooks. This clearly separates it from the sibling tools, which are all data-CRUD operations rather than documentation retrieval.

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?

Usage is implied by the content list — an agent can infer it should call this before constructing search filters or dealing with pagination. But there is no explicit statement of when to reach for it versus, say, list_properties or a specific sibling, and no note that it should be consulted first when property names are unknown.

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