Skip to main content
Glama

Describir una operación

describe_operation
Read-only

Todo sobre una operación: parámetros, cada campo del cuerpo (tipo, si es obligatorio, límites), ejemplos, el código con el SDK del lenguaje que elija y qué objeto contesta (sus campos con describe_object, o aquí con full).

Input Schema

NameRequiredDescriptionDefault
fullNotrue: también la tabla de cada campo de la respuesta (larga). Por omisión solo su nombre y un ejemplo.
languageNoEl SDK del ejemplo de código. Por omisión ts.
operationYesEl operationId (createInvoice), el método del SDK (invoices.create), el método y la ruta («POST /v1/invoices», «GET /v1/invoices/inv_123») o en palabras («create invoice», «cancelar factura»).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

The readOnlyHint and openWorldHint annotations already establish that this is a safe metadata lookup. The description adds useful behavioral detail: it emits SDK code for a chosen language and full=true produces a long response-field table, while the default only shows the name and an example.

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?

It is a single front-loaded sentence that immediately frames the tool as an operation-detail lookup. The parentheticals make it dense, but every listed item contributes to understanding what the tool 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?

With no output schema, the description appropriately enumerates the main returned artifacts: parameters, body fields, examples, SDK code, and response object information. It is nearly complete for a read-only documentation tool, with only minor gaps such as no explicit statement that it does not execute the operation.

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%, so the schema already documents operation, language, and full in detail. The description reinforces that language selects the SDK example and full expands the response table, but it does not add syntax or constraints 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 specifies that this tool returns everything about an operation: parameters, body field metadata (type, requiredness, limits), examples, SDK code, and the response object. It also distinguishes response-object detail from the sibling describe_object by noting that response fields can be retrieved there or here with full.

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?

Usage is mostly implied by the enumeration of returned content. The only explicit alternative routing is for response-object fields via describe_object or full, with no broader guidance on when to use this versus list_operations, call_api, or search_docs.

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