Skip to main content
Glama

design_read

Read-onlyIdempotent

Read a project's DESIGN.md file to inspect design documentation and understand design decisions without changing project files.

Instructions

Read a project's DESIGN.md without modifying it.

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": {
      "project_path": "<project_path>"
    },
    "name": "design_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered without the description. The description's only addition, 'without modifying it,' duplicates that annotation rather than adding new behavior like missing-file handling or path resolution rules.

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?

One short, front-loaded sentence with zero filler. It is arguably too terse, omitting necessary path semantics, but no sentence is wasted.

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?

For a simple single-parameter read, the annotations plus the stated resource make the operation largely predictable, and the absence of an output schema is acceptable since the return is presumably file text. However, the undefined project_path format is a real gap that keeps it from being fully callable without trial and error.

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

Parameters2/5

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

Schema description coverage is 0% for the single parameter: project_path is typed as a non-empty string with no explanation of whether it is an absolute path, a project root, or a relative directory containing DESIGN.md. The description does not compensate, leaving the agent to guess the expected path form.

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 ('Read') and a specific resource ('a project's DESIGN.md'), which distinguishes it from the generic read_file sibling by naming the exact artifact. It stops short of explicitly contrasting itself with read_file or design_audit, but the scope is clear enough to select on.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this instead of read_file, design_audit, or design_library_read, and no preconditions such as whether DESIGN.md must exist or be initialized first. The only contextual clue, 'without modifying it,' merely restates read-only semantics rather than routing the agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.