Skip to main content
Glama

Read a doc

read_doc

Retrieve full knowledge documents by concept ID from an AI-native software development wiki. Supports English and Korean languages.

Instructions

Read one knowledge doc in full by concept id (as returned by search_knowledge or list_topics). English is canonical; pass lang: 'ko' for the Korean version when available.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesConcept id, e.g. 'ai-native/context-compaction'
langNoLanguage (default en)
Behavior3/5

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

With no annotations, the description must fully disclose behavior. It states it reads the full doc and mentions language availability, but does not cover potential issues like doc size limits, authentication needs, or response format.

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 concise sentences: the first conveys the core purpose, the second adds crucial language guidance. 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 is adequate for a simple read tool, but lacks details on return format (e.g., JSON structure) and error handling (e.g., missing ID). Given no output schema, these omissions reduce completeness.

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%, but the description adds value by explaining the 'id' originates from sibling tools and that 'lang' defaults to 'en' with Korean variant available. This enriches the parametric understanding 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 the tool reads a full knowledge doc by concept id, specifying the verb 'read' and resource 'knowledge doc'. It distinguishes from siblings by indicating the source of the ID (list_topics, search_knowledge).

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 context for when to use the tool: when you have a concept id from search_knowledge or list_topics. It also gives guidance on language parameter use. However, it lacks explicit exclusions or when-not-to-use conditions.

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/endmoseung/sociableWiki'

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