add_issue_comment
Add comments to GitHub issues by specifying repository details and issue number. This tool enables users to provide feedback, answer questions, or update status on GitHub issues directly through the PyGithub MCP Server.
Instructions
Add a comment to an issue.
Args:
params: Parameters for adding a comment including:
- owner: Repository owner (user or organization)
- repo: Repository name
- issue_number: Issue number to comment on
- body: Comment text
Returns:
Created comment details from GitHub API
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Implementation Reference
- The @tool decorated handler function for 'add_issue_comment' that validates input, calls the operations layer, handles errors, and formats the MCP response.@tool() def add_issue_comment(params: IssueCommentParams) -> dict: """Add a comment to an issue. Args: params: Parameters for adding a comment including: - owner: Repository owner (user or organization) - repo: Repository name - issue_number: Issue number to comment on - body: Comment text Returns: Created comment details from GitHub API """ try: logger.debug(f"add_issue_comment called with params: {params}") # Pass the Pydantic model directly to the operation result = issues.add_issue_comment(params) logger.debug(f"Got result: {result}") return {"content": [{"type": "text", "text": json.dumps(result, indent=2)}]} except GitHubError as e: logger.error(f"GitHub error: {e}") return { "content": [{"type": "error", "text": format_github_error(e)}], "is_error": True } except Exception as e: logger.error(f"Unexpected error: {e}") logger.error(traceback.format_exc()) error_msg = str(e) if str(e) else "An unexpected error occurred" return { "content": [{"type": "error", "text": f"Internal server error: {error_msg}"}], "is_error": True }
- Pydantic model defining the input schema for the add_issue_comment tool, inheriting from RepositoryRef (owner/repo) with issue_number and body fields, including validation.class IssueCommentParams(RepositoryRef): """Parameters for adding a comment to an issue.""" model_config = ConfigDict(strict=True) issue_number: int = Field(..., description="Issue number to comment on") body: str = Field(..., description="Comment text") @field_validator('body') @classmethod def validate_body(cls, v): """Validate that body is not empty.""" if not v.strip(): raise ValueError("body cannot be empty") return v
- src/pygithub_mcp_server/tools/issues/tools.py:439-463 (registration)The register function that adds add_issue_comment to the list of issue tools and registers them all with the MCP server using register_tools.def register(mcp: FastMCP) -> None: """Register all issue tools with the MCP server. Args: mcp: The MCP server instance """ from pygithub_mcp_server.tools import register_tools # List of all issue tools to register issue_tools = [ create_issue, list_issues, get_issue, update_issue, add_issue_comment, list_issue_comments, update_issue_comment, delete_issue_comment, add_issue_labels, remove_issue_label, ] register_tools(mcp, issue_tools) logger.debug(f"Registered {len(issue_tools)} issue tools")
- The operations layer function that executes the core GitHub API logic using PyGithub to create the issue comment and convert the response.def add_issue_comment(params: IssueCommentParams) -> Dict[str, Any]: """Add a comment to an issue. Args: params: Validated parameters for adding a comment Returns: Created comment details from GitHub API Raises: GitHubError: If the API request fails """ try: client = GitHubClient.get_instance() repository = client.get_repo(f"{params.owner}/{params.repo}") issue = repository.get_issue(params.issue_number) comment = issue.create_comment(params.body) return convert_issue_comment(comment) except GithubException as e: raise GitHubClient.get_instance()._handle_github_exception(e)