API index
api_indexÍndice da API, com operações, formatos, autenticação e limites.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
api_indexÍndice da API, com operações, formatos, autenticação e limites.
| 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?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds the content categories it returns but says nothing about response shape, size, caching, or whether it is a static snapshot versus live state.
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 short sentence with no filler, and the resource is front-loaded. It is efficient, though it leans toward under-specification rather than genuine conciseness for a discovery endpoint.
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 no-param, no-output-schema index tool, the description minimally conveys what the caller will find (operations, formats, auth, limits). Given the crowded sibling namespace and the absence of output schema, it should at least state that this is the discovery/entry-point call, which it does not.
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 and the schema is empty with 100% coverage, so there is nothing for the description to compensate for. Baseline of 4 applies for a parameterless tool.
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 identifies the resource ('Índice da API') and enumerates the content it covers (operações, formatos, autenticação, limites), so an agent can infer it returns a catalog of the API surface. However, there is no verb and no differentiation from similarly named siblings such as api_access, ref, or health, leaving the agent to guess whether this is a discovery index or an access reference.
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 statement of when to call this tool versus the many sibling endpoints (api_access, ref, health, pricing, etc.). The agent receives no context about whether this is an entry-point/discovery call or something invoked during error recovery.
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.