Skip to main content
Glama
runit-xze
by runit-xze

Document info and page overview

get_document_info

Retrieve document metadata and a page-by-page overview with first lines, providing a table of contents for locating and reading specific pages.

Instructions

Return metadata for one document plus a page-by-page overview (first line of each page), useful as a table of contents before reading specific pages.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYesDocument id, e.g. 4.2bsd-system-manual
Behavior4/5

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

With no annotations provided, the description carries the burden of disclosure. It specifies that the tool returns metadata plus a page-by-page overview (first line of each page), which accurately conveys the behavior and implies a read-only operation. It does not detail what metadata fields are included, but for a simple read tool this is reasonably 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 a single, well-structured sentence that front-loads the action ('Return metadata'), specifies the resource and output format, and ends with a practical use case. Every part earns its place with no 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 the low complexity (one parameter, no output schema), the description provides sufficient context about what the tool returns and when to use it. It could specify metadata fields or output structure in more detail, but for selection and invocation the current description is complete enough.

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 input schema fully documents the single parameter doc_id, including an enum of allowed values and an example description. Since schema description coverage is 100%, the description adds no additional parameter semantics, and the baseline score of 3 applies.

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 returns metadata for one document plus a page-by-page overview consisting of the first line of each page. This distinguishes it from siblings like list_documents (listing) and read_pages (reading full content) by highlighting its role as a table-of-contents summary.

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 explicitly frames the tool as useful as a table of contents before reading specific pages, giving a clear when-to-use context. It does not name alternative tools or explicitly state when not to use it, but the use case is sufficiently implied relative to siblings like read_pages.

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/runit-xze/unix-docs-mcp'

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