Skip to main content
Glama

openspec_read_cross_service_doc

Reads a specific cross-service document using its change ID and document name. Use with the list tool to identify documents.

Instructions

Read a specific cross-service document content. Use openspec_list_cross_service_docs first to see available documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
changeIdYesChange ID
docNameYesDocument name (e.g., design.md, flows.md)
Behavior2/5

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It only states 'Read' with no details on side effects, permissions, error handling, or output behavior. This is insufficient for a tool with no annotation safety net.

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?

Two short, front-loaded sentences. The first defines purpose, the second provides a critical usage direction. 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?

The description covers purpose and usage steps but omits return value description (no output schema). For a simple read tool, it's adequate but not fully complete. Missing what the agent can expect as output.

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% with parameter descriptions, so baseline is 3. The description adds no additional meaning beyond the schema; it simply restates the purpose. No extra value for parameter understanding.

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 the action ('Read') and the resource ('cross-service document content'), and it distinguishes from siblings by specifying the resource type. The prerequisite direction to use the list tool first adds clarity.

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

Usage Guidelines5/5

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

Explicitly instructs the agent to use 'openspec_list_cross_service_docs first to see available documents', providing a clear precondition. This is a strong usage guideline for when to invoke this tool.

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/Lumiaqian/openspec-mcp'

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