Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

get_comment

Retrieve specific comment details from Outline wiki by providing the comment ID for document management and collaboration.

Instructions

Get details of a specific comment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commentIdYes

Implementation Reference

  • The core handler function for the 'get_comment' tool that fetches and formats comment details from the Outline API.
    async get_comment(args: GetCommentInput) {
      const { data } = await apiCall(() =>
        apiClient.post<OutlineComment>('/comments.info', { id: args.commentId })
      );
      return {
        id: data.id,
        documentId: data.documentId,
        data: data.data,
        createdAt: data.createdAt,
        createdBy: data.createdBy?.name,
        parentCommentId: data.parentCommentId,
      };
    },
  • Zod input schema for 'get_comment' tool, requiring a valid UUID commentId.
    export const getCommentSchema = z.object({
      commentId: z.string().uuid('Invalid comment ID'),
    });
  • Registers 'get_comment' as an MCP tool with description and schema reference.
    createTool(
      'get_comment',
      'Get details of a specific comment.',
      'get_comment'
    ),
  • Aggregates comment handlers, including 'get_comment', into the main handlers object.
    ...createCommentHandlers(ctx),
  • Maps 'get_comment' to its schema in the central toolSchemas object.
    get_comment: getCommentSchema,
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It states it 'gets details' but doesn't specify what details are returned, error conditions, permissions required, or rate limits. This is inadequate for a tool with zero annotation coverage.

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 no wasted words. It's front-loaded with the core action, 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 explain return values, error handling, or behavioral traits, which are critical for a tool that retrieves data. This leaves significant gaps for an AI agent.

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 schema has 0% description coverage, but the description mentions 'a specific comment', implying the 'commentId' parameter identifies the comment. However, it doesn't add details like format hints (UUID) or where to obtain the ID, so it only partially compensates for the schema gap.

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 ('details of a specific comment'), making the purpose unambiguous. However, it doesn't differentiate from sibling tools like 'list_document_comments' which might retrieve multiple comments, so it lacks explicit sibling distinction.

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. It doesn't mention prerequisites (e.g., needing a comment ID), exclusions, or how it differs from related tools like 'list_document_comments', leaving usage context implied at best.

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