github-issues

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

GitHub Issues

GitHub Issues

Manage GitHub issues using the
@modelcontextprotocol/server-github
MCP server.
使用
@modelcontextprotocol/server-github
MCP服务器管理GitHub Issues。

Available MCP Tools

可用的MCP工具

ToolPurpose
mcp__github__create_issue
Create new issues
mcp__github__update_issue
Update existing issues
mcp__github__get_issue
Fetch issue details
mcp__github__search_issues
Search issues
mcp__github__add_issue_comment
Add comments
mcp__github__list_issues
List repository issues
工具用途
mcp__github__create_issue
创建新工单
mcp__github__update_issue
更新现有工单
mcp__github__get_issue
获取工单详情
mcp__github__search_issues
搜索工单
mcp__github__add_issue_comment
添加评论
mcp__github__list_issues
列出仓库工单

Workflow

工作流

  1. Determine action: Create, update, or query?
  2. Gather context: Get repo info, existing labels, milestones if needed
  3. Structure content: Use appropriate template from references/templates.md
  4. Execute: Call the appropriate MCP tool
  5. Confirm: Report the issue URL to user
  1. 确定操作:创建、更新还是查询?
  2. 收集上下文:获取仓库信息、现有标签、里程碑(如有需要)
  3. 组织内容:使用references/templates.md中的对应模板
  4. 执行:调用合适的MCP工具
  5. 确认:向用户反馈工单URL

Creating Issues

创建工单

Required Parameters

必填参数

owner: repository owner (org or user)
repo: repository name  
title: clear, actionable title
body: structured markdown content
owner: 仓库所有者(组织或用户)
repo: 仓库名称  
title: 清晰、可执行的标题
body: 结构化的Markdown内容

Optional Parameters

可选参数

labels: ["bug", "enhancement", "documentation", ...]
assignees: ["username1", "username2"]
milestone: milestone number (integer)
labels: ["bug", "enhancement", "documentation", ...]
assignees: ["username1", "username2"]
milestone: 里程碑编号(整数)

Title Guidelines

标题规范

  • Start with type prefix when useful:
    [Bug]
    ,
    [Feature]
    ,
    [Docs]
  • Be specific and actionable
  • Keep under 72 characters
  • Examples:
    • [Bug] Login fails with SSO enabled
    • [Feature] Add dark mode support
    • Add unit tests for auth module
  • 必要时以类型前缀开头:
    [Bug]
    ,
    [Feature]
    ,
    [Docs]
  • 具体且可执行
  • 长度控制在72字符以内
  • 示例:
    • [Bug] Login fails with SSO enabled
    • [Feature] Add dark mode support
    • Add unit tests for auth module

Body Structure

正文结构

Always use the templates in references/templates.md. Choose based on issue type:
User RequestTemplate
Bug, error, broken, not workingBug Report
Feature, enhancement, add, newFeature Request
Task, chore, refactor, updateTask
请始终使用references/templates.md中的模板,根据工单类型选择:
用户请求模板
Bug、错误、功能异常、无法使用Bug报告模板
新功能、功能优化、新增需求功能请求模板
任务、杂活、重构、更新任务模板

Updating Issues

更新工单

Use
mcp__github__update_issue
with:
owner, repo, issue_number (required)
title, body, state, labels, assignees, milestone (optional - only changed fields)
State values:
open
,
closed
使用
mcp__github__update_issue
工具,参数如下:
owner, repo, issue_number(必填)
title, body, state, labels, assignees, milestone(可选 - 仅传入需要修改的字段)
状态值可选:
open
,
closed

Examples

示例

Example 1: Bug Report

示例1:Bug报告

User: "Create a bug issue - the login page crashes when using SSO"
Action: Call
mcp__github__create_issue
with:
json
{
  "owner": "github",
  "repo": "awesome-copilot",
  "title": "[Bug] Login page crashes when using SSO",
  "body": "## Description\nThe login page crashes when users attempt to authenticate using SSO.\n\n## Steps to Reproduce\n1. Navigate to login page\n2. Click 'Sign in with SSO'\n3. Page crashes\n\n## Expected Behavior\nSSO authentication should complete and redirect to dashboard.\n\n## Actual Behavior\nPage becomes unresponsive and displays error.\n\n## Environment\n- Browser: [To be filled]\n- OS: [To be filled]\n\n## Additional Context\nReported by user.",
  "labels": ["bug"]
}
用户:"创建一个bug工单 - 登录页面在使用SSO时崩溃"
操作:调用
mcp__github__create_issue
,参数如下:
json
{
  "owner": "github",
  "repo": "awesome-copilot",
  "title": "[Bug] Login page crashes when using SSO",
  "body": "## Description\nThe login page crashes when users attempt to authenticate using SSO.\n\n## Steps to Reproduce\n1. Navigate to login page\n2. Click 'Sign in with SSO'\n3. Page crashes\n\n## Expected Behavior\nSSO authentication should complete and redirect to dashboard.\n\n## Actual Behavior\nPage becomes unresponsive and displays error.\n\n## Environment\n- Browser: [To be filled]\n- OS: [To be filled]\n\n## Additional Context\nReported by user.",
  "labels": ["bug"]
}

Example 2: Feature Request

示例2:功能请求

User: "Create a feature request for dark mode with high priority"
Action: Call
mcp__github__create_issue
with:
json
{
  "owner": "github",
  "repo": "awesome-copilot",
  "title": "[Feature] Add dark mode support",
  "body": "## Summary\nAdd dark mode theme option for improved user experience and accessibility.\n\n## Motivation\n- Reduces eye strain in low-light environments\n- Increasingly expected by users\n- Improves accessibility\n\n## Proposed Solution\nImplement theme toggle with system preference detection.\n\n## Acceptance Criteria\n- [ ] Toggle switch in settings\n- [ ] Persists user preference\n- [ ] Respects system preference by default\n- [ ] All UI components support both themes\n\n## Alternatives Considered\nNone specified.\n\n## Additional Context\nHigh priority request.",
  "labels": ["enhancement", "high-priority"]
}
用户:"创建一个高优先级的深色模式功能请求"
操作:调用
mcp__github__create_issue
,参数如下:
json
{
  "owner": "github",
  "repo": "awesome-copilot",
  "title": "[Feature] Add dark mode support",
  "body": "## Summary\nAdd dark mode theme option for improved user experience and accessibility.\n\n## Motivation\n- Reduces eye strain in low-light environments\n- Increasingly expected by users\n- Improves accessibility\n\n## Proposed Solution\nImplement theme toggle with system preference detection.\n\n## Acceptance Criteria\n- [ ] Toggle switch in settings\n- [ ] Persists user preference\n- [ ] Respects system preference by default\n- [ ] All UI components support both themes\n\n## Alternatives Considered\nNone specified.\n\n## Additional Context\nHigh priority request.",
  "labels": ["enhancement", "high-priority"]
}

Common Labels

常用标签

Use these standard labels when applicable:
LabelUse For
bug
Something isn't working
enhancement
New feature or improvement
documentation
Documentation updates
good first issue
Good for newcomers
help wanted
Extra attention needed
question
Further information requested
wontfix
Will not be addressed
duplicate
Already exists
high-priority
Urgent issues
适用时请使用以下标准标签:
标签使用场景
bug
功能异常
enhancement
新功能或优化
documentation
文档更新
good first issue
适合新手的任务
help wanted
需要额外关注
question
需要更多信息
wontfix
不会处理
duplicate
重复工单
high-priority
紧急工单

Tips

小贴士

  • Always confirm the repository context before creating issues
  • Ask for missing critical information rather than guessing
  • Link related issues when known:
    Related to #123
  • For updates, fetch current issue first to preserve unchanged fields
  • 创建工单前请确认仓库上下文
  • 若缺少关键信息,向用户询问而非猜测
  • 已知相关工单时请添加链接:
    Related to #123
  • 更新工单时,先获取当前工单信息以保留未修改的字段