Skip to main content
Glama
AustinAbhari

mcp-wiki-server

by AustinAbhari

read_doc

Retrieve the complete contents of a markdown document by its relative path, providing the full text needed for detailed review or processing.

Instructions

Read the full contents of a specific markdown doc by its relative path (as returned by search_docs).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRelative path to the doc, e.g. 'guides/onboarding.md'
Install Server

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. 'Read the full contents' communicates that this is a read-only retrieval operation and that the entire document is returned, but it does not disclose behavior for invalid paths, permissions, or potential truncation. It adds some specificity needed beyond the name but leaves behavioral edge cases unaddressed.

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 sentence that is front-loaded with the key verb and resource, then scopes the input. No redundant words, no restating the tool name. Every element earns its place.

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 single- parameter tool with no output schema, the description sufficiently conveys what the agent gets back ('full contents') and indicates the input format comes from search_docs. It does not cover error cases or whether the doc must exist, but those are mitigagated by the implied search-first flow and the tool's simplicity.

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?

The schema already fully describes the 'path' parameter (relative path, example), and the description reiterates it. Schema description coverage is 100%, so no additional param insight is required; the description adds marginal contextual value by tying the path to search_docs results.

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 uses a specific verb ('Read') and resource ('specific markdown doc') and specifies the input ('relative path'). It clearly distinguishes itself from the sibling 'search_docs' by stating the path comes from that tool, so the agent knows this is the retrieval step, not the search step.

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 phrase 'as returned by search_docs' implies the workflow: search first, then read by path. This gives context for when to use this tool, though it does not explicitly state 'use this instead of search_docs when you already have a path' or provide exclusion conditions.

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

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/AustinAbhari/mcp-wiki'

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