Skip to main content
Glama

Read an Amomic documentation page

read_doc
Read-onlyIdempotent

Read one complete documentation page as clean Markdown after finding it with search_docs.

Input Schema

NameRequiredDescriptionDefault
pathYesDocumentation path or docs.amomic.in URL, such as /api/messages

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, and closed-world behavior, so safety is covered. The description adds value by disclosing the return shape ('one complete documentation page as clean Markdown'), which is not in any structured field. It does not mention truncation or error behavior for invalid paths, hence not a 5.

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 sentence that front-loads the action and output format, with the prerequisite workflow clause appended. No redundant or filler wording.

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 tool with fully documented schema and rich annotations, the description covers purpose, output format, and prerequisite step. Minor gaps around failure modes or very large pages are not material enough to drop below 4.

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?

Only one parameter and schema description coverage is 100%, with the schema already explaining that the path accepts either a docs.amomic.in URL or a path like /api/messages. The description adds no further constraint or format guidance beyond that baseline.

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 and resource ('Read one complete documentation page') plus the return format ('clean Markdown'), and explicitly positions the tool relative to the sibling search_docs ('after finding it with search_docs'). An agent can distinguish this from search_docs and search_api 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?

Gives a clear workflow condition: use this after locating a page via search_docs, which implies it is not a discovery tool. It stops short of stating what to do when the path is unknown or when to prefer search_api, so it is clear but not exhaustive.

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