ColdState — Deterministic Knowledge Infrastructure

coldstate_explain

Read-onlyIdempotent

Explain why a specific document ranked for a query. Returns a per-term relevance breakdown and an overall match summary — deterministic and reproducible.

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": {
      "index_id": "<index_id>",
      "query": "<query>",
      "doc_id": "<doc_id>"
    },
    "name": "coldstate_explain"
  }
}

Input Schema

Name	Required	Description
`query`	Yes	The search query to explain against
`doc_id`	Yes	Document ID, e.g. "doc_42" or "42"
`index_id`	Yes	Index ID, e.g. idx_...

Schema Changelog

Changes observed during successful MCP inspections.

First observedSep 30, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds the deterministic and reproducible nature of the results and outlines the return composition, which goes beyond the structured fields without contradicting them.

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?

The description is two concise sentences, action-first, with no redundant information. Each sentence adds value: the first states the purpose, the second describes the output and a key behavioral trait.

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 read-only explain tool, the description adequately covers purpose, output, and determinism. There is no output schema, but the description summarizes the return value. It lacks explicit prerequisites/error behavior, but these are minor given the annotation safety profile.

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?

The input schema covers 100% of the parameters with descriptions and patterns (e.g., doc_id example, index_id pattern). The description adds no additional parameter-specific details, so it earns the baseline 3 for high schema coverage.

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 clearly states the action ('Explain why a specific document ranked for a query') and specifies the output (per-term relevance breakdown, overall match summary). This distinguishes it from sibling tools like search, fetch, or browse, which have different purposes.

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?

The description gives clear context on when to use the tool (to understand document ranking for a query), but it does not explicitly mention alternatives or exclusions. For instance, it doesn't compare with search or browse, but the intent is obvious enough for an agent to choose it for explainability tasks.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All ColdState — Deterministic Knowledge Infrastructure tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?