Skip to main content
Glama
dchavezp

design-os-migration-mcp

by dchavezp

read_target_docs

Read documentation files from the target project to guide migration. Lists all available docs or returns a specific file's content.

Instructions

Read documentation files from the target project. Without a path, lists all available doc files. With a path, returns that file's content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoRelative path to a specific doc file. If omitted, lists all available documentation files.
targetPathYesPath to the target project root directory
Behavior3/5

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

With no annotations provided, the description carries full burden. It correctly states it reads files (a read-only operation), but does not describe potential errors, return format, or side effects. Basic transparency is present but lacks depth.

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?

The description is two sentences, front-loaded with the core purpose, and every sentence adds necessary information. No wasted words.

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?

Given the lack of output schema and the presence of similar sibling tools, the description could provide more detail on return format (e.g., list vs array, file content as string) and error handling. It covers the basic functionality but leaves room for ambiguity.

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 100%, so the schema already documents both parameters. The description adds value for the 'path' parameter by explaining its behavior when omitted, but does not mention 'targetPath' at all. Overall, the description adds some but not substantial extra meaning beyond the schema.

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?

The description clearly states it reads documentation files from the target project, with two distinct modes: listing all files when path is omitted, and returning file content when path is provided. This makes the purpose specific and distinguishable from sibling tools like read_component or read_export_file.

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

Usage Guidelines4/5

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

The description provides clear conditions for using the tool: without a path it lists files, with a path it returns content. This gives implicit guidance on when to use it, though it does not explicitly exclude alternatives or mention when not to use.

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/dchavezp/design-os-migrator-mcp'

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