Skip to main content
Glama

olist_expedicao_obter

Obtain expedition details for a given invoice, sales order, or expedition ID. Use to track shipping status in Olist/Tiny ERP.

Instructions

Obter expedições API 2.0. Endpoint API V2: expedicao.obter. Documentação: https://tiny.com.br/api-docs/api2-expedicao-obter

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idObjetoNoID da Nota Fiscal ou Pedido de Venda
tipoObjetoNoNota Fiscal (notafiscal) ou Pedido de Venda (venda)
idExpedicaoNoID da expedição na Olist
Behavior2/5

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

No annotations are present, so the description carries the full burden of behavioral disclosure. It only says 'get shipments' and provides the endpoint; it does not describe the return format, pagination, authentication needs, or side effects, even though it is a read operation.

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 concise and front-loaded with the verb 'Obter'. However, the 'API 2.0' and endpoint name are somewhat redundant, and the documentation link could be considered a substitute for inline guidance rather than a substitute for behavior.

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?

With no output schema and no annotations, the description should clarify what data is returned and how the optional parameters relate (e.g., object-based vs. expedition-based lookup). It does not; it relies entirely on an external docs link, leaving the agent without enough context to fully understand the tool's behavior.

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 already provides 100% coverage with clear descriptions for idObjeto, tipoObjeto, and idExpedicao. The tool description adds no additional parameter-level meaning, so it stays at the baseline for a fully documented schema.

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 'Obter expedições' (get shipments) and names the API endpoint 'expedicao.obter', giving a clear verb and resource. It is distinct from sibling tools like olist_expedicao_pesquisa, but it does not explicitly explain that this is for retrieving a specific shipment by ID/object rather than listing/searching.

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?

No guidance is provided on when to use this tool versus alternatives like olist_expedicao_pesquisa or olist_expedicao_obter_agrupamento_impressao. The description only gives an endpoint name and a documentation link, without mentioning use cases, prerequisites, or exclusions.

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