API index
api_indexDiscovers the whole PageAudit API (self-describing index).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
api_indexDiscovers the whole PageAudit API (self-describing index).
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, covering the safety profile. The description adds the 'self-describing index' trait, which hints at the return format, but does not disclose auth needs, rate limits, or what the index actually contains.
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 front-loaded sentence with no filler. It is appropriately sized for a zero-parameter tool, though the parenthetical is slightly redundant with the main clause.
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 zero-parameter, no-output-schema tool whose annotations cover safety, the description is minimally adequate. It does not explain what the self-describing index returns or how it relates to other discovery siblings, leaving the agent to guess at the output structure.
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 tool takes zero parameters, so the baseline is 4. The description correctly implies a no-input discovery call and adds nothing misleading about parameters.
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 gives a specific verb ('Discovers') and resource ('the whole PageAudit API'), and the parenthetical 'self-describing index' clarifies the mechanism. It does not, however, differentiate itself from sibling discovery tools like list_tools or get_tool, leaving a small ambiguity.
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?
There is no when-to-use guidance, no conditions, and no named alternatives. The agent must infer that this is a discovery entry point, but nothing tells it when to prefer this over list_tools or get_tool.
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.