[MCP] Support issue comments in create_comment tool #7821

tobiu · tobiu · commit 7940179ac94e · 2025-11-20T16:18:44.000+01:00
diff --git a/ai/mcp/server/github-workflow/openapi.yaml b/ai/mcp/server/github-workflow/openapi.yaml
@@ -244,34 +244,30 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
 
-  /pull-requests/{pr_number}/comments:
+  /comments:
     post:
-      summary: Create a PR Comment
+      summary: Create a Comment on Issue or PR
       operationId: create_comment
+      x-pass-as-object: true
       x-annotations:
         readOnlyHint: false
       description: |
-        Adds a final review comment to a pull request, either approving it or requesting changes. This is the primary tool for summarizing the outcome of a PR review.
-
+        Adds a comment to a pull request or issue.
         The tool automatically adds a header indicating the AI agent source and prefixes the comment with a special icon.
 
         **When to Use:**
-        This tool is for providing a conclusive, final review on a pull request.
 
+        **For Pull Requests:**
+        This is the primary tool for providing a conclusive, final review.
         - **To Approve a PR:** Use this tool to leave a comment indicating your approval (e.g., "LGTM, thanks for the contribution!").
         - **To Request Changes:** Use this tool to provide a clear, actionable list of changes required for the PR to be approved. This should be a summary of your findings after a detailed review.
 
-        **Note on Inline Comments:**
-        While this tool is for the final, summary comment, detailed line-by-line feedback should be provided through other means if available. This tool provides the final verdict.
-      tags: [Pull Requests]
-      parameters:
-        - name: pr_number
-          in: path
-          required: true
-          description: The number of the pull request to comment on.
-          schema:
-            type: integer
-            example: 123
+        **For Issues:**
+        Use this tool to add general comments, such as providing status updates, asking for clarification, or summarizing discussions.
+
+        **Note on Inline Comments (PRs):**
+        While this tool is for the final, summary comment on PRs, detailed line-by-line feedback should be provided through other means if available. This tool provides the final verdict.
+      tags: [Pull Requests, Issues]
       requestBody:
         required: true
         content:
@@ -282,6 +278,14 @@ paths:
                 - body
                 - agent
               properties:
+                pr_number:
+                  type: integer
+                  description: The number of the pull request (if commenting on a PR).
+                  example: 123
+                issue_number:
+                  type: integer
+                  description: The number of the issue (if commenting on an issue).
+                  example: 456
                 body:
                   type: string
                   description: The raw, unformatted content of the comment. The tool will handle templating.
@@ -297,8 +301,14 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/SuccessResponse'
+        '400':
+          description: Bad Request (missing pr_number or issue_number).
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '404':
-          description: Pull request not found.
+          description: Resource not found.
           content:
             application/json:
               schema:
diff --git a/ai/mcp/server/github-workflow/services/IssueService.mjs b/ai/mcp/server/github-workflow/services/IssueService.mjs
@@ -7,10 +7,18 @@ import {exec}            from 'child_process';
 import {promisify}       from 'util';
 import {spawn}           from 'child_process';
 import {GET_ISSUE_AND_LABEL_IDS, GET_ISSUE_PARENT, GET_BLOCKED_BY, FETCH_ISSUES_FOR_SYNC} from './queries/issueQueries.mjs';
-import {ADD_LABELS, REMOVE_LABELS, ADD_SUB_ISSUE, REMOVE_SUB_ISSUE, ADD_BLOCKED_BY, REMOVE_BLOCKED_BY, GET_ISSUE_ID} from './queries/mutations.mjs';
+import {GET_PULL_REQUEST_ID} from './queries/pullRequestQueries.mjs';
+import {ADD_LABELS, REMOVE_LABELS, ADD_SUB_ISSUE, REMOVE_SUB_ISSUE, ADD_BLOCKED_BY, REMOVE_BLOCKED_BY, GET_ISSUE_ID, ADD_COMMENT} from './queries/mutations.mjs';
 
 const execAsync = promisify(exec);
 
+const AGENT_ICONS = {
+    gemini : '✦',
+    claude : '❋',
+    gpt    : '●',
+    default: '◆'
+};
+
 /**
  * Service for interacting with GitHub issues via the GraphQL API.
  * @class Neo.ai.mcp.server.github-workflow.services.IssueService
@@ -44,6 +52,95 @@ class IssueService extends Base {
         return this.writePermissions.includes(RepositoryService.viewerPermission);
     }
 
+    /**
+     * Extracts the agent type from the agent string for icon selection.
+     * @param {string} agent - The full agent identifier
+     * @returns {string} The agent type key for AGENT_ICONS lookup
+     */
+    getAgentType(agent) {
+        const agentLower = agent.toLowerCase();
+
+        if (agentLower.includes('gemini')) return 'gemini';
+        if (agentLower.includes('claude')) return 'claude';
+        if (agentLower.includes('gpt'))    return 'gpt';
+
+        return 'default';
+    }
+
+    /**
+     * Creates a comment on a specific issue or pull request.
+     * @param {object} options
+     * @param {number} [options.issue_number] - The number of the issue.
+     * @param {number} [options.pr_number] - The number of the pull request.
+     * @param {string} options.body - The raw content of the comment.
+     * @param {string} options.agent - The identity of the calling agent.
+     * @returns {Promise<object>} A promise that resolves to a success message.
+     */
+    async createComment({issue_number, pr_number, body, agent}) {
+        // Input Validation
+        if (issue_number && pr_number) {
+             return {
+                error: "Bad Request",
+                message: "Please provide either 'pr_number' or 'issue_number', not both.",
+                code: "INVALID_ARGUMENTS"
+            };
+        }
+        if (!issue_number && !pr_number) {
+             return {
+                error: "Bad Request",
+                message: "Missing required argument: Please provide 'pr_number' or 'issue_number'.",
+                code: "MISSING_ARGUMENTS"
+            };
+        }
+
+        const isPR = !!pr_number;
+        const number = isPR ? pr_number : issue_number;
+        const idVariables = {
+            owner : aiConfig.owner,
+            repo  : aiConfig.repo,
+            // The PR query uses 'prNumber', the Issue query uses 'number'
+            [isPR ? 'prNumber' : 'number']: number
+        };
+
+        // Agent Header Formatting
+        const header       = `**Input from ${agent}:**\n\n`;
+        const agentIcon    = AGENT_ICONS[this.getAgentType(agent)];
+        const headingMatch = body.match(/^(#+\s*)(.*)$/);
+        let processedBody;
+
+        if (headingMatch) {
+            const headingMarkers = headingMatch[1];
+            const headingContent = headingMatch[2];
+            processedBody = `${headingMarkers}${agentIcon} ${headingContent}\n${body.substring(headingMatch[0].length)}`;
+        } else {
+            processedBody = `${agentIcon} ${body}`;
+        }
+
+        const finalBody = `${header}${processedBody.split('\n').map(line => `> ${line}`).join('\n')}`;
+
+        try {
+            // Divergent ID Lookup
+            const query = isPR ? GET_PULL_REQUEST_ID : GET_ISSUE_ID;
+            const idData = await GraphqlService.query(query, idVariables);
+
+            const subjectId = isPR
+                ? idData.repository.pullRequest.id
+                : idData.repository.issue.id;
+
+            // Shared Mutation
+            await GraphqlService.query(ADD_COMMENT, { subjectId, body: finalBody });
+            return { message: `Successfully created comment on ${isPR ? 'PR' : 'issue'} #${number}` };
+
+        } catch (error) {
+            logger.error(`Error creating comment on ${isPR ? 'PR' : 'issue'} #${number} via GraphQL:`, error);
+            return {
+                error  : 'GraphQL API request failed',
+                message: error.message,
+                code   : 'GRAPHQL_API_ERROR'
+            };
+        }
+    }
+
     /**
      * Assigns one or more users to a GitHub issue, or clears all assignees.
      * This method first verifies that the user has the required permissions (`WRITE`, `MAINTAIN`, or `ADMIN`)
diff --git a/ai/mcp/server/github-workflow/services/PullRequestService.mjs b/ai/mcp/server/github-workflow/services/PullRequestService.mjs
@@ -1,20 +1,14 @@
-import {exec}         from 'child_process';
-import {promisify}    from 'util';
-import Base           from '../../../../../src/core/Base.mjs';
-import GraphqlService from './GraphqlService.mjs';
-import aiConfig       from '../config.mjs';
-import logger         from '../logger.mjs';
-import {ADD_COMMENT, FETCH_PULL_REQUESTS, GET_CONVERSATION, GET_PULL_REQUEST_ID, UPDATE_COMMENT} from './queries/pullRequestQueries.mjs';
+import {exec}                                  from 'child_process';
+import {promisify}                             from 'util';
+import Base                                    from '../../../../../src/core/Base.mjs';
+import GraphqlService                          from './GraphqlService.mjs';
+import aiConfig                                from '../config.mjs';
+import logger                                  from '../logger.mjs';
+import {FETCH_PULL_REQUESTS, GET_CONVERSATION} from './queries/pullRequestQueries.mjs';
+import {UPDATE_COMMENT}                        from './queries/mutations.mjs';
 
 const execAsync = promisify(exec);
 
-const AGENT_ICONS = {
-    gemini : '✦',
-    claude : '❋',
-    gpt    : '●',
-    default: '◆'
-};
-
 /**
  * Service for interacting with GitHub Pull Requests via the `gh` CLI and GraphQL API.
  * @class Neo.ai.mcp.server.github-workflow.services.PullRequestService
@@ -88,21 +82,6 @@ class PullRequestService extends Base {
         }
     }
 
-    /**
-     * Extracts the agent type from the agent string for icon selection.
-     * @param {string} agent - The full agent identifier (e.g., "Gemini 2.5 Pro", "Claude Sonnet 4.5", "Chat GPT 4")
-     * @returns {string} The agent type key for AGENT_ICONS lookup
-     */
-    getAgentType(agent) {
-        const agentLower = agent.toLowerCase();
-
-        if (agentLower.includes('gemini')) return 'gemini';
-        if (agentLower.includes('claude')) return 'claude';
-        if (agentLower.includes('gpt'))    return 'gpt';
-
-        return 'default';
-    }
-
     /**
      * Gets the diff for a specific pull request.
      * @param {number} prNumber - The number of the pull request.
@@ -122,55 +101,6 @@ class PullRequestService extends Base {
         }
     }
 
-    /**
-     * Creates a comment on a specific pull request.
-     * @param {number} prNumber - The number of the pull request.
-     * @param {string} body     - The raw content of the comment. The agent should provide
-     *                            any desired markdown formatting (e.g., blockquotes, code blocks).
-     *                            This tool will only add the agent header and icon prefix.
-     * @param {string} agent    - The identity of the calling agent (e.g., "Gemini 2.5 Pro", "Claude Sonnet 4.5").
-     *                            Adds a formatted header with the appropriate icon.
-     * @returns {Promise<object>} A promise that resolves to a success message or a structured error.
-     */
-    async createComment(prNumber, body, agent) {
-        const idVariables = {
-            owner   : aiConfig.owner,
-            repo    : aiConfig.repo,
-            prNumber
-        };
-
-        const header       = `**Input from ${agent}:**\n\n`;
-        const agentIcon    = AGENT_ICONS[this.getAgentType(agent)];
-        const headingMatch = body.match(/^(#+\s*)(.*)$/);
-        let processedBody;
-
-        if (headingMatch) {
-            const headingMarkers = headingMatch[1];
-            const headingContent = headingMatch[2];
-            processedBody = `${headingMarkers}${agentIcon} ${headingContent}\n${body.substring(headingMatch[0].length)}`;
-        } else {
-            processedBody = `${agentIcon} ${body}`;
-        }
-
-        const finalBody = `${header}${processedBody.split('\n').map(line => `> ${line}`).join('\n')}`;
-
-        try {
-            const idData    = await GraphqlService.query(GET_PULL_REQUEST_ID, idVariables);
-            const subjectId = idData.repository.pullRequest.id;
-
-            await GraphqlService.query(ADD_COMMENT, { subjectId, body: finalBody });
-            return { message: `Successfully created comment on PR #${prNumber}` };
-
-        } catch (error) {
-            logger.error(`Error creating comment on PR #${prNumber} via GraphQL:`, error);
-            return {
-                error  : 'GraphQL API request failed',
-                message: error.message,
-                code   : 'GRAPHQL_API_ERROR'
-            };
-        }
-    }
-
     /**
      * Gets the full conversation for a specific pull request.
      * @param {number} prNumber - The number of the pull request.
diff --git a/ai/mcp/server/github-workflow/services/queries/mutations.mjs b/ai/mcp/server/github-workflow/services/queries/mutations.mjs
@@ -221,3 +221,42 @@ export const REMOVE_BLOCKED_BY = `
         }
     }
 `;
+
+/**
+ * Mutation to add a comment to a subject (issue or PR).
+ *
+ * Variables required:
+ * - $subjectId: ID! - The global ID of the issue or PR
+ * - $body: String! - The comment body
+ */
+export const ADD_COMMENT = `
+  mutation AddComment($subjectId: ID!, $body: String!) {
+    addComment(input: {subjectId: $subjectId, body: $body}) {
+      commentEdge {
+        node {
+          id
+          url
+        }
+      }
+    }
+  }
+`;
+
+/**
+ * Mutation to update an existing comment.
+ *
+ * Variables required:
+ * - $commentId: ID! - The global ID of the comment to update
+ * - $body: String! - The new comment body
+ */
+export const UPDATE_COMMENT = `
+  mutation UpdateComment($commentId: ID!, $body: String!) {
+    updateIssueComment(input: {id: $commentId, body: $body}) {
+      issueComment {
+        id
+        url
+        updatedAt
+      }
+    }
+  }
+`;
diff --git a/ai/mcp/server/github-workflow/services/queries/pullRequestQueries.mjs b/ai/mcp/server/github-workflow/services/queries/pullRequestQueries.mjs
@@ -31,45 +31,6 @@ export const FETCH_PULL_REQUESTS = `
   }
 `;
 
-/**
- * Mutation to add a comment to a pull request.
- *
- * Variables required:
- * - $subjectId: ID! - The global ID of the pull request
- * - $body: String! - The comment body
- */
-export const ADD_COMMENT = `
-  mutation AddComment($subjectId: ID!, $body: String!) {
-    addComment(input: {subjectId: $subjectId, body: $body}) {
-      commentEdge {
-        node {
-          id
-          url
-        }
-      }
-    }
-  }
-`;
-
-/**
- * Mutation to update an existing comment.
- *
- * Variables required:
- * - $commentId: ID! - The global ID of the comment to update
- * - $body: String! - The new comment body
- */
-export const UPDATE_COMMENT = `
-  mutation UpdateComment($commentId: ID!, $body: String!) {
-    updateIssueComment(input: {id: $commentId, body: $body}) {
-      issueComment {
-        id
-        url
-        updatedAt
-      }
-    }
-  }
-`;
-
 /**
  * Query to get the global ID of a pull request.
  *
diff --git a/ai/mcp/server/github-workflow/services/toolService.mjs b/ai/mcp/server/github-workflow/services/toolService.mjs
@@ -17,7 +17,7 @@ const serviceMapping = {
     add_labels               : IssueService      .addLabels              .bind(IssueService),
     assign_issue             : IssueService      .assignIssue            .bind(IssueService),
     checkout_pull_request    : PullRequestService.checkoutPullRequest    .bind(PullRequestService),
-    create_comment           : PullRequestService.createComment          .bind(PullRequestService),
+    create_comment           : IssueService      .createComment          .bind(IssueService),
     create_issue             : IssueService      .createIssue            .bind(IssueService),
     get_conversation         : PullRequestService.getConversation        .bind(PullRequestService),
     get_local_issue_by_id    : LocalFileService  .getIssueById           .bind(LocalFileService),
