Skip to main content
Glama

cOBD

Search fault codes

search_fault_codes
Read-onlyIdempotent

Find fault codes by the words in their name, such as "misfire cylinder 3", or look up one code.

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": {
      "query": "<query>"
    },
    "name": "search_fault_codes"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoHow many to return, 1 to 25. Default 10.
queryYesA few words or a code

Output Schema

NameRequiredDescriptionDefault
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior, so the safety profile needs no restating. The description adds the useful semantic that matching is on words in the code name rather than an exact field, but says nothing about result ordering, partial-match tolerance, or what happens with an unmatched query. An output schema exists, so return-format detail is reasonably excused.

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?

A single front-loaded sentence with the primary action first and the secondary lookup mode appended — no filler, no repetition of the title, and the example is embedded rather than given its own sentence.

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 two-parameter read-only search with full schema coverage, rich annotations, and an output schema, the description covers the essential input semantics. The remaining gap is competitive positioning against sibling tools that also touch fault codes, which the agent cannot resolve from this text alone.

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 both parameters are already documented, and the description largely restates the query field's "few words or a code". The example does add practical meaning about what a viable query string looks like, but the limit parameter (1-25, default 10) gets no mention beyond the schema.

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 and resource ("Find fault codes") and clarifies the two modes of input: free-word matching against the code name ("misfire cylinder 3") or an exact single-code lookup. It never names a sibling such as get_fault_codes or explain_fault_code, so the agent must infer the boundary between searching and listing/explaining.

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 implied through the concrete example query "misfire cylinder 3", which shows the intended fuzzy-symptom workflow, and "or look up one code" signals a second mode. There is no explicit when-not guidance, no statement that this is the right tool when you don't know the code, and no named alternative for browsing or explaining a code.

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