get_docs
List documentation sections, or read an ID: getting-started, privacy, capabilities or integrations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No |
List documentation sections, or read an ID: getting-started, privacy, capabilities or integrations.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering the safety profile. The description adds useful behavioral context by naming the valid documentation IDs and indicating the list-versus-read behavior based on the id parameter.
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 front-loaded sentence with no filler. It delivers the core purpose and parameter guidance efficiently.
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 simple one-parameter, read-only tool with strong annotations, the description is complete enough for correct invocation. It covers both modes of operation and the accepted IDs, and no output schema is necessary given the simple 'list or read' semantics.
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 description coverage is 0%, yet the description compensates fully by explaining the sole parameter's meaning and enumerating valid values: getting-started, privacy, capabilities, or integrations. It also communicates the optional nature of id through the list-versus-read wording.
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 the action ('List documentation sections') and the resource, and it enumerates the specific valid IDs. This separates it from sibling tools like get_example and get_product_info because it is explicitly about documentation.
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: omit the id to list sections, provide an id to read that section. However, it does not explicitly mention siblings or state when to choose get_docs over get_example, get_product_info, or list_examples.
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.