Skip to main content
Glama

olist_separacao_alterar_situacao

Update the situation of an order separation in Olist by providing the separation ID, the new status code, and confirmation. States include awaiting separation, separated, packed, or in separation.

Instructions

Alterar Situação de uma Separação API 2.0. Endpoint API V2: separacao.alterar.situacao. Documentação: https://tiny.com.br/api-docs/api2-separacao-alterar-situacao Esta operação altera dados e exige confirmar=true.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
situacaoYesSituação da separação: (1) Aguardando separação, (2) Separada, (3) Embalada ou (4) Em separação
confirmarYesConfirma que a operação mutável foi revisada e deve ser executada.
idSeparacaoYesIdentificador da separação na Olist
Behavior4/5

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

With no annotations, the description carries the burden of behavioral disclosure. It explicitly states 'Esta operação altera dados' (this operation changes data) and 'exige confirmar=true' (requires confirm=true), which is valuable context about mutation and the confirmation requirement. However, it does not mention error handling, idempotency, or response behavior.

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, with two sentences total. It front-loads the purpose, then adds the endpoint and a mutation warning. The documentation URL is slightly redundant but does not detract significantly.

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

Completeness3/5

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

While the description covers the core purpose and mutation safety, it lacks context about expected return values (no output schema exists), possible errors, or when to use this operation relative to other separation-related tools. The absence of output schema means the description should explain the response, but it does not.

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 descriptions for all three parameters, covering 100% of them. The description only reinforces the confirmar=true requirement, which is already present in the schema as a const. No additional parameter semantics are added beyond the schema.

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

Purpose5/5

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

The description clearly identifies the tool's purpose: 'Alterar Situação de uma Separação' (change the status of a separation). It also specifies the API endpoint and provides a documentation link, making it distinct from sibling tools like olist_separacao_pesquisa and olist_separacao_obter.

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 does not provide any guidance on when to use this tool versus alternatives, nor does it mention exclusions or prerequisites. It only states the operation mutates data and requires confirmar=true, but no contextual workflow or decision-making information.

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