Cycloid

Cycloid MCP サーバー

Cycloid プラットフォームとシームレスに連携し、AI アシスタントが自然言語を通じて Cycloid のインフラ管理機能を利用できるようにする、Model Context Protocol（MCP）サーバーです。

概要

Cycloid MCP サーバーは、AI アシスタントと Cycloid の強力なインフラ自動化プラットフォームをつなぎます。次のことが可能になります。

• 利用可能なブループリントとサービスカタログを検出し、調べる
• Cycloid のブループリントを使用して、インフラストラクチャスタックを 作成および管理する
• AI アシスタントを通じて、複雑なインフラストラクチャのワークフローを 自然に操作する
• Infrastructure as Code と自動化に関する Cycloid の専門知識を 活用する

利用可能なツール

• CYCLOID_BLUEPRINT_LIST：利用可能なすべてのブループリントを詳細とともに一覧表示します
• CYCLOID_BLUEPRINT_STACK_CREATE：対話型の情報入力を使って、ブループリントからスタックを作成します
• CYCLOID_STACKFORMS_VALIDATE：StackForms の設定ファイルを検証します
• CYCLOID_CATALOG_REPO_LIST：サービスカタログのリポジトリを一覧表示します
• CYCLOID_EVENT_LIST：任意のフィルター（begin、end、severity、type）を指定して、組織のイベントを一覧表示します
• CYCLOID_PIPELINE_LIST：Cycloid のすべてのパイプラインを一覧表示します

利用可能なリソース

• cycloid://blueprints：ブループリント情報にアクセスします
• cycloid://service-catalogs-repositories：サービスカタログのリポジトリ情報にアクセスします
• cycloid://events：最近の組織イベントに JSON 形式でアクセスします
• cycloid://pipelines：パイプライン情報にアクセスします

イベントフィルター

• begin/end：対象期間を区切る Unix タイムスタンプ（文字列）
• severity：info、warn、err、crit のいずれか、または複数
• type：Cycloid、AWS、Monitoring、Custom のいずれか、または複数

アーキテクチャ

このサーバーでは、FastMCP の MCPMixin に基づく動的なコンポーネント登録システムを使用しています。

• 自動検出：コンポーネントは src/components/ から自動的に検出されます
• ファイルベースの構成：コンポーネントは機能ごとに整理されています（catalogs/、stacks/）
• 標準パターン：各コンポーネントは *_tools.py、*_resources.py、*_handlers.py、*_prompts.py のパターンに従います
• MCPMixin の統合：FastMCP に組み込まれた register_all() メソッドを使用して、ツールとリソースを適切に登録します

HTTP トランスポート

Cycloid MCP サーバーは、HTTP トランスポートを使用するウェブサービスとして動作します。マルチテナントでの利用を可能にするため、組織と API キーはリクエストごとに HTTP ヘッダー（X-CY-ORG と X-CY-API-KEY）で指定します。

使用方法： python server.py

クイックスタート

前提条件

• Python 3.12 以降
• uv パッケージマネージャー（推奨）
• Docker（本番環境へのデプロイ用）
• 有効な Cycloid API 認証情報

開発環境のセットアップ

# Clone and setup
git clone <repository-url>
cd cycloid-mcp-server
make setup

# Run development server
make dev-server

本番環境のセットアップ

ビルド済み Docker イメージを使用する

このプロジェクトでは、Docker Hub を通じてビルド済み Docker イメージを提供しています。

# Pull the latest image
docker pull cycloid/cycloid-mcp-server:latest

# Run the server
docker run -p 8010:8010 cycloid/cycloid-mcp-server:latest

ローカルでビルドする

# Build Docker image
make build

# Run production server
make prod-server

MCP の設定

MCP サーバー設定の詳細な例については、mcp-examples.md を参照してください。

利用可能なコマンド

# Development Environment
make setup          # Setup development environment with uv
make install        # Install dependencies
make help           # Show all available commands
make validate-env   # Validate local environment matches CI

# Development Server
make dev-server     # Run development server using Python virtual environment

# HTTP Server
python server.py  # Run HTTP server

# Production
make build          # Build Docker image
make prod-server    # Run production server using Docker

# Testing and Quality
make test           # Run all tests
make type-check     # Run pyright type checking
make lint           # Run PEP 8 linting with flake8
make format         # Format code with black and isort
make quality-check  # Run all quality checks (tests + type checking + linting)
make simulate-ci    # Validate environment and run quality checks

# Cleanup
make clean          # Clean up development artifacts
make clean-docker   # Clean up Docker artifacts

貢献

開発ガイドラインの詳細については、CONTRIBUTING.md を参照してください。

ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。