Skip to main content
Glama

Consultar uma nota

consultar_nota
Read-onlyIdempotent

Situação de uma nota desta conta (status, número, chave de acesso, erro).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "nota_id": "<nota_id>"
    },
    "name": "consultar_nota"
  }
}

Input Schema

NameRequiredDescriptionDefault
nota_idYesId da nota (veio da emissão ou de listar_notas).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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 clear without the description. The description adds useful output-field context and account scoping, but does not disclose permissions, not-found behavior, or other operational details beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no wasted words or repetition of the title. Every listed element, status, number, access key, and error, serves to clarify what the query returns.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a simple one-parameter read-only query with full schema coverage and annotations covering safety. Because there is no output schema, the description usefully lists expected return fields, though it could mention behavior for a missing or invalid note ID.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and nota_id is already fully documented in the schema, including its provenance. The description only adds the account-scope phrase 'desta conta' and does not expand on parameter meaning beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific resource and scope: the situation of one note belonging to this account, including status, number, access key, and error. It does not explicitly contrast with the sibling listar_notas, but the singular-by-ID framing distinguishes it from a listing tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The usage is implied: check the status of a note when you have its ID. The schema note that the ID comes from emission or listar_notas helps context, but the description itself gives no explicit when-to-use, when-not-to-use, or alternative tool guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources