Get a Splice doc
get_docOne agent doc as markdown: getting-started, authentication, mcp or pricing (pricing includes the live model table).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Doc id. |
get_docOne agent doc as markdown: getting-started, authentication, mcp or pricing (pricing includes the live model table).
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Doc id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is fully covered. The description adds that the output is markdown and that the pricing doc carries a live/dynamic model table, which is useful context, but nothing about caching, freshness of other docs, or auth requirements.
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 tight sentence with the payload type ('markdown') and the valid ids front-loaded; no filler. The colon-and-list construction is slightly telegraphic but easy to parse.
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-param, no-output-schema read tool, the description covers what comes back (markdown) and the full space of valid ids. The main gap is the unresolved relationship with get_pricing and search_docs, which the agent must infer from sibling names alone.
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 'id' parameter is an enum with a description, so the schema fully documents it. The description restates the same four ids, which is redundant rather than additive; 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 the resource (a Splice agent doc) and the return format (markdown), and enumerates the four retrievable ids, so the agent knows exactly what this fetches. It does not differentiate from the get_pricing sibling, which overlaps on the 'pricing' id, leaving slight ambiguity about which to call for pricing data.
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?
No when-to-use or when-not guidance, and no routing to alternatives such as search_docs for topic discovery or get_pricing for pricing. The overlap with get_pricing is acknowledged only indirectly by noting the pricing doc contains the live model table.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.