article
README
🚀 Atlassian Bitbucket MCP 服务器
Atlassian Bitbucket MCP 服务器是一款用于与 Bitbucket 代码仓库进行交互的实用工具。它具备搜索、拉取请求管理以及问题跟踪等功能,能有效提升代码仓库的管理效率。
🚀 快速开始
你可以参考以下步骤快速开启使用 Atlassian Bitbucket MCP 服务器:
npm install -g @aashari/mcp-server-atlassian-bitbucket
mcp-atlassian-bitbucket --help
✨ 主要特性
- 搜索:可在指定的工作区中对文件、拉取请求和提交进行搜索。
- 拉取请求管理:支持创建、查看和评论拉取请求。
- 问题跟踪:能够列出和添加问题评论。
📦 安装指南
先决条件
- Node.js 版本要求为 14.x 或更高版本,推荐使用 LTS 版本。
- 必须安装 npm。
使用密钥认证
- 在 Bitbucket 中生成 OAuth 消息密钥:
- 登录 Bitbucket 管理控制台。
- 转到 OAuth 工具 > 生成消费者。
- 填写 Consumer Key(例如:
mcp-server)。 - 生成并下载密钥对。
- 配置 MCP 服务器:
BITBUCKET_OAUTH_KEY=your_consumer_key \ BITBUCKET_OAUTH_SECRET=your_secret_key \ npm install -g @aashari/mcp-server-atlassian-bitbucket - 使用密码认证(可选):
npm install -g @aashari/mcp-server-atlassian-bitbucket
配置方法
基于文件的配置
创建 config.json 文件,内容如下:
{
"bitbucket": {
"base-url": "https://api.bitbucket.org",
"workspace": "your_workspace"
},
"auth": {
"type": "oauth2",
"consumer-key": "your_consumer_key",
"secret-key": "your_secret_key"
}
}
环境变量配置
设置以下环境变量:
BITBUCKET_BASE_URL:Bitbucket API 地址,默认为https://api.bitbucket.org。BITBUCKET_WORKSPACE:目标工作区。BITBUCKET_AUTH_TYPE:认证类型,支持oauth2和password。- 对于
oauth2:BITBUCKET_OAUTH_KEY:消费者密钥。BITBUCKET_OAUTH_SECRET:密钥密钥。
- 对于
password:BITBUCKET_USERNAME:Bitbucket 用户名。BITBUCKET_PASSWORD:Bitbucket 密码。
- 对于
💻 使用示例
基础用法
搜索文件
{
"workspace": "your_workspace",
"query": "search_string",
"scope": "files"
}
搜索拉取请求
{
"workspace": "your_workspace",
"repo_slug": "repository_name",
"query": "pr_keyword",
"scope": "pullrequests"
}
搜索提交记录
{
"workspace": "your_workspace",
"repo_slug": "repository_name",
// 原文档此处未完整,保持原样
}
Scan to join WeChat group