Portainer MCP Server

Portainer MCP サーバー

Portainer の API を通じて AI アシスタントが Docker コンテナやサービスを操作できるようにする、Portainer 向けの Model Context Protocol（MCP）サーバーの実装です。

機能

• Docker コンテナの管理（作成、起動、削除、ログの取得）
• Docker イメージの管理（取得、未使用のイメージの削除、ビルドキャッシュの消去）
• Docker ネットワーク操作（詳細の確認、取得）
• Docker サービスの管理（取得、ログの取得）
• コンテナのリソース制限の管理

プロジェクト構成

portainer-ce-mcp/
├── src/
│   ├── api/
│   │   └── portainer.ts      # Portainer API integration
│   ├── constants/
│   │   └── index.ts          # Tool names and other constants
│   ├── types/
│   │   └── index.ts          # TypeScript type definitions
│   └── main.ts               # Main server implementation
├── package.json              # Project dependencies
├── package-lock.json         # Dependency lock file
├── deno.json                 # Deno configuration
└── README.md                 # Project documentation

前提条件

• Deno
• API にアクセスできる Portainer インスタンス
• Docker がインストールされ、実行中であること

インストール

1. リポジトリをクローンします。

git https://github.com/BirajMainali/poratiner-ce-mcp-server.git
cd portainer-ce-mcp

設定

サーバーには以下の環境変数が必要です。

• PORTAINER_URL：Portainer インスタンスの URL
• PORTAINER_API_KEY：Portainer API キー
• PORTAINER_ENV_ID：Poratiner Environment Id

API ツール

サーバーは AI アシスタント向けに以下のツールを提供します。

コンテナ管理

• FETCH_DOCKER_CONTAINERS：すべてのコンテナを一覧表示
• CREATE_DOCKER_CONTAINER：新しいコンテナを作成
• START_DOCKER_CONTAINER：コンテナを起動
• DELETE_DOCKER_CONTAINER：コンテナを削除
• FETCH_CONTAINER_LOGS：コンテナのログを取得
• UPDATE_CONTAINER_RESOURCE_LIMITS：コンテナのリソースを更新
• DELETE_STOPPED_CONTAINERS：停止中のコンテナを整理

イメージ管理

• FETCH_IMAGES：すべてのイメージを一覧表示
• DELETE_IMAGE_BUILD_CACHE：ビルドキャッシュを消去
• DELETE_UNUSED_IMAGES：未使用のイメージを削除

ネットワーク操作

• FETCH_NETWORKS：すべてのネットワークを一覧表示
• INSPECT_NETWORK：ネットワークの詳細を取得

サービス管理

• FETCH_SERVICES：すべてのサービスを一覧表示
• FETCH_SERVICE_LOG：サービスのログを取得

開発

ビルド

deno compile --allow-env --allow-read --allow-net --env-file=.env  src/main.ts

MCP サーバーを検査

npx @modelcontextprotocol/inspector deno run --allow-env --allow-read --allow-net --env-file=.env  src/main.ts

MCP 設定

{
  "mcpServers": {
    "poratiner": {
      "command": "C:\\MCP\\portainer-ce-mcp\\src.exe", // use executable path
      "args": [
        "y"
      ]
    }
  }
}

ライセンス

MIT

貢献

1. リポジトリをフォークします
2. 機能ブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します