Skip to main content
Glama

Create a Retrieve route

claix.routes.create

Create a Retrieve route (POST /routes). Body: { name, description, rules, tables: [{ name, columns: string[] }] }.

Input Schema

NameRequiredDescriptionDefault
nameYesRoute display name.
rulesYesNatural-language rules for the route.
tablesYesTables and columns from the active Data Map.
api_keyNoAPI key secreta de Claix. Ejemplo: claix_sk_abc123.... Opcional si la conexión MCP envía x-api-key en cabecera HTTP (recomendado en Smithery/Cursor).
descriptionYesWhat this route is for.

Output Schema

NameRequiredDescriptionDefault
dataNoJSON payload from the Claix API (extracted records, schema list, or Excel export metadata).
errorNoHuman-readable error message when success is false.
successYesTrue when Claix returned a successful response. False when isError is set on the tool result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the write/non-idempotent profile is covered structurally. The description adds the endpoint verb (POST /routes), which is useful context, but says nothing about side effects, permission requirements, or what state a new route starts in.

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?

A single tight sentence with the action and endpoint front-loaded and zero filler. The inline body recap is mildly redundant against a fully documented schema, but it costs little and stays compact.

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?

An output schema and annotations exist, so return values and the safety profile need not be explained. However, for a creation tool whose inputs depend on a published Data Map, the absence of any prerequisite or failure-mode context leaves a gap.

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 all five parameters are already documented in the schema; the description merely restates the body shape (name, description, rules, tables[].name, tables[].columns). It adds no semantics beyond the schema, which is the expected baseline 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 ('Create') and resource ('Retrieve route'), plus the HTTP endpoint POST /routes, so the agent can distinguish it from claix.routes.edit and claix.routes.delete. It does not explicitly name siblings or contrast them, but the verb/resource pair is unambiguous.

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 indication of when to create a route versus editing an existing one, nor any prerequisites (e.g. that tables must come from a published Data Map). The body shape hints at required inputs but gives no usage context or exclusions.

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