Skip to main content
Glama

Read a DevPlane documentation topic

get_doc
Read-only

Read one public documentation topic by slug. Availability labels are part of the content.

Input Schema

NameRequiredDescriptionDefault
slugYes

Output Schema

NameRequiredDescriptionDefault
docYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds two useful behavioural facts beyond that: only public topics are returned, and availability labels are embedded in the content. It says nothing about unknown-slug behaviour or whether content may be truncated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short, front-loaded sentences with no filler, and the core action comes first. The second sentence is terse to the point of being cryptic but does carry real information about the payload.

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 tool with an output schema, the description needn't explain return values, and the annotations cover safety. The only real gap is that obtaining the required slug is never addressed, which is minor given the tool's simplicity.

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 0% and the single parameter is documented only as a bare string. The description partially compensates by identifying it as a slug, but gives no format, casing, or lookup hints for the identifier.

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 ("Read one public documentation topic by slug"), and the word "one" implicitly contrasts with the sibling list_docs/list_pages style tools that enumerate many. It stops short of naming a sibling outright, so it is clear but not fully differentiated.

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 only implied: an agent can infer this is the tool to call when it already has a slug. The description never says how to obtain a slug (e.g. via list_docs) or what to do when the caller has only a topic name, so the when-to-use guidance is left to inference.

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