Skip to main content
Glama

guide

List available project guides or read a specific guide topic to access documentation and context for task sessions.

Instructions

Access project guide documents. (list/read)

  • list: Show available guides (excludes _-prefixed required guides).

  • read: Read a specific guide by topic name.

Required guides (_plan.md, _session_*.md, etc.) are auto-loaded by corresponding tools. Regular guides: When a guide name matches the current task context, proactively read it without waiting for the user to ask.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoGuide name to read (without .md extension)
actionNolist: show available guides, read: read a specific guidelist
sessionNoSession name to resolve service binding. Auto-detects if only one active session exists
Behavior4/5

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

With no annotations, the description discloses core behavior: listing excludes _-prefixed guides, reading by topic, and auto-detection of session. It lacks details on error handling or resource usage, but is still informative.

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 well-structured with bullet points and clear sections. It is concise yet packs essential information without verbosity.

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?

Given no output schema, the description explains list and read behavior but does not specify list output format or error handling. Still, it covers the main functionality adequately.

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

Parameters4/5

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

Schema coverage is 100%, so baseline 3. The description adds meaning: topic is without .md, action defaults to list, session auto-detects. This goes beyond the schema, earning a 4.

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 tool accesses project guide documents, with explicit sub-actions list and read. It distinguishes itself from sibling tools (init, plan, etc.) by focusing on guide access.

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 guidance on when to use list versus read, and mentions proactive reading for context-matching guides. However, it does not explicitly state when not to use the tool or alternative tools.

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/g-hyeong/MCP-AidFlow'

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