Skip to main content
Glama

HeroX AirDomes Docs

Read a document

read_doc
Read-only

Return the full Markdown text of a HeroX AirDomes reference document by ID from list_docs.

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": {
      "id": "<id>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument ID from list_docs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare this a read-only, non-open-world operation, so the safety profile is covered. The description does add value by disclosing the return format ('full Markdown text', i.e. untruncated body rather than metadata), but it says nothing about failure behavior for a bad ID or any size/pagination considerations. Moderate addition over annotations.

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?

One sentence, front-loaded with the action and the output format, with zero filler. Nothing is padded or redundant.

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 single-parameter read tool with no output schema, the description covers what it does, where the ID comes from, and what comes back. The only omission is how it behaves on an invalid or unknown ID, a minor gap given the enum constrains the input.

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% and the enum is fully documented, including the note that the ID comes from list_docs. The description's 'by ID from list_docs' duplicates rather than extends that, adding no new meaning about the three allowed values. Baseline 3 applies.

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?

States a specific verb ('Return'), specific resource ('HeroX AirDomes reference document'), and the exact output form ('full Markdown text'), keyed by ID. An agent can distinguish this from list_docs, search_docs, and read_blog_post without opening any schema.

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?

'by ID from list_docs' establishes the prerequisite that the identifier comes from list_docs, which is real usage context rather than a bare restatement. It stops short of explicitly excluding search_docs as a discovery path or stating what happens with an unknown ID, so it is clear but not fully routing-aware.

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