Skip to main content
Glama

List design docs

design_docs_list
Read-onlyIdempotent

List planned/implemented/rejected design docs, optionally filtered by version. state = "planned" | "implemented" | "rejected" | ""; empty = all.

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": {
      "state": "<state>",
      "version": "<version>"
    },
    "name": "design_docs_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
stateYes
versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world behavior, so the safety profile is fully covered and the description only needs to add context. It adds the important detail that an empty state means 'all', but says nothing about result shape, ordering, or size, and its 'optionally filtered by version' wording contradicts the schema's required list.

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 core action and immediately followed by the state enumeration; no filler. The only cost is the misleading 'optionally filtered' clause, which spends words on a claim the schema contradicts.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With annotations covering safety, the remaining burden is the two required parameters and the missing output schema, and the description half-addresses that by defining state values. It leaves the version parameter's format and the returned fields/ordering unexplained, so an agent can call it but cannot predict the response shape.

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 0%, so the description must carry parameter meaning, and it does enumerate the four legal 'state' values (including empty = all), which the bare string schema lacks. However, it gives no format for 'version' (exact string, prefix, latest?) and describes it as optional when the schema requires it, leaving an agent unsure what to pass.

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 gives a specific verb ('List') and resource ('planned/implemented/rejected design docs') plus a filtering dimension, so an agent knows exactly what the call returns conceptually. It does not name or rule out the singular sibling 'design_doc' or 'docs_search', leaving the boundary to be inferred from the names alone.

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 implied: use it to enumerate docs, pass an empty state for all, and narrow by version. There is no explicit when-to-use versus when-not guidance (e.g., versus fetching a single doc with 'design_doc' or searching with 'docs_search'), and the claim that version is an optional filter conflicts with the schema marking it required.

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.