Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Remote

get_document

Retrieve complete document content from Outline wiki using its unique document ID for viewing or processing.

Instructions

Get full document content by document ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • src/lib/handlers/documents.ts:42-47 (handler)
    The primary handler function for the 'get_document' tool. It calls the Outline API's '/documents.info' endpoint with the documentId to retrieve the document details and formats the output using formatDocumentInfo, including the base URL.
    async get_document(args: GetDocumentInput) {
  const { data } = await apiCall(() =>
    apiClient.post<OutlineDocument>('/documents.info', { id: args.documentId })
  );
  return formatDocumentInfo(data, baseUrl);
},
  • src/lib/schemas.ts:39-39 (schema)
    Zod input schema for the 'get_document' tool, requiring a single 'documentId' field (defined earlier as z.string().min(1)). This schema is used for input validation.
    export const getDocumentSchema = z.object({ documentId });
  • src/lib/tools.ts:64-68 (registration)
    Registers the 'get_document' tool in the allTools export array. Converts the Zod schema to JSON Schema for MCP compatibility and defines the tool's name and description.
      'get_document',
  'Get full document content by document ID.',
  'get_document'
),
createTool(

Tool Definition Quality

C2.9/5.0
Behavior2/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 of behavioral disclosure. It states the tool retrieves 'full document content' but doesn't specify format (e.g., plain text, HTML, JSON), size limits, error handling (e.g., for invalid IDs), authentication requirements, or rate limits. For a read operation with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.

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 that front-loads the core purpose ('Get full document content') and specifies the key constraint ('by document ID'). There is no wasted verbiage, repetition, or unnecessary elaboration, making it highly concise and well-structured for quick understanding.

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 the tool's simplicity (1 parameter, no output schema, no annotations), the description is incomplete. It lacks details on return values (e.g., content format, structure), error conditions, and behavioral aspects like permissions or limitations. While minimalism might suffice for basic use, the absence of annotations and output schema means the description should provide more context to be fully helpful.

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 description adds minimal semantic context beyond the input schema. It mentions 'document ID' as the parameter, aligning with the schema's 'documentId', but provides no details on ID format, sourcing (e.g., from 'get_document_id_from_title'), or validation rules. With 0% schema description coverage, the description doesn't compensate for the lack of schema documentation, but it at least clarifies the parameter's purpose.

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 retrieval rather than metadata or IDs. However, it doesn't explicitly differentiate from 'export_document' or 'summarize_document', which might also involve document content access.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a valid document ID), exclusions (e.g., not for archived documents), or comparisons to siblings like 'export_document' (for file output) or 'summarize_document' (for condensed content). Usage is implied only by the tool name and basic purpose.

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-smart-mcp'

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