Outline Wiki MCP Server

Instructions

Implementation Reference

• src/lib/handlers/comments.ts:23-42 (handler)

  The core handler function for the 'add_comment' tool. It performs access checks, constructs the API payload, calls the Outline API to create a comment, and returns a formatted response including the comment ID, document ID, creation time, author, and success message.

  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,
    };
  },

• src/lib/schemas.ts:75-79 (schema)

  Zod schema defining the input validation for the add_comment tool: requires documentId and text, optionally parentCommentId for replies.

  export const addCommentSchema = z.object({
    documentId,
    text: z.string().min(1, 'Comment text is required'),
    parentCommentId: z.string().uuid().optional(),
  });

• src/lib/tools.ts:125-128 (registration)

  Tool registration in the allTools array, specifying name, description, and schema key for MCP tool definition conversion from Zod to JSON schema.

    'add_comment',
    'Add a comment to a document. Supports replies.',
    'add_comment'
  ),

• src/lib/handlers/index.ts:19-27 (registration)

  Aggregates all handlers, including comment handlers containing 'add_comment', into the main ToolHandlers object for the MCP server.

  export function createAllHandlers(ctx: AppContext): ToolHandlers {
    return {
      ...createSearchHandlers(ctx),
      ...createDocumentHandlers(ctx),
      ...createCollectionHandlers(ctx),
      ...createCommentHandlers(ctx),
      ...createBatchHandlers(ctx),
      ...createSmartHandlers(ctx),
    } as ToolHandlers;

• src/lib/access-control.ts:12-29 (helper)

  Access control helper listing 'add_comment' as a write operation tool, used by checkAccess in the handler to enforce read-only mode restrictions.

  const WRITE_TOOLS = new Set([
    'create_document',
    'update_document',
    'move_document',
    'archive_document',
    'unarchive_document',
    'delete_document',
    'restore_document',
    'add_comment',
    'create_collection',
    'update_collection',
    'delete_collection',
    'batch_create_documents',
    'batch_update_documents',
    'batch_move_documents',
    'batch_archive_documents',
    'batch_delete_documents',
  ]);