Skip to main content
Glama

outline_get_document

Retrieve a specific document from Outline by its unique ID to access content for reading, editing, or reference.

Instructions

Get a specific document from Outline by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the document to retrieve

Implementation Reference

  • The handler for 'outline_get_document' in the MCP server, which calls the OutlineClient.getDocument method.
    case 'outline_get_document':
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(
              await this.outlineClient.getDocument(args.id as string),
              null,
              2
            ),
          },
        ],
      };
  • The actual implementation of the getDocument method that performs the API request to Outline.
    async getDocument(id: string): Promise<Document> {
      // Try different possible endpoints
      const endpoints = ['/api/documents.info', '/api/documents/info', '/api/document/info'];
    
      for (const endpoint of endpoints) {
        try {
          console.error(`Trying get document endpoint: ${this.api.defaults.baseURL}${endpoint}`);
          const response = await this.api.post(endpoint, { id });
    
          // Debug: log the actual response structure
          console.error('Get document raw response:', JSON.stringify(response.data, null, 2));
    
          const data = response.data.data || response.data;
    
          // Temporarily bypass schema validation and return raw data
          console.error('Returning raw document data:', JSON.stringify(data, null, 2));
          return data as Document;
        } catch (error: any) {
          console.error(`Get document endpoint ${endpoint} failed:`, error.response?.status, error.response?.statusText);
          if (error.response?.status === 404 && endpoint !== endpoints[endpoints.length - 1]) {
            console.error(`Endpoint ${endpoint} not found, trying next...`);
            continue;
          }
          throw error;
        }
      }
      throw new Error('No valid endpoint found for getting document');
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. While 'Get' implies a read operation, the description fails to specify error behavior (e.g., what happens if the ID doesn't exist), whether this operation is idempotent, or any authentication/authorization requirements.

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 optimally concise at 7 words. It front-loads the verb ('Get'), avoids redundancy with the schema, and contains no filler or tangential information. Every word serves to clarify the tool's scope.

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

Completeness3/5

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

Given the low complexity (single required parameter, no nested objects, 100% schema coverage), the description is minimally adequate. However, it lacks mention of error cases (404 behavior) and given the absence of an output schema, could benefit from a brief note about the return structure to aid agent decision-making among the multiple document retrieval options.

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 has 100% description coverage ('The ID of the document to retrieve'), establishing a baseline of 3. The description adds minimal semantic value beyond the schema—merely appending 'by ID'—without clarifying ID format (UUID, slug, etc.) or providing usage examples.

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 identifies the action ('Get'), resource ('document from Outline'), and lookup method ('by ID'). However, it does not explicitly differentiate from sibling tools like outline_search_documents or outline_list_documents, which also retrieve documents but through different mechanisms.

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 does not indicate that this tool requires an exact ID (as opposed to searching), nor does it mention prerequisites like needing the document ID beforehand or what to do if the ID is unknown.

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/HelicopterHelicopter/outline-mcp-server'

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