@aashari/mcp-server-atlassian-jira

中文文档
3.3.0发布于 2025/12/03ISCTypeScriptCommonJS近 30 天下载 5.9万

Node.js/TypeScript MCP server for Atlassian Jira. Equips AI systems (LLMs) with tools to list/get projects, search/get issues (using JQL/ID), and view dev info (commits, PRs). Connects AI capabilities directly into Jira project management and issue tracki

原始使用文档
文档目录33 节
  1. What You Can Do
  2. Perfect For
  3. Quick Start
  4. 1. Get Your Jira Credentials
  5. 2. Try It Instantly
  6. Connect to AI Assistants
  7. For Claude Desktop Users
  8. For Other AI Assistants
  9. Alternative: Configuration File
  10. Available Tools
  11. Common API Paths
  12. JMESPath Filtering
  13. Real-World Examples
  14. Explore Your Projects
  15. Search and Track Issues
  16. Manage Issue Details
  17. Issue Communication
  18. CLI Commands
  19. Troubleshooting
  20. "Authentication failed" or "403 Forbidden"
  21. "Resource not found" or "404"
  22. "No results found" when searching
  23. Claude Desktop Integration Issues
  24. Getting Help
  25. Frequently Asked Questions
  26. What permissions do I need?
  27. Can I use this with Jira Server (on-premise)?
  28. How do I find my site name?
  29. What AI assistants does this work with?
  30. Is my data secure?
  31. Can I search across multiple projects?
  32. Migration from v2.x
  33. Support

Connect AI to Your Jira Projects

Transform how you manage and track your work by connecting Claude, Cursor AI, and other AI assistants directly to your Jira projects, issues, and workflows. Get instant project insights, streamline issue management, and enhance your team collaboration.

NPM Version

What You Can Do

  • Ask AI about your projects: "What are the active issues in the DEV project?"
  • Get issue insights: "Show me details about PROJ-123 including comments"
  • Track project progress: "List all high priority issues assigned to me"
  • Manage issue comments: "Add a comment to PROJ-456 about the test results"
  • Search across projects: "Find all bugs in progress across my projects"
  • Create and update issues: "Create a new bug in the MOBILE project"

Perfect For

  • Developers who need quick access to issue details and development context
  • Project Managers tracking progress, priorities, and team assignments
  • Scrum Masters managing sprints and workflow states
  • Team Leads monitoring project health and issue resolution
  • QA Engineers tracking bugs and testing status
  • Anyone who wants to interact with Jira using natural language

Quick Start

Get up and running in 2 minutes:

1. Get Your Jira Credentials

Generate a Jira API Token:

  1. Go to Atlassian API Tokens
  2. Click Create API token
  3. Give it a name like "AI Assistant"
  4. Copy the generated token immediately (you won't see it again!)

2. Try It Instantly

# Set your credentials
export ATLASSIAN_SITE_NAME="your-company"  # for your-company.atlassian.net
export ATLASSIAN_USER_EMAIL="[email protected]"
export ATLASSIAN_API_TOKEN="your_api_token"

# List your Jira projects
npx -y @aashari/mcp-server-atlassian-jira get --path "/rest/api/3/project/search"

# Get details about a specific project
npx -y @aashari/mcp-server-atlassian-jira get --path "/rest/api/3/project/DEV"

# Get an issue with JMESPath filtering
npx -y @aashari/mcp-server-atlassian-jira get --path "/rest/api/3/issue/PROJ-123" --jq "{key: key, summary: fields.summary, status: fields.status.name}"

Connect to AI Assistants

For Claude Desktop Users

Add this to your Claude configuration file (~/.claude/claude_desktop_config.json):

{
  "mcpServers": {
    "jira": {
      "command": "npx",
      "args": ["-y", "@aashari/mcp-server-atlassian-jira"],
      "env": {
        "ATLASSIAN_SITE_NAME": "your-company",
        "ATLASSIAN_USER_EMAIL": "[email protected]",
        "ATLASSIAN_API_TOKEN": "your_api_token"
      }
    }
  }
}

Restart Claude Desktop, and you'll see the jira server in the status bar.

For Other AI Assistants

Most AI assistants support MCP. Install the server globally:

npm install -g @aashari/mcp-server-atlassian-jira

Then configure your AI assistant to use the MCP server with STDIO transport.

Alternative: Configuration File

Create ~/.mcp/configs.json for system-wide configuration:

{
  "jira": {
    "environments": {
      "ATLASSIAN_SITE_NAME": "your-company",
      "ATLASSIAN_USER_EMAIL": "[email protected]",
      "ATLASSIAN_API_TOKEN": "your_api_token"
    }
  }
}

Alternative config keys: The system also accepts "atlassian-jira", "@aashari/mcp-server-atlassian-jira", or "mcp-server-atlassian-jira" instead of "jira".

Available Tools

This MCP server provides 5 generic tools that can access any Jira API endpoint:

ToolDescription
jira_getGET any Jira API endpoint (read data)
jira_postPOST to any endpoint (create resources)
jira_putPUT to any endpoint (replace resources)
jira_patchPATCH any endpoint (partial updates)
jira_deleteDELETE any endpoint (remove resources)

Common API Paths

Projects:

  • /rest/api/3/project/search - List all projects
  • /rest/api/3/project/{projectKeyOrId} - Get project details

Issues:

  • /rest/api/3/search/jql - Search issues with JQL (use jql query param)
  • /rest/api/3/issue/{issueIdOrKey} - Get issue details
  • /rest/api/3/issue - Create issue (POST)
  • /rest/api/3/issue/{issueIdOrKey}/transitions - Get/perform transitions

Comments:

  • /rest/api/3/issue/{issueIdOrKey}/comment - List/add comments
  • /rest/api/3/issue/{issueIdOrKey}/comment/{commentId} - Get/update/delete comment

Worklogs:

  • /rest/api/3/issue/{issueIdOrKey}/worklog - List/add worklogs
  • /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId} - Get/update/delete worklog

Users & Statuses:

  • /rest/api/3/myself - Get current user
  • /rest/api/3/user/search - Search users (use query param)
  • /rest/api/3/status - List all statuses
  • /rest/api/3/issuetype - List issue types
  • /rest/api/3/priority - List priorities

JMESPath Filtering

All tools support optional JMESPath (jq) filtering to extract specific data:

# Get just project names and keys
npx -y @aashari/mcp-server-atlassian-jira get \
  --path "/rest/api/3/project/search" \
  --jq "values[].{key: key, name: name}"

# Get issue key and summary
npx -y @aashari/mcp-server-atlassian-jira get \
  --path "/rest/api/3/issue/PROJ-123" \
  --jq "{key: key, summary: fields.summary, status: fields.status.name}"

Real-World Examples

Explore Your Projects

Ask your AI assistant:

  • "List all projects I have access to"
  • "Show me details about the DEV project"
  • "What projects contain the word 'Platform'?"

Search and Track Issues

Ask your AI assistant:

  • "Find all high priority issues in the DEV project"
  • "Show me issues assigned to me that are in progress"
  • "Search for bugs reported in the last week"
  • "List all open issues for the mobile team"

Manage Issue Details

Ask your AI assistant:

  • "Get full details about issue PROJ-456 including comments"
  • "What's the current status and assignee of PROJ-123?"
  • "Display all comments on the authentication bug"

Issue Communication

Ask your AI assistant:

  • "Add a comment to PROJ-456: 'Code review completed, ready for testing'"
  • "Comment on the login issue that it's been deployed to staging"

CLI Commands

The CLI mirrors the MCP tools for direct terminal access:

# GET request
npx -y @aashari/mcp-server-atlassian-jira get --path "/rest/api/3/project/search"

# GET with query parameters
npx -y @aashari/mcp-server-atlassian-jira get \
  --path "/rest/api/3/search/jql" \
  --query-params '{"jql": "project=DEV AND status=\"In Progress\"", "maxResults": "10"}'

# POST request (create an issue)
npx -y @aashari/mcp-server-atlassian-jira post \
  --path "/rest/api/3/issue" \
  --body '{"fields": {"project": {"key": "DEV"}, "summary": "New issue title", "issuetype": {"name": "Task"}}}'

# POST request (add a comment)
npx -y @aashari/mcp-server-atlassian-jira post \
  --path "/rest/api/3/issue/PROJ-123/comment" \
  --body '{"body": {"type": "doc", "version": 1, "content": [{"type": "paragraph", "content": [{"type": "text", "text": "My comment"}]}]}}'

# PUT request (update issue - full replacement)
npx -y @aashari/mcp-server-atlassian-jira put \
  --path "/rest/api/3/issue/PROJ-123" \
  --body '{"fields": {"summary": "Updated title"}}'

# DELETE request
npx -y @aashari/mcp-server-atlassian-jira delete \
  --path "/rest/api/3/issue/PROJ-123/comment/12345"

Troubleshooting

"Authentication failed" or "403 Forbidden"

  1. Check your API Token permissions:

  2. Verify your site name format:

    • If your Jira URL is https://mycompany.atlassian.net
    • Your site name should be just mycompany
  3. Test your credentials:

    npx -y @aashari/mcp-server-atlassian-jira get --path "/rest/api/3/myself"
    

"Resource not found" or "404"

  1. Check the API path:

    • Paths are case-sensitive
    • Use project keys (e.g., DEV) not project names
    • Issue keys include the project prefix (e.g., DEV-123)
  2. Verify access permissions:

    • Make sure you have access to the project in your browser
    • Some projects may be restricted to certain users

"No results found" when searching

  1. Try different search terms:

    • Use project keys instead of project names
    • Try broader search criteria
  2. Check JQL syntax:

    • Validate your JQL in Jira's advanced search first

Claude Desktop Integration Issues

  1. Restart Claude Desktop after updating the config file
  2. Verify config file location:
    • macOS: ~/.claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json

Getting Help

If you're still having issues:

  1. Run a simple test command to verify everything works
  2. Check the GitHub Issues for similar problems
  3. Create a new issue with your error message and setup details

Frequently Asked Questions

What permissions do I need?

Your Atlassian account needs:

  • Access to Jira with the appropriate permissions for the projects you want to query
  • API token with appropriate permissions (automatically granted when you create one)

Can I use this with Jira Server (on-premise)?

Currently, this tool only supports Jira Cloud. Jira Server/Data Center support may be added in future versions.

How do I find my site name?

Your site name is the first part of your Jira URL:

  • URL: https://mycompany.atlassian.net -> Site name: mycompany
  • URL: https://acme-corp.atlassian.net -> Site name: acme-corp

What AI assistants does this work with?

Any AI assistant that supports the Model Context Protocol (MCP):

  • Claude Desktop
  • Cursor AI
  • Continue.dev
  • Many others

Is my data secure?

Yes! This tool:

  • Runs entirely on your local machine
  • Uses your own Jira credentials
  • Never sends your data to third parties
  • Only accesses what you give it permission to access

Can I search across multiple projects?

Yes! Use JQL queries for cross-project searches. For example:

npx -y @aashari/mcp-server-atlassian-jira get \
  --path "/rest/api/3/search/jql" \
  --query-params '{"jql": "assignee=currentUser() AND status=\"In Progress\""}'

Migration from v2.x

Version 3.0 replaces 8+ specific tools with 5 generic HTTP method tools. If you're upgrading from v2.x:

Before (v2.x):

jira_ls_projects, jira_get_project, jira_ls_issues, jira_get_issue,
jira_create_issue, jira_ls_comments, jira_add_comment, jira_ls_statuses, ...

After (v3.0):

jira_get, jira_post, jira_put, jira_patch, jira_delete

Migration examples:

  • jira_ls_projects -> jira_get with path /rest/api/3/project/search
  • jira_get_project -> jira_get with path /rest/api/3/project/{key}
  • jira_get_issue -> jira_get with path /rest/api/3/issue/{key}
  • jira_create_issue -> jira_post with path /rest/api/3/issue
  • jira_add_comment -> jira_post with path /rest/api/3/issue/{key}/comment
  • jira_ls_statuses -> jira_get with path /rest/api/3/status

Support

Need help? Here's how to get assistance:

  1. Check the troubleshooting section above - most common issues are covered there
  2. Visit our GitHub repository for documentation and examples: github.com/aashari/mcp-server-atlassian-jira
  3. Report issues at GitHub Issues
  4. Start a discussion for feature requests or general questions

Made with care for teams who want to bring AI into their project management workflow.

版本与发布记录

@aashari/mcp-server-atlassian-jira 共发布 108 个版本,首次发布于 2025/03/23;过去 12 个月发布了 5 个版本。

版本发布日期距今
3.3.0latest2025/12/0311 个月前
3.2.12025/12/0111 个月前
3.2.02025/12/0111 个月前
3.1.02025/12/0111 个月前
3.0.02025/11/2811 个月前
2.1.12025/09/091.2 年前

关于 @aashari/mcp-server-atlassian-jira 的常见问题

@aashari/mcp-server-atlassian-jira 是什么?

Node.js/TypeScript MCP server for Atlassian Jira. Equips AI systems (LLMs) with tools to list/get projects, search/get issues (using JQL/ID), and view dev info (commits, PRs). Connects AI capabilities directly into Jira project management and issue tracki

如何安装 @aashari/mcp-server-atlassian-jira?

在项目目录运行 npm install @aashari/mcp-server-atlassian-jira,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mcp-atlassian-jira,可以用 npx mcp-atlassian-jira 直接运行。

@aashari/mcp-server-atlassian-jira 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aashari/mcp-server-atlassian-jira 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@aashari/mcp-server-atlassian-jira 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aashari/mcp-server-atlassian-jira 可以商用吗?

@aashari/mcp-server-atlassian-jira 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aashari/mcp-server-atlassian-jira 的下载量有多少?

根据 npm 官方下载统计,@aashari/mcp-server-atlassian-jira 在 2026/10/05 – 2026/11/03 这 30 天内被下载 58,640 次,日均约 1,955 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aashari/mcp-server-atlassian-jira 还在维护吗?

最新版本 3.3.0 发布于 2025/12/03(11 个月前);至今共发布 108 个版本,其中过去 12 个月发布了 5 个;首次发布于 2025/03/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。