Skip to main content
Glama

cOBD

Explain a fault code

explain_fault_code
Read-onlyIdempotent

What an OBD-II fault code means, how serious it is, common causes and what to do. Example: P0420.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "code": "<code>"
    },
    "name": "explain_fault_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeYesA fault code such as P0420

Output Schema

NameRequiredDescriptionDefault
urlNo
codeYes
titleYes
adviceNo
causesNo
systemYes
summaryNo
severityYes
disclaimerNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered without the description. The description adds value by disclosing the content shape the agent will receive (severity, causes, recommended action), which helps it decide whether to call. It does not add anything about limits, caching, or failure behavior for unknown codes.

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?

Two short sentences with zero filler, front-loading what the tool answers before giving the example. Nothing is redundant or buried. A slightly stronger opening verb would have made it a 5.

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?

For a one-parameter, read-only lookup with an output schema and full annotations, the description covers the essential question of what information comes back. The only meaningful gap is routing guidance against the similarly named fault-code siblings, which matters here because get_fault_codes and search_fault_codes invite confusion.

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?

There is a single parameter with 100% schema coverage, so the baseline is 3. The description's only marginal addition is qualifying the code as OBD-II standard, which implies a format constraint the schema does not spell out, but the P0420 example simply repeats what the schema already shows.

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?

The description names a specific resource (an OBD-II fault code) and enumerates what the response covers: meaning, severity, common causes, and remediation. It is clearly distinct from siblings like get_fault_codes and search_fault_codes, which list or find codes rather than decode one. It stops short of a crisp verb-first statement, but the intent is unmistakable.

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 only implied: the agent must infer that it should call this once it already has a specific code in hand, and that listing/searching siblings serve a different need. No explicit when-to-use, when-not-to-use, or named alternative appears. The P0420 example slightly clarifies the trigger condition but is not guidance.

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