Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

add_comment

Add comments or replies to Outline wiki documents to facilitate discussion and collaboration on content.

Instructions

Add a comment to a document. Supports replies.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes
textYes
parentCommentIdNo

Implementation Reference

  • The main handler function for the 'add_comment' tool, which creates a comment on a document via the Outline API.
    async add_comment(args: AddCommentInput) {
      checkAccess(config, 'add_comment');
    
      const payload: Record<string, unknown> = {
        documentId: args.documentId,
        data: { text: args.text },
      };
      if (args.parentCommentId) payload.parentCommentId = args.parentCommentId;
    
      const { data } = await apiCall(() =>
        apiClient.post<OutlineComment>('/comments.create', payload)
      );
      return {
        id: data.id,
        documentId: data.documentId,
        createdAt: data.createdAt,
        createdBy: data.createdBy?.name,
        message: MESSAGES.COMMENT_ADDED,
      };
    },
  • Zod schema definition for 'add_comment' input parameters: documentId, text, and optional parentCommentId.
    export const addCommentSchema = z.object({
      documentId,
      text: z.string().min(1, 'Comment text is required'),
      parentCommentId: z.string().uuid().optional(),
    });
  • Registration of the 'add_comment' tool in the allTools array, linking name, description, and schema.
    createTool(
      'add_comment',
      'Add a comment to a document. Supports replies.',
      'add_comment'
    ),
  • Aggregates all handlers, including comment handlers containing 'add_comment', into the main ToolHandlers object.
    export function createAllHandlers(ctx: AppContext): ToolHandlers {
      return {
        ...createSearchHandlers(ctx),
        ...createDocumentHandlers(ctx),
        ...createCollectionHandlers(ctx),
        ...createCommentHandlers(ctx),
        ...createBatchHandlers(ctx),
        ...createSmartHandlers(ctx),
      } as ToolHandlers;
    }
  • Mapping of 'add_comment' to its schema in the toolSchemas record.
    add_comment: addCommentSchema,

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