Skip to main content
Glama
huiseo
by huiseo

get_document

Retrieve complete document content from Outline wiki using a document ID to access and work with specific wiki pages.

Instructions

Get full document content by document ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • The core handler function for the 'get_document' tool. It calls the Outline API to fetch document details by ID and formats the response with a URL using formatDocumentInfo.
    async get_document(args: GetDocumentInput) {
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument>('/documents.info', { id: args.documentId })
      );
      return formatDocumentInfo(data, baseUrl);
    },
  • Zod schema definition for the 'get_document' tool input, requiring a documentId string.
    export const getDocumentSchema = z.object({ documentId });
  • src/lib/tools.ts:64-67 (registration)
    Registration of the 'get_document' tool in the allTools array, linking the name, description, and schema for MCP tool definition.
      'get_document',
      'Get full document content by document ID.',
      'get_document'
    ),
  • Maps the 'get_document' tool name to its schema in the toolSchemas record used by tool definitions.
    get_document: getDocumentSchema,
Behavior2/5

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

With no annotations, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits such as permissions needed, rate limits, response format (e.g., text, HTML), or error handling. This is inadequate for a tool with potential complexity in document retrieval.

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, efficient sentence with zero waste. It's front-loaded with the core action and resource, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and low schema coverage, the description is incomplete. It doesn't cover return values (e.g., document structure, metadata), error cases, or usage nuances, leaving significant gaps for a tool that interacts with document content.

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?

Schema description coverage is 0%, so the description must compensate. It adds meaning by explaining that 'documentId' is used to get content, but doesn't specify format (e.g., UUID, numeric) or constraints beyond the schema's minLength. This provides some context but leaves gaps.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Get') and resource ('full document content'), specifying retrieval by document ID. It distinguishes from siblings like 'get_document_backlinks' or 'get_document_id_from_title' by focusing on content, but doesn't explicitly contrast with 'export_document' or 'summarize_document'.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like 'export_document' (which might output files) or 'summarize_document' (which provides summaries). The description implies usage for retrieving content, but lacks explicit context or exclusions.

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

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