mcp-server-circleci

Official

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Integrates with CircleCI to retrieve build failure logs and identify flaky tests. Supports accessing logs via CircleCI URLs or local project context, and analyzing test execution history to detect unreliable tests in a project's test suite.

CircleCI MCP 서버

모델 컨텍스트 프로토콜(MCP)은 대규모 언어 모델(LLM)과 외부 시스템 간의 컨텍스트를 관리하기 위한 새로운 표준화된 프로토콜 입니다. 이 저장소에서는 CircleCI 용 MCP 서버를 제공합니다.

이를 통해 Cursor IDE나 모든 MCP 클라이언트를 사용하여 자연어를 사용하여 CircleCI로 작업을 수행할 수 있습니다.예:

https://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74

요구 사항

설치

커서

커서 MCP 구성에 다음을 추가하세요.

지엑스피1

커서와 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 아래 가이드를 참조하세요: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

클로드 데스크탑

claude_desktop_config.json에 다음을 추가하세요.

{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } } } }

이 파일을 찾거나 생성하려면 먼저 Claude 데스크톱 설정을 엽니다. 그런 다음 설정 창 왼쪽 막대에서 "개발자"를 클릭하고 "구성 편집"을 클릭합니다.

이렇게 하면 다음 위치에 구성 파일이 생성됩니다.

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Claude Desktop과 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 아래 가이드를 참조하세요: 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

Claude Code와 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 아래 가이드를 참조하세요. https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp

VS 코드

mcp -> servers 아래의 settings.json에 MCP 서버를 추가합니다.

"circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } }

VS Code와 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 아래 가이드를 참조하세요: https://code.visualstudio.com/docs/copilot/chat/mcp-servers

윈드서핑

windsurf mcp_config.json에 다음을 추가하세요.

{ "mcpServers": { "circleci-mcp-server": { "command": "npx", "args": ["-y", "@circleci/mcp-server-circleci"], "env": { "CIRCLECI_TOKEN": "your-circleci-token", "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - required for on-prem customers only } } } }

Windsurf와 함께 MCP 서버를 사용하는 방법에 대한 자세한 내용은 아래 가이드를 참조하세요: https://docs.windsurf.com/windsurf/mcp

특징

지원되는 도구

  • get_build_failure_logsCircleCI 빌드에서 자세한 실패 로그를 검색합니다. 이 도구는 두 가지 방법으로 사용할 수 있습니다.
    1. CircleCI URL 사용:
    2. 로컬 프로젝트 컨텍스트 사용:
      • 다음을 제공하여 로컬 작업 공간에서 작업합니다.
        • 작업 공간 루트 경로
        • Git 원격 URL
        • 지점 이름
      • 예: "현재 분기에서 가장 최근에 실패한 파이프라인 찾기"

    이 도구는 다음을 포함한 형식화된 로그를 반환합니다.

    • 직업 이름
    • 단계별 실행 세부 정보
    • 실패 메시지 및 컨텍스트

    이 기능은 특히 다음과 같은 경우에 유용합니다.

    • 실패한 빌드 디버깅
    • 테스트 실패 분석
    • 배포 문제 조사
    • IDE를 벗어나지 않고도 빌드 로그에 빠르게 액세스
  • find_flaky_tests테스트 실행 기록을 분석하여 CircleCI 프로젝트에서 불안정한 테스트를 식별합니다. 이 기능은 https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detection 에서 설명하는 불안정한 테스트 감지 기능을 활용합니다.이 도구는 두 가지 방법으로 사용할 수 있습니다.
    1. CircleCI 프로젝트 URL 사용:
    2. 로컬 프로젝트 컨텍스트 사용:
      • 다음을 제공하여 로컬 작업 공간에서 작업합니다.
        • 작업 공간 루트 경로
        • Git 원격 URL
      • 예: "현재 프로젝트에서 불안정한 테스트 찾기"

    이 도구는 다음을 포함하여 불안정한 테스트에 대한 자세한 정보를 반환합니다.

    • 테스트 이름 및 파일 위치
    • 실패 메시지 및 컨텍스트

    이것은 당신에게 도움이 됩니다:

    • 테스트 모음에서 신뢰할 수 없는 테스트 식별
    • 테스트 실패에 대한 자세한 컨텍스트를 얻으세요
    • 테스트 개선에 대한 데이터 기반 의사 결정

개발

시작하기

  1. 저장소를 복제합니다.
    git clone https://github.com/CircleCI-Public/mcp-server-circleci.git cd mcp-server-circleci
  2. 종속성 설치:
    pnpm install
  3. 프로젝트를 빌드하세요:
    pnpm build

MCP Inspector를 활용한 개발

MCP 서버에서 반복 작업을 수행하는 가장 쉬운 방법은 MCP 검사기를 사용하는 것입니다. MCP 검사기에 대한 자세한 내용은 https://modelcontextprotocol.io/docs/tools/inspector 에서 확인할 수 있습니다.

  1. 개발 서버를 시작합니다.
    pnpm watch # Keep this running in one terminal
  2. 별도의 터미널에서 검사기를 실행합니다.
    pnpm inspector
  3. 환경 구성:
    • 검사기 UI의 환경 변수 섹션에 CIRCLECI_TOKEN 추가합니다.
    • 토큰에는 CircleCI 프로젝트에 대한 읽기 액세스 권한이 필요합니다.
    • 선택적으로 CircleCI 기본 URL을 설정할 수 있습니다. 기본값은 https//circleci.com 입니다.

테스트

  • 테스트 모음을 실행합니다.
    pnpm test
  • 개발 중에 감시 모드에서 테스트를 실행합니다.
    pnpm test:watch

더 자세한 기여 지침은 CONTRIBUTING.md를 참조하세요.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

이 MCP 서버를 사용하면 Cursor IDE 또는 MCP 클라이언트가 활성화된 에이전트를 사용하여 자연어를 사용하여 CircleCI에서 작업을 수행할 수 있습니다. 예: 내 브랜치에서 실패한 최신 파이프라인을 찾고 로그를 가져옵니다.

  1. Requirements
    1. Installation
      1. Cursor
      2. Claude Desktop
      3. Claude Code
      4. VS Code
      5. Windsurf
    2. Features
      1. Supported Tools
    3. Development
      1. Getting Started
      2. Development with MCP Inspector
      3. Testing
    ID: 65ardm1kp6