Ocireg MCP

🚀 OCI Registry MCP 服務器

OCI Registry MCP 服務器是一個基於 MCP（模型上下文協議）的服務器，它提供了用於查詢 OCI 註冊表和鏡像引用的工具，能讓大語言模型驅動的應用與 OCI 註冊表進行交互。

🚀 快速開始

OCI Registry MCP 服務器最簡單的運行方式是使用 ToolHive，它能為 MCP 服務器提供安全的容器化部署：

# 安裝 ToolHive（如果尚未安裝）
# 請參閱：https://github.com/stacklok/toolhive#installation

# 啟用自動發現功能，以便自動配置受支持的客戶端
thv config auto-discovery true

# 運行 OCI Registry MCP 服務器（在 ToolHive 中打包為 'oci-registry'）
thv run oci-registry

# 列出正在運行的服務器
thv list

# 獲取服務器的詳細信息
thv registry info oci-registry

該服務器將對支持 MCP 的客戶端可用，並可查詢 OCI 註冊表以獲取鏡像信息。

使用 ToolHive 進行身份驗證

如果需要訪問私有註冊表，可以使用 ToolHive 的密鑰管理功能提供身份驗證憑據：

# 對於令牌身份驗證
thv secret set oci-token
# 提示時輸入令牌

thv run --secret oci-token,target=OCI_TOKEN oci-registry

# 對於用戶名/密碼身份驗證
thv secret set oci-username
thv secret set oci-password
# 提示時輸入憑據

thv run --secret oci-username,target=OCI_USERNAME --secret oci-password,target=OCI_PASSWORD oci-registry

✨ 主要特性

• 獲取 OCI 鏡像的信息
• 列出倉庫的標籤
• 獲取鏡像清單
• 獲取鏡像配置

📚 詳細文檔

MCP 工具

服務器提供以下 MCP 工具：

get_image_info

獲取 OCI 鏡像的信息。 輸入：

• image_ref：鏡像引用（例如，docker.io/library/alpine:latest）

輸出：

• 鏡像信息，包括摘要、大小、架構、操作系統、創建日期和層數

list_tags

列出倉庫的標籤。 輸入：

• repository：倉庫名稱（例如，docker.io/library/alpine）

輸出：

• 倉庫的標籤列表

get_image_manifest

獲取 OCI 鏡像的清單。 輸入：

• image_ref：鏡像引用（例如，docker.io/library/alpine:latest）

輸出：

• 鏡像清單

get_image_config

獲取 OCI 鏡像的配置。 輸入：

• image_ref：鏡像引用（例如，docker.io/library/alpine:latest）

輸出：

• 鏡像配置

🔧 技術細節

開發環境

• Go 1.21 或更高版本
• 能夠訪問 OCI 註冊表

身份驗證

服務器支持以下用於訪問私有 OCI 註冊表的身份驗證方法：

1. 令牌：設置以下環境變量：

   • OCI_TOKEN：用於註冊表身份驗證的令牌

2. 用戶名和密碼：設置以下環境變量：

   • OCI_USERNAME：用於註冊表身份驗證的用戶名
   • OCI_PASSWORD：用於註冊表身份驗證的密碼

3. Docker 配置：如果未提供令牌或用戶名/密碼，服務器將使用默認的 Docker 密鑰鏈，該密鑰鏈從 ~/.docker/config.json 讀取憑據。

示例：

# 令牌身份驗證
export OCI_TOKEN=mytoken

# 用戶名/密碼身份驗證
export OCI_USERNAME=myuser
export OCI_PASSWORD=mypassword

端口配置

可以使用以下兩種方式之一將服務器配置為監聽特定端口：

1. 環境變量：

   • MCP_PORT：要監聽的端口號（必須在 0 到 65535 之間）
   • 如果未設置或無效，默認使用端口 8080

2. 命令行標誌：

   • -port：覆蓋環境變量設置（必須在 0 到 65535 之間）
   • 如果提供的端口無效，默認使用端口 8080
   • 示例：./ocireg-mcp -port 9090

測試

go test ./...

代碼檢查

golangci-lint run

🤝 貢獻

我們歡迎對這個 MCP 服務器進行貢獻！如果您想貢獻代碼，請查看 貢獻指南 以瞭解如何開始。

如果您遇到了錯誤或有功能請求，請在 倉庫 中 創建一個問題，或者加入我們 社區 Discord 服務器 的 #mcp-servers 頻道。

📄 許可證

本項目採用 Apache v2 許可證 - 詳情請參閱 LICENSE 文件。