Skip to main content
Glama

Read a documentation topic

get_doc
Read-only

One documentation topic as markdown: the booking API contract, checkout, widgets, attribution, live chat, the customer portal, or the per-account booking MCP server.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoThe operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it.
topicYesA topic from list_docs

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds useful context about the return format ('as markdown') and the scope of topics, but it does not disclose error behavior, host handling, or content size expectations. This is reasonable value beyond annotations but not rich.

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 a single, front-loaded sentence that communicates the action, output format, and topic coverage without wasted words. It is appropriately sized for the tool's simplicity.

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 simple read-only documentation fetcher with good annotations and complete schema coverage, the description supplies the needed output format and topic list. It is slightly light on failure/edge-case behavior, but overall it is complete enough for the tool's low complexity.

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 description coverage is 100%: both 'host' and 'topic' are described in the input schema, including the full enum. The description adds no parameter-specific meaning beyond the schema, so the baseline score of 3 applies.

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 clearly states the tool returns 'one documentation topic as markdown' and enumerates the available doc areas, making the resource and action specific. It does not explicitly contrast itself with sibling tools like get_integration_brief or get_widget_snippets, which keeps it from a 5.

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?

The description implies this is the tool to use when you need a single known documentation topic, but it does not explicitly say when to use it instead of list_docs, search_docs, or get_widget_snippets. The 'topic from list_docs' hint exists in the schema, but the description itself provides no workflow or exclusion 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.

TDQS

A4.2/5.0
Disambiguation5/5

Each tool clearly serves a distinct purpose: listing topics, searching docs, retrieving a topic, getting an integration brief, and fetching widget code snippets. There is no overlap; an agent can easily choose the right tool.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern: list_docs, search_docs, get_doc, get_integration_brief, get_widget_snippets. The verbs (list, search, get) are standard and predictable.

Tool Count5/5

Five tools is ideal for a documentation server, covering discovery (list, search) and retrieval (get) without excess. Each tool earns its place and the set is well-scoped.

Completeness5/5

The tool surface fully covers the domain: you can discover available topics, search across content, retrieve individual topics, and get specialized artifacts (briefs and snippets). There are no dead ends or missing necessary operations.