OpenZiti Network Management

io.github.openziti由 GitHub 帳號 openziti 發布v0.11.0更新於 Oct 24, 2026

Manage OpenZiti zero-trust networks — through natural language

概覽

AI 產生的概覽

一個本機 MCP 伺服器,讓 AI 助理用自然語言管理 OpenZiti 零信任網路,從查看身分到建立原則。

可以做什麼
登入、登出、列出並切換 Ziti 網路設定檔,並在執行階段完成裝置授權登入;這些中繼工具一律可用,即使其他工具被過濾。管理身分、服務、設定與設定類型、驗證原則、驗證器、憑證授權單位、外部 JWT 簽署者、態勢檢查與註冊。管理邊緣路由器、路由器、中轉路由器、終結器、邊緣路由器原則、服務邊緣路由器原則與服務原則,包括撥號與綁定關係。檢視和修改控制器設定、控制器與系統資訊、工作階段與 API 工作階段以及身分類型。操作 fabric 層,包括新增、查詢、修改、刪除、電路、連結、叢集與資料庫快照。
適用情境
當你管理一個或多個 OpenZiti 網路,希望助理回答關於身分、服務、路由器和原則的問題,或執行建立身分、建立綁定原則等日常管理任務時使用。既適合互動式探索,也適合預先設定好設定檔的自動化情境。
執行需求
以本機程序形式在使用者機器上執行;提供 macOS、Linux 和 Windows 的預先編譯二進位檔,也可用 Go 1.24+ 從原始碼建置。需要 Claude Desktop 等 MCP 用戶端,以及帶控制器的 OpenZiti 網路。必須驗證:UPDB 使用者名稱和密碼、裝置授權、OAuth2 用戶端憑證,或用於 mTLS 的 Ziti 身分 JSON 檔案。憑證保存在使用者主目錄下的設定檔中。
安裝前請注意
此伺服器可以建立、修改和刪除網路資源,包括身分、原則、路由器和工作階段;可用唯讀旗標或工具模式限制暴露範圍。密碼、用戶端密鑰和憑證材料等憑證保存在本機設定檔中,使用完畢後應登出。身分檔案中的憑證材料會被複製到該設定檔。請審閱驗證過程中要求的權限。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 OpenZiti Network Management,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

[OpenZiti MCP Server Banner]

🚀 Getting Started • 🕸️ Architecture • 🔐 Authentication • 🛠️ Supported Tools • 🔒 Security • 🩺 Troubleshooting • 📋 Debug Logs • 👨‍💻 Development

The Ziti MCP Server is sponsored by NetFoundry as part of its portfolio of solutions for secure workloads and agentic computing. NetFoundry is the creator of OpenZiti and zrok.

MCP (Model Context Protocol) is an open protocol introduced by Anthropic that standardizes how large language models communicate with external tools, resources or remote services.

The Ziti MCP Server integrates with LLMs and AI agents, allowing you to perform various Ziti network management operations using natural language. For instance, you could simply ask Claude Desktop to perform Ziti management operations:

  • List which identities exist

  • Tell me if there are any exposures in the network

  • Do you see potential misconfigurations?

  • Which identities have access to the Demo1 service?

  • Create a new Ziti identity named "Demo" and get its ID

  • Log into my prod Ziti network using UPDB

  • Switch to the staging network

  • etc.


🚀 Getting Started

Prerequisites:


Install

Download a pre-built binary

Pre-built binaries are available for macOS, Linux, and Windows (amd64 and arm64) on the releases page.

macOS (Apple Silicon)

bash
curl -sL https://github.com/openziti/ziti-mcp-server/releases/latest/download/ziti-mcp-server_darwin_arm64.tar.gz | tar xzsudo mv ziti-mcp-server /usr/local/bin/

macOS (Intel)

bash
curl -sL https://github.com/openziti/ziti-mcp-server/releases/latest/download/ziti-mcp-server_darwin_amd64.tar.gz | tar xzsudo mv ziti-mcp-server /usr/local/bin/

Linux (amd64)

bash
curl -sL https://github.com/openziti/ziti-mcp-server/releases/latest/download/ziti-mcp-server_linux_amd64.tar.gz | tar xzsudo mv ziti-mcp-server /usr/local/bin/

Linux (arm64)

bash
curl -sL https://github.com/openziti/ziti-mcp-server/releases/latest/download/ziti-mcp-server_linux_arm64.tar.gz | tar xzsudo mv ziti-mcp-server /usr/local/bin/

Windows

Download the appropriate .zip from the releases page and add the extracted ziti-mcp-server.exe to your PATH.

Build from source
bash
go install github.com/openziti/ziti-mcp-server/cmd/ziti-mcp-server@latest

Register with your AI Client

Use install to register the Ziti MCP Server with your AI client. This only updates the client's configuration file — it does not authenticate. Use the runtime login tools or init for that.

bash
# Register with Claude Desktop (default)ziti-mcp-server install
# Register with a specific clientziti-mcp-server install --client claude-codeziti-mcp-server install --client cursorziti-mcp-server install --client windsurfziti-mcp-server install --client vscodeziti-mcp-server install --client warp
# Register with read-only tools onlyziti-mcp-server install --read-only
# Register with specific tool patternsziti-mcp-server install --tools '*Identit*,list*'

After installing, restart your AI client and use the runtime login tools to authenticate (e.g., ask: "Log into my Ziti network at ctrl.example.com with username admin").

Start and Log In

The server can start with no prior configuration. The AI agent can log into networks at runtime using the built-in login tools:

bash
ziti-mcp-server run

Then in your AI client, simply ask:

Log into my Ziti network at 192.168.1.100:1280 with username admin and password admin

For non-interactive or automated setups, use init to pre-configure credentials before starting:

bash
ziti-mcp-server init \  --auth-mode updb \  --ziti-controller-host <your-controller-host> \  --username <username> \  --password <password> \  --profile prod

See Authentication for all supported modes (UPDB, device auth, client credentials, identity file).

Manual Client Configuration

The install command handles client configuration automatically. If you need to configure an MCP client manually, add this to its configuration and restart:

json
{  "mcpServers": {    "ziti": {      "command": "/path/to/ziti-mcp-server",      "args": ["run"],      "capabilities": ["tools"],      "env": {        "OPENZITI_MCP_DEBUG": "true"      }    }  }}

You can add --tools '<pattern>' and/or --read-only to the args array to control which tools are available. See Restricting Tool Access.

Verify your integration

Restart your MCP Client (Claude Desktop, Windsurf, Cursor, Warp, etc.) and ask it to help you manage your Ziti network.

🕸️ Architecture

The Ziti MCP Server implements the Model Context Protocol, allowing clients (like Claude) to:

  1. Request a list of available Ziti tools
  2. Call specific tools with parameters
  3. Receive structured responses from the Ziti Management API

The server handles authentication, request validation, and secure communication with the Ziti Management API.

[!NOTE] The server operates as a local process that connects to Claude Desktop, enabling secure communication without exposing your Ziti credentials.

🔐 Authentication

The Ziti MCP Server uses the Ziti Management API and requires authentication to access your Ziti network.

Authentication Modes

The server supports four authentication modes:

UPDB Mode (Username/Password)

Use this mode for direct username/password authentication against the Ziti controller:

bash
ziti-mcp-server init \  --auth-mode updb \  --ziti-controller-host <your-controller-host> \  --username <username> \  --password <password>

Or at runtime via the AI agent using the loginUpdb tool.

Device Auth Mode (Interactive Login)

Use this mode for interactive browser-based login. Recommended for development and user-facing scenarios:

bash
ziti-mcp-server init \  --auth-mode device-auth \  --ziti-controller-host <your-controller-host> \  --idp-domain <your-idp-domain> \  --idp-client-id <your-client-id> \  --idp-audience <your-audience>

Or at runtime via the loginDeviceAuth tool (returns a verification URL for the user, then completeLogin to finish).

Client Credentials Mode (Service Account)

Use this mode for service accounts and automation. Recommended for production environments:

[!NOTE] Keep the token lifetime as minimal as possible to reduce security risks. See more

bash
ziti-mcp-server init \  --auth-mode client-credentials \  --ziti-controller-host <your-controller-host> \  --idp-domain <your-idp-domain> \  --idp-client-id <your-client-id> \  --idp-client-secret <your-client-secret>
Identity File Mode (mTLS Certificate)

Use this mode for certificate-based authentication with a Ziti identity JSON file. No IdP configuration is needed:

bash
ziti-mcp-server init \  --auth-mode identity \  --identity-file <path-to-identity.json>

The identity file is a standard Ziti identity JSON file containing ztAPI, id.cert, id.key, and id.ca fields. The certificate material is extracted and stored in the config file. The identity file may be deleted after a successful init (for additional security, if desired).

[!IMPORTANT]

When using CLI init, it needs to be run whenever:

  • You're setting up the MCP Server for the first time
  • You've logged out from a previous session
  • You want to switch to a different Ziti network
  • Your token has expired

Alternatively, use the runtime login tools (loginUpdb, etc.) to authenticate without restarting the server.

Multi-Profile Support

The server supports multiple named network profiles, allowing you to manage several Ziti networks simultaneously:

bash
# Pre-configure two profilesziti-mcp-server init --auth-mode updb --profile prod ...ziti-mcp-server init --auth-mode updb --profile staging ...
# Start with a specific profile activeziti-mcp-server run --profile prod

At runtime, the AI agent can:

  • Log into additional networks using loginUpdb, loginIdentity, etc.
  • List all networks using listNetworks
  • Switch between networks using selectNetwork
  • Log out from a network using logout

Credentials are stored in ~/.config/ziti-mcp-server/config.json with 0600 permissions.

Session Management

To see information about your current authentication session:

bash
ziti-mcp-server sessionziti-mcp-server session --profile prod

Logging Out

bash
ziti-mcp-server logoutziti-mcp-server logout --profile prod

Or at runtime via the AI agent using the logout tool.

🛠️ Supported MCP Tools

The Ziti MCP Server provides 201 Ziti API tools plus 8 meta-tools for managing your Ziti network through natural language. Tools are organized by resource type.

Tip: Use --read-only or --tools patterns to expose only the tools you need. See Restricting Tool Access.

Meta-Tools (Network Management)

These tools are always available regardless of --tools or --read-only filtering.

ToolDescription
loginUpdbConnect using username/password authentication
loginIdentityConnect using a Ziti identity JSON (mTLS certificate)
loginClientCredentialsConnect using OAuth2 client credentials
loginDeviceAuthStart OAuth2 device auth flow (returns verification URL)
completeLoginComplete a pending device-auth login after browser approval
logoutDisconnect from a Ziti network (clear profile credentials)
listNetworksList all configured network profiles with connection status
selectNetworkSwitch the active network profile

Tool Categories

CategoryToolsDescription
Identities22CRUD, relationships, lifecycle, posture, tracing
Services12CRUD and relationship queries
Edge Routers11CRUD, relationships, re-enrollment
Edge Router Policies7CRUD and relationship queries
Service Edge Router Policies7CRUD and relationship queries
Service Policies8CRUD and relationships (Dial/Bind)
Configs6CRUD and service relationships
Config Types6CRUD and config queries
Auth Policies5CRUD (primary/secondary auth settings)
Authenticators5CRUD (updb/cert)
Certificate Authorities7CRUD, JWT retrieval, verification
External JWT Signers5CRUD for external JWT signers
Posture Checks8CRUD, types, and role attributes
Routers5CRUD for fabric routers
Transit Routers5CRUD for transit routers
Terminators5CRUD for terminators
Enrollments5CRUD and refresh
Controller Settings6CRUD and effective value queries
Controllers & System Info4Version, capabilities, summary
Sessions & API Sessions6List, detail, delete
Identity Types2List and detail
Fabric (Routers, Services, …)34Fabric-layer CRUD, circuits, links, cluster, DB snapshots

See docs/tools.md for the full tool reference with detailed tables and example prompts.

Example Prompts

  • Show me all Ziti identities
  • Which identities have access to the Demo1 service?
  • Create a new identity called 'demo-admin' and make it an admin
  • List all edge routers and their status
  • Show me all Dial service policies
  • What version is the Ziti controller running?
  • Give me a summary of the network — how many identities, services, and routers exist?
  • Create a Bind policy for the 'my-api' service

🔒 Security

Restricting Tool Access

When configuring the Ziti MCP Server, limit tool access based on your specific needs:

bash
# Enable only read-only operationsziti-mcp-server run --read-only
# Alternative way to enable only read-only operationsziti-mcp-server run --tools 'list*,get*'
# Limit to just identity-related toolsziti-mcp-server run --tools '*Identit*'
# Limit to read-only identity-related toolsziti-mcp-server run --tools '*Identit*' --read-only
# Run the server with all tools enabledziti-mcp-server run --tools '*'

[!IMPORTANT] When both --read-only and --tools flags are used together, the --read-only flag takes priority for security. Meta-tools (login, logout, listNetworks, selectNetwork) are always available regardless of filtering.

This approach offers several important benefits:

  1. Enhanced Security: Limiting available tools reduces the potential attack surface.
  2. Better Performance: Fewer tools means less context window usage for tool reasoning.
  3. Resource-Based Access Control: Configure different instances with different tool sets.
  4. Simplified Auditing: Easier to track which operations were performed.

Credential Storage

  • Credentials are stored in ~/.config/ziti-mcp-server/config.json with 0600 permissions
  • The config file is never world-readable
  • Authentication supports OAuth 2.0 device authorization, client credentials, mTLS certificates, and UPDB
  • Easy credential removal via logout command or tool

[!IMPORTANT] For security best practices, always log out when you're done with a session or switching between networks.

[!CAUTION] Always review the permissions requested during the authentication process to ensure they align with your security requirements.

Security Scanning

We recommend regularly scanning this server with community tools built to surface protocol-level risks:

  • mcpscan.ai — Web-based scanner for MCP endpoints
  • mcp-scan — CLI tool for evaluating server behavior

Reporting Issues

To provide feedback or report a bug, please raise an issue on our issue tracker.

🩺 Troubleshooting

Start troubleshooting by exploring all available commands and options:

bash
ziti-mcp-server help

🚨 Common Issues

  1. Authentication Failures

    • Ensure you have the correct permissions in your Ziti network
    • Try re-initializing with ziti-mcp-server init --auth-mode <mode> ...
    • Or use the runtime login tools to re-authenticate
  2. TLS Certificate Errors

    • The server auto-fetches the controller's CA on login via the EST /cacerts endpoint
    • If the CA fetch fails, add the controller CA to your system trust store
    • Or re-login to trigger a fresh CA fetch
  3. Client Can't Connect to the Server

    • Restart your MCP client after configuration changes
    • Check that the binary path in the client config is correct
  4. Invalid Configuration Error

    • This typically happens when no profile is active or credentials are missing
    • Use listNetworks to check profile status
    • Use a login tool or ziti-mcp-server init to authenticate

[!TIP] Most connection issues can be resolved by restarting both the server and your MCP client.

📋 Debug logs

Enable debug mode to view detailed logs:

sh
export OPENZITI_MCP_DEBUG=true

Get detailed MCP Client logs from Claude Desktop:

sh
# Follow logs in real-timetail -n 20 -F ~/Library/Logs/Claude/mcp*.log

👨‍💻 Development

Building from Source

bash
# Clone the repositorygit clone https://github.com/openziti/ziti-mcp-server.gitcd ziti-mcp-server-go
# Buildgo build ./cmd/ziti-mcp-server
# Run./ziti-mcp-server run

Regenerating API Clients

The Ziti API clients in internal/gen/ are generated from OpenAPI specs using go-swagger:

bash
make generate

來源:README.md,提交 9867ecd

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

1
  1. v0.11.0最新Sep 16, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分