Skip to main content
Glama
MustafaPatharia

ProofHub MCP Server

proofhub_get_comments

Retrieve all comments on a ProofHub task with their full text content.

Instructions

Fetch all comments on a ProofHub task, including their full text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes
list_idYes
task_idYes

Implementation Reference

  • Tool handler for proofhub_get_comments. Extracts project_id, list_id, task_id from args, calls apiGet to fetch comments from the ProofHub API endpoint, and returns the result as JSON.
    // ── proofhub_get_comments ────────────────────────────────────────────
    if (name === 'proofhub_get_comments') {
      const { project_id, list_id, task_id } = args;
      const comments = await apiGet(`/projects/${project_id}/todolists/${list_id}/tasks/${task_id}/comments`);
      return {
        content: [{
          type: 'text',
          text: JSON.stringify(comments, null, 2),
        }],
      };
    }
  • Input schema definition for proofhub_get_comments tool. Declares required string parameters: project_id, list_id, task_id.
    {
      name: 'proofhub_get_comments',
      description: 'Fetch all comments on a ProofHub task, including their full text.',
      inputSchema: {
        type: 'object',
        properties: {
          project_id: { type: 'string' },
          list_id:    { type: 'string' },
          task_id:    { type: 'string' },
        },
        required: ['project_id', 'list_id', 'task_id'],
      },
    },
  • index.js:102-187 (registration)
    Tool registration via ListToolsRequestSchema handler. The proofhub_get_comments definition is part of the tools array returned from this handler.
    server.setRequestHandler(ListToolsRequestSchema, async () => ({
      tools: [
        {
          name: 'proofhub_parse_url',
          description:
            'Parse a ProofHub task URL and return the project ID, list ID, and task ID embedded in it. ' +
            'Use this as the first step before calling other ProofHub tools.',
          inputSchema: {
            type: 'object',
            properties: {
              url: { type: 'string', description: 'Full ProofHub task URL, e.g. https://kpi.proofhub.com/bappswift/#app/todos/project-7189443252/list-270280503800/task-514774338823' },
            },
            required: ['url'],
          },
        },
        {
          name: 'proofhub_get_task',
          description: 'Fetch full task details (title, description, stage, custom fields, assignees) from ProofHub.',
          inputSchema: {
            type: 'object',
            properties: {
              project_id: { type: 'string' },
              list_id:    { type: 'string' },
              task_id:    { type: 'string' },
            },
            required: ['project_id', 'list_id', 'task_id'],
          },
        },
        {
          name: 'proofhub_get_comments',
          description: 'Fetch all comments on a ProofHub task, including their full text.',
          inputSchema: {
            type: 'object',
            properties: {
              project_id: { type: 'string' },
              list_id:    { type: 'string' },
              task_id:    { type: 'string' },
            },
            required: ['project_id', 'list_id', 'task_id'],
          },
        },
        {
          name: 'proofhub_get_task_with_bug_links',
          description:
            'One-shot tool: given a ProofHub task URL (or IDs), fetches the task description AND all comments, ' +
            'then extracts any bug-tracker links (Jira, Linear, GitHub Issues, GitLab, YouTrack, ClickUp, Asana, etc.) ' +
            'found in any of those texts. Returns the task data plus a deduplicated list of bug links.',
          inputSchema: {
            type: 'object',
            properties: {
              url:        { type: 'string', description: 'Full ProofHub task URL (preferred). If supplied, project_id/list_id/task_id are ignored.' },
              project_id: { type: 'string' },
              list_id:    { type: 'string' },
              task_id:    { type: 'string' },
            },
          },
        },
        {
          name: 'proofhub_create_comment',
          description: 'Post a new comment on a ProofHub task.',
          inputSchema: {
            type: 'object',
            properties: {
              project_id:  { type: 'string' },
              list_id:     { type: 'string' },
              task_id:     { type: 'string' },
              description: { type: 'string', description: 'Comment text (plain text or HTML).' },
            },
            required: ['project_id', 'list_id', 'task_id', 'description'],
          },
        },
        {
          name: 'proofhub_get_task_history',
          description: 'Fetch the activity history of a ProofHub task (stage changes, edits, etc.).',
          inputSchema: {
            type: 'object',
            properties: {
              project_id: { type: 'string' },
              list_id:    { type: 'string' },
              task_id:    { type: 'string' },
            },
            required: ['project_id', 'list_id', 'task_id'],
          },
        },
      ],
    }));
  • The apiGet helper function used by proofhub_get_comments to make authenticated GET requests to the ProofHub API with rate-limit retry handling.
    async function apiGet(url) {
      try {
        const res = await http.get(url);
        return res.data;
      } catch (err) {
        if (err.response?.status === 429) {
          const retryAfter = parseInt(err.response.headers['retry-after'] || '5', 10);
          await new Promise(r => setTimeout(r, retryAfter * 1000));
          return apiGet(url);
        }
        throw new Error(`ProofHub API error ${err.response?.status}: ${JSON.stringify(err.response?.data) || err.message}`);
      }
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavioral traits. It only states 'fetch all comments' but does not mention pagination, rate limits, authentication requirements, or any side effects. The minimal description does not compensate for the lack of annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence that is front-loaded with the core purpose. It is appropriately concise, though slightly too brief for the complexity of a three-parameter fetch tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of an output schema and three required parameters, the description should explain the return structure beyond 'full text'. It does not specify what fields are returned, how comments are ordered, or any limits, leaving the agent with insufficient context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has three required parameters with zero description coverage. The tool description does not explain what project_id, list_id, or task_id represent or how they relate to the task. The description adds no semantic value beyond the parameter names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (fetch) and the resource (all comments on a ProofHub task), and adds specificity with 'including their full text'. It distinguishes from sibling tools like proofhub_create_comment (write) and proofhub_get_task (different resource).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives, such as when to fetch comments vs. task details. The description lacks any context about prerequisites or conditions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

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/MustafaPatharia/proofhub-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server