Skip to main content
Glama
Sign In
automeli-docs-mcp

automeli-docs-mcp

Official
by Automeli-Services-Organization
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Describir un flujo de uso

describe_flow
Read-only

Returns a narrative guide for an end-to-end API flow, currently test-to-live, to explain publishing to test, promoting, and going live.

Instructions

Devuelve la guía narrativa de un flujo end-to-end de la API. Hoy disponible: 'test-to-live' (publicar en prueba → promover → real), el flujo recomendado.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "describe_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
flowNoClave del flujo. Disponibles: test-to-live.test-to-live
versionNoVersión de la API a consultar. Default "v2" (la doc canónica y recomendada). Usá "v1" SOLO para integraciones legadas que siguen en /api/v1.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety profile is covered. The description adds that it returns a narrative guide rather than raw data, which is useful behavioral context, but does not describe format, length, or pagination of the returned guide. With annotations covering the safety angle, a 3 is appropriate.

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?

Two tightly packed sentences with no filler, front-loading the core purpose and the only available option. Every phrase earns its place.

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?

Given a read-only, no-required-params tool with full schema coverage and no output schema, the description is nearly complete. It could mention that the guide is static or versioned, but nothing critical for an agent to call it correctly is missing.

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 coverage is 100% and both parameters have detailed enum descriptions, so the schema already documents semantics fully. The description only mentions the available flow value, which is already in the schema. Baseline 3 is correct when the schema does the heavy lifting.

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?

States a specific verb+resource (returns the narrative guide of an end-to-end API flow) which is distinct from siblings like get_endpoint or search_docs. It even names the currently available flow ('test-to-live') and what it does. However it does not explicitly contrast with siblings, which would be needed for a 5.

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

Usage Guidelines4/5

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

It clearly signals when this tool is useful by stating the only flow available and calling it 'el flujo recomendado', implying its use for end-to-end guidance rather than single-endpoint lookups. It does not explicitly state when NOT to use it (e.g., for individual endpoints).

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

Deploy Server

Other Tools