gestaoclick_vendas_list
Vendas: Listar (GET /api/vendas).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| account | No |
Vendas: Listar (GET /api/vendas).
| 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?
The description's 'GET /api/vendas' is consistent with the annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true), so there is no contradiction. It adds the HTTP method/endpoint fact, but this largely reinforces what the annotations already convey about safety. It does not disclose pagination, result size, authentication needs, or scoping behavior.
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 compact fragment with no redundant text, and it front-loads the resource and verb. However, it reads more like a label than a functional description; it is under-specified rather than appropriately concise given the tool's undocumented parameters. There is no wasted content, but important information is missing.
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?
With two undocumented parameters, no output schema, and no description of filtering, pagination, or result semantics, the description leaves major gaps for an agent selecting and invoking this tool. The annotations cover the safety profile but not behavior such as what is returned or how query/account interact. The endpoint alone does not make this a complete tool description.
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% for the two parameters (query, account), and the description never mentions either parameter. There is no hint of what 'query' filters on or how 'account' scopes the listing. The agent must guess parameter semantics entirely from the bare property names, which is insufficient for correct invocation.
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 states a clear verb ('Listar' = list) and resource ('Vendas' = sales), and also discloses the HTTP endpoint (GET /api/vendas). This distinguishes it from the sibling gestaoclick_vendas_get (single fetch) and other CRUD tools. However, it is a bare fragment with no elaboration on scope or filtering, so it stops short of a fully rich purpose statement.
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 provided on when to use this tool versus alternatives such as gestaoclick_vendas_get, gestaoclick_vendas_create, or gestaoclick_atributos_vendas_list. There are no stated exclusions, prerequisites, or contextual cues for choosing list over get. The description merely restates the action without situational guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.