gestaoclick_pagamentos_list
Pagamentos: Listar (GET /api/pagamentos).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| account | No |
Pagamentos: Listar (GET /api/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 the HTTP method (GET) which aligns with these annotations. Since annotations cover the safety profile, the description contributes the specific HTTP context.
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?
Extremely short and to the point. It conveys the core information in one line, but it could add a bit more depth without wasting space.
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 low schema coverage and no output schema, the description should compensate with details about the return shape, pagination, and parameter use, but it doesn't. The tool is minimal but lacks essential context for an agent to use it correctly.
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 does not explain the 'query' and 'account' parameters. The agent has no clue what these parameters accept (query string? account ID?), despite having two optional 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 identifies the tool as 'Listar' (list) for 'Pagamentos' (payments) with an explicit GET endpoint. This distinguishes it from create/delete/update siblings, though it doesn't specify what data is returned or scope.
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 on when to use this tool versus alternative listing tools. The description just states the endpoint without context on filters or typical use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.