Skip to main content
Glama

Update Claix schema

claix.schemas.update
Idempotent

Update a Claix schema (PUT /api/update-schema/{schema_id}). Same body as create: name, type, schema_definition; optional Agent mode, window_context (Guardar Datos), source verification. Replaces the full configuration. Free call.

Input Schema

NameRequiredDescriptionDefault
nameYesHuman-readable schema name. Example: Facturas HTML.
typeYesSchema type matching an extraction endpoint. Example: txt-json, pdf-json.
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).
schema_idYesUUID del schema creado en el dashboard de Claix. Ejemplo: 550e8400-e29b-41d4-a716-446655440000. Llama a claix.schemas.list primero si no lo conoces.
is_agent_modeNoSet true to enable Agent mode. json-excel cannot use Agent mode.
resumen_agentNoOptional Agent-mode instruction, max 500 characters.
cita_por_campoNoEnables source verification: each extracted field (and agent_data) is returned as {value, source} instead of a bare value. Defaults to false.
window_contextNoGuardar Datos / Save Data. When true, JSON extractions insert a mapped row into the connected DB (needs connection + mapping rules). Default false.
agent_definitionNoRequired if is_agent_mode is true. Types: boolean, string, closed, integer. closed requires options[].
schema_definitionYesOutput fields. Each key is a JSON property; each value is { type: "string"|"integer"|"number"|"boolean", description: "..." }.

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

A3.9/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, readOnlyHint=false and openWorldHint=true, so the safety profile is largely covered. The description adds genuinely new context beyond those: full-configuration replacement semantics, an optional API key path (x-api-key header), and the 'Free call' cost signal. There is a mild tension between 'Replaces the full configuration' and destructiveHint=false, but that is consistent with PUT-style idempotent overwrite rather than a true annotation contradiction.

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 dense sentences, front-loaded with the action and endpoint, then the required/optional body and replacement caveat. No filler or repetition of the title.

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

Completeness5/5

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

The tool ships an output schema, so return values need not be explained, and annotations cover the safety profile. The description supplies the remaining agent-critical facts: full replacement semantics, the HTTP path, API-key optionality, and the free-call cost signal.

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 every parameter including enums, defaults, and the Agent-mode/json-excel constraint. The description's parameter list (name, type, schema_definition as required; Agent mode, window_context, source verification as optional) merely restates the schema, adding no format or syntax detail, so baseline 3 applies.

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 ('Update a Claix schema') and pins it to the concrete endpoint (PUT /api/update-schema/{schema_id}), which cleanly separates it from claix.schemas.create/delete/get/list. It does not explicitly name those siblings, but the verb and endpoint leave no ambiguity about what the tool does.

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?

'Same body as create' and 'Replaces the full configuration' imply how and when to call it (full replacement rather than a partial patch), which is meaningful guidance. However, there is no explicit when-to-use versus claix.schemas.create or delete, and no stated prerequisites beyond the replacement note.

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