gestaoclick_formas_pagamentos_list
Formas pagamentos: Listar (GET /api/formas_pagamentos).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| account | No |
Formas pagamentos: Listar (GET /api/formas_pagamentos).
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| account | No |
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, destructiveHint=false. The description adds only the HTTP method (GET), which is consistent with annotations but provides no additional behavioral context such as return structure, limits, or side effects. It adds minimal value beyond the annotations.
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 sentence, which is concise, but it is under-specified—it essentially restates the tool name and adds the endpoint. It fails to include necessary usage details, so the brevity is not effective conciseness but rather omission.
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?
Given the tool has two undocumented parameters and no output schema, the description does not provide enough context for an agent to use it effectively. It lacks parameter semantics, return value expectations, and usage scenarios, making it incomplete for a functional tool.
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%, and the description provides no explanation of the 'query' or 'account' parameters. Without any description of their meaning or usage, an agent cannot correctly construct calls, making this a significant gap.
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 it lists payment methods (Formas pagamentos: Listar) and provides the endpoint. It is unambiguous about the resource and action, though it does not distinguish from sibling list tools with similar names.
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 guidance is given on when to use this tool versus alternatives, nor does it explain the purpose of the 'query' and 'account' parameters or any filtering or pagination considerations. The description only states the action without context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.