Skip to main content

Portainer MCP server — manage Docker, Kubernetes, stacks, and Helm via the Model Context Protocol.

Project description

Portainer MCP

Official MCP server for Portainer, generated from the Portainer OpenAPI spec via FastMCP.

Overview

This MCP server exposes the Portainer REST API as MCP tools: list and inspect environments, manage GitOps workflows, troubleshoot Docker and Kubernetes resources. It also supports proxying requests to the underlying Docker and K8s APIs of each environment.

Match the MCP server's minor version to your Portainer instance's minor — e.g. MCP server 2.42.x with Portainer 2.42.x. See Version compatibility for details.

Getting started

The MCP server can be executed locally via uvx or as a container.

Use the first approach to explore the MCP capabilities locally and deploy it inside your infrastructure as a container for a team based deployment setup.

[!NOTE] Before using the MCP, make sure to generate an API key in Portainer under My Account → Access tokens first as both paths need it.

Single user (stdio via uvx)

The recommended way to test the MCP server locally. Runs as a stdio process on your machine and connects directly to the Portainer instance.

[!NOTE] uv must be installed and available on PATH. See the uv install docs.

Set PORTAINER_TLS_VERIFY=0 if your Portainer instance uses self-signed TLS certificates.

Register with Claude Code:

claude mcp add portainer \
  -e PORTAINER_URL=https://portainer.example.com \
  -e PORTAINER_API_KEY=ptr_xxxxxxxxxxxxxxxx \
  -- uvx --from "mcp-portainer~=2.42.0" mcp-portainer

For other clients, see docs/distribution/.

Claude Desktop (one-click bundle)

Each release ships a self-contained .mcpb bundle per platform — no uv or Python required. Download the one for your platform, double-click to install, and enter your Portainer URL and API key. See docs/distribution/claude-desktop.md (the bundles are not yet code-signed, so it documents a one-time Gatekeeper/SmartScreen step). Contributions for other client instructions are welcome!

Team deployment (container)

The recommended way to have multiple users interacting with your Portainer instance via MCP. Deployed as a container inside your infrastructure, accessed by users from their workstations over HTTPS. A shared secret gates the MCP server and every client also forwards its own Portainer API key so that each user acts under their own Portainer identity.

[!IMPORTANT] Both the gate secret and each user Portainer API key are sent across the wire. The container deployment requires you to declare a transport posture: bring your own TLS certificates, attest a TLS-terminating reverse proxy setup or explicitly opt-in to plaintext.

Plaintext is a deliberate, dangerous choice — see the three options below.

It is NOT recommended to expose this MCP server on the public internet, host it inside your private infrastructure even behind a TLS proxy.

See more info below about the different deployment scenarios. For any of these scenarios:

  • Set PORTAINER_MCP_ALLOWED_HOSTS to the hostname or IP address that users will use to reach the MCP — otherwise the DNS-rebinding allowlist 421-rejects the request.
  • PORTAINER_MCP_AUTH_TOKEN is required in HTTP mode. It's the shared front-gate secret you distribute to your users; their MCP client sends it via the Authorization header. It only admits the request — what each user can do is governed by their own Portainer API key.

Option A - BYO certificates

[!NOTE] The server will warn if using self-signed certificates. Using a private CA cert won't warn, but in both cases you will likely need to jump through some hoops to configure the MCP clients to accept it.

Deploy the container to use your own set of TLS certificates:

TOKEN=$(openssl rand -hex 32)
docker run -d --name portainer-mcp -p 17717:17717 \
	-v /etc/portainer-mcp/tls:/tls:ro \
	-e PORTAINER_URL=https://portainer.example.com \
	-e PORTAINER_MCP_AUTH_TOKEN="$TOKEN" \
	-e PORTAINER_MCP_ALLOWED_HOSTS=mcp.example.com:17717 \
	-e PORTAINER_MCP_TLS_CERT=/tls/cert.pem \
	-e PORTAINER_MCP_TLS_KEY=/tls/key.pem \
	portainer/portainer-mcp:2.42

Then connect your client:

claude mcp add portainer --transport http https://mcp.example.com:17717/mcp \
  --header "Authorization: Bearer <gate-token>" \
  --header "X-Portainer-API-Key: <ptr_user_key>"

Option B - TLS-terminated reverse proxy

[!NOTE] Don't publish the container port when using a reverse proxy in front of the MCP container, only the proxy should be able to reach it.

Use your proxy exact IP if stable for PORTAINER_MCP_FORWARDED_ALLOW_IPS.

Make sure that your proxy forwards the original Host and the X-Forwarded-Proto: https headers.

BYO proxy and set up a TLS-terminated proxy in front of the container:

TOKEN=$(openssl rand -hex 32)
docker run -d --name portainer-mcp \
	-e PORTAINER_URL=https://portainer.example.com \
	-e PORTAINER_MCP_AUTH_TOKEN="$TOKEN" \
	-e PORTAINER_MCP_ALLOWED_HOSTS=mcp.example.com \
	-e PORTAINER_MCP_TRUST_PROXY_TLS=1 \
	-e PORTAINER_MCP_FORWARDED_ALLOW_IPS=172.18.0.0/16 \
	portainer/portainer-mcp:2.42

Then connect your client:

claude mcp add portainer --transport http https://mcp.example.com/mcp \
  --header "Authorization: Bearer <gate-token>" \
  --header "X-Portainer-API-Key: <ptr_user_key>"

Option C - Plaintext HTTP

[!WARNING] It is NOT recommended to use this outside of a trusted private network deployment.

Use the PORTAINER_MCP_DANGEROUSLY_ALLOW_PLAINTEXT_HTTP=1 flag to start the server with HTTP only.

TOKEN=$(openssl rand -hex 32)
docker run -d --name portainer-mcp -p 17717:17717 \
	-e PORTAINER_URL=https://portainer.example.com \
	-e PORTAINER_MCP_AUTH_TOKEN="$TOKEN" \
	-e PORTAINER_MCP_ALLOWED_HOSTS=mcp.example.com:17717 \
	-e PORTAINER_MCP_DANGEROUSLY_ALLOW_PLAINTEXT_HTTP=1 \
	portainer/portainer-mcp:2.42

Then connect your client:

claude mcp add portainer --transport http http://mcp.example.com:17717/mcp \
  --header "Authorization: Bearer <gate-token>" \
  --header "X-Portainer-API-Key: <ptr_user_key>"

Restricting and expanding the MCP server capabilities

The MCP server comes with the following capabilities enabled by default:

  • Basic Portainer operation support (settings, version, environments...)
  • Docker operation support
  • Kubernetes operation support
  • Docker and Kubernetes proxy support
  • Redacting environment variables values (enabled by default)

For restricting or expanding this set of capabilities, see docs/profiles.md.

Version compatibility

Match the MCP server's minor to your Portainer minor. The major+minor tracks the Portainer API version the embedded spec targets.

Server version Portainer (CE / EE)
2.42.x 2.42.x
2.41.x 2.41.x

For more information about the versioning policy, see docs/versioning.md.

Configuration

The MCP server exposes different capabilities such as:

  • Enable different set of tools based on specific profile configuration
  • Widen the API coverage by specifying extra tags to cover
  • Expose only read-only capabilities
  • Disable proxy capabilities
  • Tuning the transport capabilities and configuring the TLS posture
  • Logging configuration

For more information about the MCP server configuration, refer to docs/configuration.md.

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

mcp_portainer-2.42.6.tar.gz (287.1 kB view details)

Uploaded Source

Built Distribution

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

mcp_portainer-2.42.6-py3-none-any.whl (155.0 kB view details)

Uploaded Python 3

File details

Details for the file mcp_portainer-2.42.6.tar.gz.

File metadata

  • Download URL: mcp_portainer-2.42.6.tar.gz
  • Upload date:
  • Size: 287.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for mcp_portainer-2.42.6.tar.gz
Algorithm Hash digest
SHA256 7ea2c2b185eecfbac2c72428366acdbedb65dde05632cdd500156dd3f464feae
MD5 72c825017afb34828fdf7cf236406833
BLAKE2b-256 3f26de5df66e48902a55eca8ee0bfd9c6bb76d072e9fd77fe6ce96c547446ccd

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_portainer-2.42.6.tar.gz:

Publisher: release.yml on portainer/portainer-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_portainer-2.42.6-py3-none-any.whl.

File metadata

  • Download URL: mcp_portainer-2.42.6-py3-none-any.whl
  • Upload date:
  • Size: 155.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for mcp_portainer-2.42.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5bb1930e6f9f10af97e51edfdb6b771b4a3b35ebf74a021eec48fc7c2d3936da
MD5 019911aea6617ed2b81640ac7d4dba4e
BLAKE2b-256 4e8c1cd21dcdb382b7766d4522ee62ecc1e28f6678fd4b2f65cae4a32ade4b05

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_portainer-2.42.6-py3-none-any.whl:

Publisher: release.yml on portainer/portainer-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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