Portainer MCP Server

Portainer MCP 服务

Portainer 的模型上下文协议（MCP）服务实现，可通过 Portainer API 让 AI 助手与 Docker 容器和服务交互。

功能

• 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. Fork 仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到该分支（git push origin feature/amazing-feature）
5. 发起 Pull Request