Skip to main content
Glama

olist_nota_servico_obter

Retrieve a service invoice by ID from Olist/Tiny ERP API. Get detailed information about a specific nota de serviço for integration or verification.

Instructions

Obter Nota de Serviço API 2.0. Endpoint API V2: nota.servico.obter. Documentação: https://tiny.com.br/api-docs/api2-notas-servico-obter

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesNúmero de identificação da nota de serviço na Olist
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavioral traits, but it only provides the endpoint and a documentation link. It does not state whether the operation is read-only, what the response contains, or any side effects. This lack of behavioral information is a significant gap for an agent deciding whether to invoke the tool.

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

Conciseness4/5

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

The description is appropriately sized and front-loaded with the main purpose. It consists of a single sentence plus endpoint and documentation reference, containing no redundant content. However, the documentation URL could be considered slightly extraneous in a description, though it adds value.

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

Completeness2/5

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

Given the absence of an output schema and annotations, the description should offer more context about return values or usage scenarios. It only identifies the endpoint and documentation link, which is insufficient for an agent to fully understand the tool's behavior and expected results.

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?

The input schema has 100% coverage for the single 'id' parameter, including a clear description of what it represents. The tool description adds no extra parameter semantics beyond the schema, so the baseline score of 3 is appropriate.

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 clearly states the tool's purpose with a specific verb and resource: 'Obter Nota de Serviço' (Get Service Note). It also identifies the API endpoint and provides documentation, making the intent unambiguous. However, it does not explicitly distinguish itself from sibling tools like olist_nota_servico_consultar, though the use of 'obter' and the 'id' parameter suggest direct retrieval by ID.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives such as olist_notas_servico_pesquisa or olist_nota_servico_consultar. It does not mention appropriate use cases, prerequisites, or exclusions, leaving the agent to infer usage solely from the tool name and sibling context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mauriciogior/olist-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server