list_document_comments
Retrieve comments on a specific Outline wiki document to review feedback and discussions.
Instructions
Get list of comments on a document.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | ||
| limit | No | ||
| offset | No |
Implementation Reference
- src/lib/handlers/comments.ts:44-53 (handler)The handler function that executes the list_document_comments tool. It calls the Outline API endpoint '/comments.list' with documentId, limit, and offset parameters, then formats the returned comments using formatComments.
async list_document_comments(args: ListDocumentCommentsInput) { const { data } = await apiCall(() => apiClient.post<OutlineComment[]>('/comments.list', { documentId: args.documentId, limit: args.limit, offset: args.offset, }) ); return formatComments(data || []); }, - src/lib/schemas.ts:81-85 (schema)Zod schema for ListDocumentCommentsInput, defining required documentId, optional limit (default 25, max 100), and offset (default 0).
export const listDocumentCommentsSchema = z.object({ documentId, limit: limit.default(25), offset, }); - src/lib/tools.ts:129-133 (registration)Tool registration in the allTools array using createTool, which converts the Zod schema to JSON schema and sets the tool name and description for MCP protocol.
createTool( 'list_document_comments', 'Get list of comments on a document.', 'list_document_comments' ),