模型上下文协议(MCP)是一种新的标准化协议,用于管理大型语言模型(LLMs)与外部系统之间的上下文。在此仓库中,我们提供了一个适用于CircleCI的MCP服务器。
这使您可以使用Cursor IDE、Windsurf、Copilot或任何支持MCP的客户端,通过自然语言来完成CircleCI中的任务,例如:
查找我分支上最新的失败管道并获取日志
https://github.com/CircleCI-Public/mcp-server-circleci/wiki#circleci-mcp-server-with-cursor-idehttps://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74
对于NPX安装:
对于Docker安装:
在您的Cursor MCP配置中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci@latest"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
在您的Cursor MCP配置中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"CIRCLECI_TOKEN",
"-e",
"CIRCLECI_BASE_URL",
"circleci:mcp-server-circleci"
],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
在您的Cursor MCP配置中添加以下内容:
{
"inputs": [
{
"type": "promptString",
"id": "circleci-token",
"description": "CircleCI API Token",
"password": true
}
],
"servers": {
"circleci-mcp-server-remote": {
"url": "http://your-circleci-remote-mcp-server-endpoint:8000/mcp"
}
}
}
在.vscode/mcp.json中安装CircleCI MCP服务器:
{
// 💡 输入在第一次启动服务器时提示,然后由VS Code安全存储。
"inputs": [
{
"type": "promptString",
"id": "circleci-token",
"description": "CircleCI API Token",
"password": true
},
{
"type": "promptString",
"id": "circleci-base-url",
"description": "CircleCI Base URL",
"default": "https://circleci.com"
}
],
"servers": {
// https://github.com/ppl-ai/modelcontextprotocol/
"circleci-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci@latest"],
"env": {
"CIRCLECI_TOKEN": "${input:circleci-token}",
"CIRCLECI_BASE_URL": "${input:circleci-base-url}"
}
}
}
}
在.vscode/mcp.json中使用Docker安装CircleCI MCP服务器:
{
// 💡 输入在第一次启动服务器时提示,然后由VS Code安全存储。
"inputs": [
{
"type": "promptString",
"id": "circle- ci-token",
"description": "CircleCI API Token",
"password": true
},
{
"type": "promptString",
"id": "circleci-base-url",
"description": "CircleCI Base URL",
"default": "https://circleci.com"
}
],
"servers": {
// https://github.com/ppl-ai/modelcontextprotocol/
"circleci-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"CIRCLECI_TOKEN",
"-e",
"CIRCLECI_BASE_URL",
"circleci:mcp-server-circleci"
],
"env": {
"CIRCLECI_TOKEN": "${input:circleci-token}",
"CIRCLECI_BASE_URL": "${input:circleci-base-url}"
}
}
}
}
在.vscode/mcp.json中使用自托管远程MCP服务器安装CircleCI MCP服务器:
{
"servers": {
"circleci-mcp-server-remote": {
"type": "sse",
"url": "http://your-circleci-remote-mcp-server-endpoint:8000/mcp"
}
}
}
在您的claude_desktop_config.json中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci@latest"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
要找到此文件的位置:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
在您的claude_desktop_config.json中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"CIRCLECI_TOKEN",
"-e",
"CIRCLECI_BASE_URL",
"circleci:mcp-server-circleci"
],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
要找到/创建此文件,请首先打开您的Claude Desktop设置。然后点击“设置”面板左侧栏中的“开发者”,然后点击“编辑配置”。
这将在以下位置创建一个配置文件:
有关使用MCP服务器与Claude Desktop的更多信息,请参阅以下指南: https://modelcontextprotocol.io/quickstart/user
首先创建一个包装脚本
创建一个名为'circleci-remote-mcp.sh'的脚本文件:
#!/bin/bash
export CIRCLECI_TOKEN="your-circleci-token"
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8000/mcp --allow-http
使其可执行:
chmod +x circleci-remote-mcp.sh
然后在您的claude_desktop_config.json中添加以下内容:
{
"mcpServers": {
"circleci-remote-mcp-server": {
"command": "/full/path/to/circleci-remote-mcp.sh"
}
}
}
要找到/创建此文件,请首先打开您的Claude Desktop设置。然后点击“设置”面板左侧栏中的“开发者”,然后点击“编辑配置”。
这将在以下位置创建一个配置文件:
有关使用MCP服务器与Claude Desktop的更多信息,请参阅以下指南: https://modelcontextprotocol.io/quickstart/user
安装Claude Code后,运行以下命令:
claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx -y @circleci/mcp-server-circleci@latest
安装Claude Code后,运行以下命令:
claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -e CIRCLECI_BASE_URL=https://circleci.com -- docker run --rm -i -e CIRCLECI_TOKEN -e CIRCLECI_BASE_URL circleci:mcp-server-circleci
有关使用MCP服务器与Claude Code的更多信息,请参阅以下指南: https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp
安装Claude Code后,运行以下命令:
claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8000/mcp --allow-http
有关使用MCP服务器与Claude Code的更多信息,请参阅以下指南: https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp
在您的windsurf mcp_config.json中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci@latest"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
在您的windsurf mcp_config.json中添加以下内容:
{
"mcpServers": {
"circleci-mcp-server": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"-e",
"CIRCLECI_TOKEN",
"-e",
"CIRCLECI_BASE_URL",
"circleci:mcp-server-circleci"
],
"env": {
ircleci-token": "your-circleci-token",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
}
}
}
}
在您的windsurf mcp_config.json中添加以下内容:
{
"mcpServers": {
"circleci": {
"command": "npx",
"args": [
"mcp-remote",
"http://your-circleci-remote-mcp-server-endpoint:8000/mcp",
"--allow-http"
],
"disabled": false,
"alwaysAllow": []
}
}
}
有关使用MCP服务器与windsurf的更多信息,请参阅以下指南: https://docs.windsurf.com/windsurf/mcp
要通过Smithery自动安装CircleCI MCP Server for Claude Desktop:
npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude
Amazon Q Developer CLI中的MCP客户端配置以JSON格式存储在一个名为mcp.json的文件中。
Amazon Q Developer CLI支持两个级别的MCP配置:
全局配置:~/.aws/amazonq/mcp.json - 应用于所有工作区
工作区配置:.amazonq/mcp.json - 特定于当前工作区
这两个文件都是可选的;可以不存在、存在一个或同时存在。如果两个文件都存在,Amazon Q Developer会从两个文件中读取MCP配置并将它们合并,取其内容的并集。如果有冲突(即,全局配置中定义的服务器也在工作区配置中),则会显示警告,并且只使用工作区配置中的服务器条目。
编辑您的全局配置文件~/.aws/amazonq/mcp.json或在当前工作区中创建一个新文件.amazonq/mcp.json,内容如下:
{
"mcpServers": {
"circleci-local": {
"command": "npx",
"args": [
"-y",
"@circleci/mcp-server-circleci@latest"
],
"env": {
"CIRCLECI_TOKEN": "YOUR_CIRCLECI_TOKEN",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
},
"timeout": 60000
}
}
}
首先创建一个包装脚本
创建一个名为'circleci-remote-mcp.sh'的脚本文件:
#!/bin/bash
export CIRCLECI_TOKEN="your-circleci-token"
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8000/mcp --allow-http
使其可执行:
chmod +x circleci-remote-mcp.sh
然后添加它:
q mcp add --name circleci --command "/full/path/to/circleci-remote-mcp.sh"
编辑您的全局配置文件~/.aws/amazonq/mcp.json或在当前工作区中创建一个新文件.amazonq/mcp.json,内容如下:
{
"mcpServers": {
"circleci-local": {
"command": "npx",
"args": [
"-y",
"@circleci/mcp-server-circleci@latest"
],
"env": {
"CIRCLECI_TOKEN": "YOUR_CIRCLECI_TOKEN",
"CIRCLECI_BASE_URL": "https://circleci.com" // 可选 - 仅针对内部客户
},
"timeout": 60000
}
}
}
首先创建一个包装脚本
创建一个名为'circleci-remote-mcp.sh'的脚本文件:
#!/bin/bash
npx mcp-remote http://your-circleci-remote-mcp-server-endpoint:8000/mcp --allow-http
使其可执行:
chmod +x circleci-remote-mcp.sh
然后将其添加到IDE中的Q Developer:
选择加号(+)符号。
选择范围:全局或本地。
如果您选择了全局范围,则MCP服务器配置将存储在~/.aws/amazonq/mcp.json中,并可在您所有的项目中使用。如果您选择了本地范围,则配置将存储在当前项目的.amazonq/mcp.json中。
在名称字段中,输入CircleCI远程MCP服务器的名称(例如circleci-remote-mcp)。
选择传输协议(stdio)。
在命令字段中,输入MCP服务器初始化时将运行的shell命令(例如/full/path/to/circleci-remote-mcp.sh)。
点击保存按钮。
get_build_failure_logs
从CircleCI构建中检索详细的失败日志。此工具可以通过三种方式使用:
使用项目别名和分支(推荐工作流程):
使用CircleCI URL:
使用本地项目上下文:
此工具返回格式化的日志,包括: