Skip to main content
Glama

read_design_md

Read-only

Parse a DESIGN.md file to retrieve its frontmatter, Markdown body, and token index, enabling design knowledge queries.

Instructions

Parse a DESIGN.md file and return its frontmatter, Markdown body, and flattened token index.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to DESIGN.md
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is clear. The description adds value by specifying the exact outputs (frontmatter, body, token index), which goes beyond the annotations. No contradictory or missing behavioral context.

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?

A single concise sentence that front-loads the verb and resource. Every phrase serves a purpose with no redundant information.

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 operation with one parameter and no output schema, the description adequately covers what the tool does and returns. It omits error handling or edge cases, but the scope is narrow enough that missing details are not critical.

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% for the single required parameter 'path' with description 'Path to DESIGN.md'. The tool description does not add additional semantic meaning beyond what the schema already provides, so a baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it parses a DESIGN.md file and returns specific components (frontmatter, body, token index). The verb 'Parse' and resource 'DESIGN.md' are precise, and it distinguishes from sibling tools by focusing on a specific file type.

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?

No explicit guidance on when to use versus alternatives. While the name implies it's for reading DESIGN.md files, there is no mention of when not to use it or which sibling tool might be more appropriate for similar tasks.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/rhinocap/raven-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server