Skip to main content
Glama

RailCore Developers

Explain a RailCore API error

explain_error
Read-onlyIdempotent

What a RailCore API error means and how to fix it. Pass the error code (QUOTA_NOT_SUPPORTED), the HTTP status, or the whole error response. Never paste an API key or signing secret; any key-shaped text is removed before it is read.

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": "explain_error"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeNoThe error code, such as QUOTA_NOT_SUPPORTED.
statusNoThe HTTP status, such as 422.
endpointNoThe endpoint the request went to, if known.
error_jsonNoThe error response body. Remove any API key or secret first.

Output Schema

NameRequiredDescriptionDefault
fixYes
codeNo
knownYes
statusNo
meaningYes
categoryNo
docs_urlYes
endpointsYes
retryableNo
key_warningNo
catalog_generated_atYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely new context beyond them: that key-shaped text is stripped before the input is read, which explains both a security posture and why a pasted key is not a failure. Return format is left to the output schema, which exists.

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 sentences with zero padding: the first states what the tool does, the second how to call it and what safety constraint applies. The purpose and the most important caution are both front-loaded.

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 an output schema handling return values and rich annotations handling the safety profile, the description covers what remains: accepted input shapes and the secret-redaction caveat. The only minor gap is whether multiple inputs can be combined in a single call, which the agent must infer from the all-optional schema.

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%, so each of the four parameters is already documented, and the baseline is 3. The description names three of the four inputs (code, status, error_json) and implies they are substitutable, but it never mentions the endpoint parameter and adds no format detail beyond the schema's own examples.

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 states a specific verb-plus-resource ('What a RailCore API error means and how to fix it') for a named product, and the input forms it accepts (error code, HTTP status, whole error response) make it unmistakably a diagnostics tool rather than a docs lookup like search_docs or get_endpoint.

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 gives concrete invocation guidance: pass the code (with QUOTA_NOT_SUPPORTED as a worked example), the status, or the full error response, which clarifies that inputs are alternatives rather than a required set. It does not say when to prefer this over search_docs or get_code_sample, so it stops short of explicit alternative routing.

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