list_document_comments
Retrieve comments on a specific Outline wiki document to review feedback, discussions, or annotations. Specify the document ID to access the comment list.
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 main handler function that lists comments for a document by calling the Outline API '/comments.list' endpoint with documentId, limit, and offset, then formats the results 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 defining the input parameters for the list_document_comments tool: documentId (required), limit (default 25), 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, creating the MCP tool definition from the schema with name 'list_document_comments' and description.
createTool( 'list_document_comments', 'Get list of comments on a document.', 'list_document_comments' ),