Teamwork MCP

Instructions

Implementation Reference

• src/tools/tasks/getTaskComments.ts:64-96 (handler)

  The handler function that executes the 'getTaskComments' tool logic. Processes input, calls the teamwork service, formats response or error.

  export async function handleGetTaskComments(input: any) {
    logger.info('Calling teamworkService.getTaskComments()');
    logger.info(`Task ID: ${input?.taskId}`);
    
    try {
      const taskId = String(input?.taskId);
      if (!taskId) {
        throw new Error("Task ID is required");
      }
      
      // Extract optional parameters
      const options: Record<string, any> = {};
      
      if (input.page) options.page = input.page;
      if (input.pageSize) options.pageSize = input.pageSize;
      if (input.orderBy) options.orderBy = input.orderBy;
      if (input.orderMode) options.orderMode = input.orderMode;
      if (input.searchTerm) options.searchTerm = input.searchTerm;
      if (input.updatedAfter) options.updatedAfter = input.updatedAfter;
      if (input.commentStatus) options.commentStatus = input.commentStatus;
      
      const comments = await teamworkService.getTaskComments(taskId, options);
      
      return {
        content: [{
          type: "text",
          text: JSON.stringify(comments, null, 2)
        }]
      };
    } catch (error: any) {
      return createErrorResponse(error, 'Retrieving task comments');
    }
  } 

• src/tools/tasks/getTaskComments.ts:11-61 (schema)

  Input schema, description, and annotations defining the 'getTaskComments' tool interface.

  export const getTaskCommentsDefinition = {
    name: "getTaskComments",
    description: "Get comments for a specific task from Teamwork",
    inputSchema: {
      type: "object",
      properties: {
        taskId: {
          type: "integer",
          description: "The ID of the task to retrieve comments for"
        },
        page: {
          type: "integer",
          description: "Page number for pagination"
        },
        pageSize: {
          type: "integer",
          description: "Number of items per page"
        },
        orderBy: {
          type: "string",
          description: "Order by field",
          enum: ["all", "date", "project", "user", "type"]
        },
        orderMode: {
          type: "string",
          description: "Order mode",
          enum: ["asc", "desc"]
        },
        searchTerm: {
          type: "string",
          description: "Filter by comment content"
        },
        updatedAfter: {
          type: "string",
          description: "Filter by updated after date (ISO 8601 format)"
        },
        commentStatus: {
          type: "string",
          description: "Filter by comment status",
          enum: ["all", "read", "unread"]
        }
      },
      required: ["taskId"]
    },
    annotations: {
      title: "Get Task Comments",
      readOnlyHint: false,
      destructiveHint: false,
      openWorldHint: false
    }
  };

• src/tools/index.ts:81-81 (registration)

  Registration of the 'getTaskComments' tool in the toolPairs array, linking definition and handler.

  { definition: getTaskComments, handler: handleGetTaskComments },

• src/services/tasks/getTaskComments.ts:10-19 (helper)

  Helper service function that performs the actual API request to fetch task comments from Teamwork.

  export const getTaskComments = async (taskId: string, options: any = {}) => {
    try {
      const api = ensureApiClient();
      const response = await api.get(`/tasks/${taskId}/comments.json`, { params: options });
      return response.data;
    } catch (error: any) {
      logger.error(`Error fetching comments for task ${taskId}: ${error.message}`);
      throw new Error(`Failed to fetch comments for task ${taskId}`);
    }
  };