Skip to main content
Glama

List DevPlane documentation

list_docs
Read-only

Read public documentation, including each topic's reference, private-pilot or planned status. This does not execute workflows.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
docsYes
countYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

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, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds useful scope context (results include pilot/planned status) and removes ambiguity about workflow execution, but says nothing about result volume, ordering, or pagination beyond what the output schema carries.

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 sentences, front-loaded with the action and followed by the clarifying exclusion. No filler, though "including each topic's reference" is slightly awkward phrasing for what is really the returned fields.

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?

With an output schema present and zero parameters, the description need only establish purpose, scope and the no-execution caveat, which it does. The single remaining gap is routing against siblings get_doc, list_pages and list_faqs.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so there is no parameter meaning for the description to supply; baseline 4 applies. The description wisely spends its words on scope instead of restating the empty schema.

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?

"Read public documentation" names a concrete verb and resource, and the second clause enumerates what each entry carries (reference, private-pilot or planned status). It does not, however, contrast itself with the close sibling get_doc or with list_pages/list_faqs, so an agent must infer that this is the broad index rather than a single-document fetch.

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?

"This does not execute workflows" is a genuine when-not exclusion that prevents a likely misuse. Usage is only implied for the positive case — nothing says to call this first to discover topics before calling get_doc, and no sibling is named as an alternative for pages or FAQs.

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