Skip to main content
Glama
BitFigther

local-docs-mcp

by BitFigther

read_document

Read a document's text content in Markdown format, with parameters to control starting position and maximum characters for large documents.

Instructions

ドキュメントの本文をテキスト(Markdown)として読み出す。

Args:
    path: search_documents / list_documents が返した相対パス。
    offset: 読み出し開始位置(文字数)。大きい文書の続きを読むときに使う。
    max_chars: 一度に返す最大文字数。

Returns:
    本文テキストと、全体の文字数・続きがあるかどうか。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
offsetNo
max_charsNo
Behavior3/5

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

With no annotations provided, the description adequately discloses that the tool is a read operation returning text, total length, and continuation status. However, it does not mention prerequisites like permissions, error handling, or whether the operation is idempotent. The behavior is implied but not fully transparent.

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 concise and well-structured. It leads with the purpose, followed by argument details, and ends with the return value description. Every sentence provides essential information without redundancy.

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 return values (body text, total length, continuation flag). It covers the main use case adequately. Minor gaps: no mention of handling invalid paths or error scenarios, but the description is sufficient for a simple read tool with good context signals.

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

Parameters5/5

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

The description adds significant meaning beyond the input schema, which has 0% coverage. It explains that 'path' comes from search/list documents, 'offset' is for continuation reading, and 'max_chars' controls response size. This fully compensates for the schema's lack of descriptions.

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 resource (document body as Markdown). It effectively differentiates from sibling tools list_documents and search_documents by specifying what this tool does (read content) as opposed to listing or searching.

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

Usage Guidelines3/5

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

The description explains how to use arguments (path from search/list, offset for continuation, max_chars) but does not explicitly state when to use this tool versus alternatives or provide exclusion conditions. The guidance is implicit through the context of sibling 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/BitFigther/local-docs-mcp'

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