Skip to main content

A FastMCP-based MCP server for DevOps

Project description

DevOps MCP Server

A FastMCP-based MCP server providing DevOps tools and integrations.

Features

  • GitHub repository search and management
  • File content retrieval from repositories
  • Issue tracking and management
  • Code search functionality

Installation

To install the package, use the following command:

pip install devops-mcps

Usage

Run the MCP server:

devops-mcps

Configuration

Environment Variables

Set the required environment variable for GitHub API access:

export GITHUB_PERSONAL_ACCESS_TOKEN=your_token_here

JSON Configuration

Create a config.json file:

{
  "github": {
    "access_token": "your_token_here",
    "api_url": "https://api.github.com"
  },
  "server": {
    "port": 8000,
    "debug": false
  }
}

UVX Configuration

Install UVX tools:

uvx install

Run with UVX:

uvx run devops-mcps

Transport Configuration

The MCP server supports two transport types:

  • stdio (default): Standard input/output communication
  • sse: Server-Sent Events for HTTP-based communication

Local Usage

# Default stdio transport
devops-mcps

# SSE transport
devops-mcps --transport sse

UVX Usage

# Default stdio transport
uvx run devops-mcps

# SSE transport
uvx run devops-mcps-sse

Docker Configuration

Build the Docker image:

docker build -t devops-mcps .

Run the container:

docker run -p 8000:8000 devops-mcps

VSCode Configuration

To use this MCP server in vs code copilot, there are 2 ways to configure it in VSCode settings.json with different transport types:

UVX Configuration

stdio Transport (default)

"devops-mcps": {
  "type": "stdio",
  "command": "uvx",
  "args": ["devops-mcps"],
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxCe"
  }
}

SSE Transport

"devops-mcps": {
  "type": "sse",
  "command": "uvx",
  "args": ["devops-mcps-sse"],
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxxCe"
  }
}

Docker Configuration

stdio Transport (default)

"devops-mcps": {
  "command": "docker",
  "args": [
    "run",
    "-i",
    "huangjien/devops-mcps:latest"
  ],
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxx2Ce"
  }
}

SSE Transport (MCP Server Deployed in Remote Docker Container)

"devops-mcps": {
  "type": "sse",
  "url": "http://[remote ip address]:8000/sse",
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_xxxxxxxxxxxxxxxxxxxxxxxxx2Ce"
  }
}

Development

Install development dependencies:

pip install -e .[dev]

Run mcp inspector to test or debug:

npx @modelcontextprotocol/inspector uv run devops-mcps

CI/CD Pipeline

GitHub Actions workflow will automatically:

  1. Build and publish Python package to PyPI
  2. Build and push Docker image to Docker Hub

Required Secrets

Set these secrets in your GitHub repository:

  • PYPI_API_TOKEN: Your PyPI API token
  • DOCKER_HUB_USERNAME: Your Docker Hub username
  • DOCKER_HUB_TOKEN: Your Docker Hub access token

Workflow triggers on push to main branch.

Packaging and Publishing

Install tools

pip install -U twine build  

Build the package

python -m build

Upload to PyPI

  1. Create a ~/.pypirc file with your API token:
[pypi]
username = __token__
password = your_pypi_api_token_here
  1. Upload the package:
twine upload dist/*

Important Notes

  • Ensure all classifiers in pyproject.toml are valid PyPI classifiers
  • Remove deprecated license classifiers in favor of SPDX license expressions
  • The package will be available at: https://pypi.org/project/devops-mcps/
  • Update the version everytime, or when you push, it will show an error: already exists.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devops_mcps-0.2.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

devops_mcps-0.2.2-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file devops_mcps-0.2.2.tar.gz.

File metadata

  • Download URL: devops_mcps-0.2.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for devops_mcps-0.2.2.tar.gz
Algorithm Hash digest
SHA256 9d6b5f151cbed1311499b85c2a9ce4be8eca25766a5e267252da1abf1354f84b
MD5 ac2bde6cc79cc12dd9260c5216adacdb
BLAKE2b-256 9425c1ab5335234dbde240d56c611733ac7aa55f669790232ab41724c71ed71e

See more details on using hashes here.

File details

Details for the file devops_mcps-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: devops_mcps-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for devops_mcps-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27735169bdc87864072ce5cf7d8f1855f73019574d193b546510e32c8112855f
MD5 1afe556a909858813efd876e92d8bbc0
BLAKE2b-256 4461d997ce7b6864748559c47b92439b858224b3b0694f930b879aec9eb0d01f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page