Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

summarize_document

Generate AI-powered summaries of Outline wiki documents to quickly understand content without reading entire files.

Instructions

Generate an AI-powered summary of a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes
languageNo

Implementation Reference

  • The main execution handler for the 'summarize_document' tool. Fetches the full document content via Outline API, checks for content, and delegates summarization to the brain module.
    async summarize_document(args: { documentId: string; language?: string }) {
      if (!brain.isEnabled()) {
        return { error: ERROR_MESSAGES.SMART_FEATURES_DISABLED };
      }
    
      // Fetch document
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument>('/documents.info', { id: args.documentId })
      );
    
      if (!data.text) {
        return { error: ERROR_MESSAGES.NO_CONTENT_TO_SUMMARIZE };
      }
    
      const summary = await brain.summarize(data.text, args.language);
    
      return {
        documentId: data.id,
        title: data.title,
        summary,
      };
    },
  • Zod input schema definition for the tool, validating required 'documentId' and optional 'language' parameters.
    export const summarizeDocumentSchema = z.object({
      documentId,
      language: z.string().optional(),
    });
  • Registration of the 'summarize_document' tool in the allTools array, converting the Zod schema to JSON Schema for MCP tool definition.
    createTool(
      'summarize_document',
      'Generate an AI-powered summary of a document.',
      'summarize_document'
    ),
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It mentions 'AI-powered' which hints at non-deterministic output, but doesn't address critical aspects like rate limits, authentication needs, output format, or whether this is a read-only operation. For a tool with no annotation coverage, this leaves significant gaps.

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 extremely concise at just one sentence with zero wasted words. It's front-loaded with the core purpose and efficiently communicates the essential function without unnecessary elaboration.

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 complexity of AI-powered summarization, no annotations, no output schema, and 0% parameter documentation, the description is inadequate. It doesn't explain what kind of summary to expect, length considerations, quality limitations, or how the AI aspect affects results. The minimal description doesn't provide enough context for effective tool use.

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

Parameters2/5

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

With 0% schema description coverage and 2 parameters (documentId and language), the description provides no information about parameter meanings or usage. It doesn't explain what documentId refers to, what format it should be in, or what the optional language parameter controls. The description fails to compensate for the complete lack of schema documentation.

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 action ('Generate an AI-powered summary') and the resource ('of a document'), making the purpose immediately understandable. However, it doesn't differentiate from potential sibling tools like 'get_document' or 'smart_status' that might also provide document insights, so it doesn't reach the highest score.

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. With many sibling tools available (like 'get_document' for full content or 'smart_status' for analysis), there's no indication of when summarization is preferred over other document operations.

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