跳至主要內容

本地 MCP 伺服器提交指南

3 週前已更新

這是一份完整指南,說明如何將您的本地伺服器 (MCPB) 提交到 Anthropic 的公開目錄,以便更廣泛的發佈和發現。

先決條件

閱讀本指南前,您應該具備:

  • 一個可運作的 MCPB

  • 使用變數替換的可移植程式碼

  • 良好的錯誤訊息和使用者體驗

  • 乾淨、捆綁的依賴項

初次接觸 MCPB 開發?請先參閱使用 MCPB 建立桌面擴充功能。如需技術最佳實踐(測試、錯誤訊息、可移植性),請參閱MCPB 儲存庫

注意:本指南涵蓋本地 MCP 伺服器。如需遠端桌面擴充功能,請參閱遠端 MCP 伺服器提交指南


1. 目錄概述

納入目錄有什麼好處?

可發現性和信任:

  • 在 Claude Desktop 內的官方 Anthropic 目錄中列出

  • 可由個別 Claude Desktop 使用者搜尋

  • 當管理員將其新增到允許清單時,對 Teams/Enterprise 使用者可見

  • Anthropic 審查建立使用者信任

使用者體驗:

  • 從目錄一鍵安裝

  • 與 Claude Desktop 設定 UI 整合

  • 標準化呈現

支援和信譽:

  • Anthropic 對品質和安全性的審查

  • 與其他已審查的擴充功能並列

  • 社群可見性和回饋

  • 專業發佈管道


2. 強制性要求

本部分中的所有要求都是目錄批准的強制性要求。缺少其中任何一項將導致拒絕或修訂請求。

注意:這些是 Anthropic 目錄特定的要求。

如需一般 MCPB 開發最佳實踐(測試、錯誤處理、可移植性),請參閱MCPB 儲存庫 README


工具註解是否為必需?

是的。每個工具都必須具有並維護準確的安全註解。

每個工具上的必需項目:

  • readOnlyHint: true - 適用於僅讀取資料的工具

  • destructiveHint: true - 適用於修改資料或有副作用的工具

請參閱MCP 協議 - 工具註解以取得完整的架構和實作詳細資訊。

非可選項。這是源自MCP 目錄政策的硬性要求。

如何決定使用哪個註解:

工具行為

註解

範例

僅讀取資料

readOnlyHint: true

search、get、list、fetch、read

寫入/修改資料

destructiveHint: true

create、update、delete、send、write

建立暫存檔案

destructiveHint: true

即使是暫時寫入也算

傳送外部請求

destructiveHint: true

電子郵件、通知、Webhook

僅內部快取

readOnlyHint: true

內部最佳化可以

實作詳細資訊:請參閱MCP 協議 - 工具以取得:

  • 帶有註解的完整工具架構

  • 工具定義結構

  • 輸入/輸出架構規格

  • 其他工具屬性(包括可選的 title 欄位)

提交前驗證:

# 檢查所有工具是否有註解

grep -A 5 -B 5 "readOnlyHint\|destructiveHint" server/

# 驗證每個工具是否恰好有一個註解

影響:這是我們檢查的第一件事,也是修訂請求最常見的原因。

其他建議的註解:

  • title - 用於 UI 顯示的人類可讀工具名稱(改善使用者體驗)


隱私政策是否為必需?

是的,隱私政策在兩個位置都是必需的:

位置 1:README.md

將「隱私政策」部分新增到您的 README,並連結到您的完整隱私政策,以便使用者了解您的做法:

## 隱私政策

此擴充功能收集 [描述資料類型]。如需完整的隱私資訊,請參閱我們的隱私政策:https://your-domain.com/privacy-policy

### 資料收集
- [列出收集的資料]
- [如何使用]
- [是否與第三方共享]
- [保留期限]

位置 2:manifest.json

新增 privacy_policies 陣列,其中包含可公開存取的 HTTPS URL:

完整實作:請參閱MCPB 資訊清單規格 - 隱私政策以取得:

  • 隱私政策欄位結構

  • 資訊清單版本要求 (0.3+)

  • 多個政策 URL 支援

  • 驗證要求

隱私政策必須涵蓋:

  • 您的 MCPB 收集的資料

  • 資料如何使用和儲存

  • 資料是否與第三方共享

  • 使用者資料保留政策

  • 隱私問題的聯絡資訊

要求:

  • 必須是可公開存取的 HTTPS URL

  • 必須來自您的網域(不是第三方託管)

  • 必須是最新且準確的

  • 必須在 README manifest.json 中

  • 必須使用資訊清單版本「0.3」或更高版本

常見錯誤:

  • 隱私政策在資訊清單中但不在 README 中

  • 隱私政策在 README 中但不在資訊清單中

  • 使用資訊清單版本「0.2」或更舊版本

  • 無效或無法存取的 URL

  • 隱私政策託管在第三方網站上

影響:這是拒絕最常見的原因之一 - 直接修復但經常被忽視。


需要多少個範例?

最少三個展示核心功能的可運作範例。

什麼是好的範例:

  • 展示實際使用案例

  • 包括預期的使用者輸入/提示

  • 顯示預期的輸出/行為

  • 展示實際工具使用

  • 清晰易懂的工作流程

範例格式(在 README.md 中):

## 範例

### 範例 1:搜尋檔案
**使用者提示:**「在我的專案中尋找所有 JavaScript 檔案」

**預期行為:**
- 擴充功能搜尋工作區目錄
- 傳回 .js 檔案清單及路徑
- 在摘要中顯示檔案計數

### 範例 2:讀取檔案內容
**使用者提示:**「顯示我 config.json 的內容」

**預期行為:**
- 擴充功能讀取 config.json
- 傳回格式化的 JSON 內容
- 妥善處理檔案未找到的情況

### 範例 3:建立新檔案
**使用者提示:**「建立一個名為 notes.txt 的新檔案,內容為 'Hello World'」

**預期行為:**
- 擴充功能建立 notes.txt
- 將內容寫入檔案
- 確認建立並顯示檔案路徑

要包括的內容:

  • 實際使用者提示(使用者如何互動)

  • 預期的工具呼叫(幕後發生的事情)

  • 預期的輸出(使用者將看到的內容)

  • 錯誤處理範例(可選但建議)

要求:

  • 最少 3 個範例(無上限)

  • 涵蓋核心功能

  • 展示不同的工具/功能

  • 展示價值主張

  • 包括在 README.md 中

影響:延遲或拒絕的常見來源 - 審查者需要完整的文件來正確評估提交。


我需要提供測試認證嗎?

如果您的 MCPB 需要身份驗證或外部服務存取,則是的。

需要的情況:

  • 您的 MCPB 連接到外部 API

  • 功能需要身份驗證

  • MCPB 使用者必須有帳戶才能使用功能

  • 存在外部服務整合

不需要的情況:

  • 純本地 MCPB(僅檔案系統操作)

  • 無外部連接

  • 不需要身份驗證

  • 完全自包含

要提供的內容:

  • 測試帳戶認證(使用者名稱/密碼或 API 金鑰)

  • 帳戶中的範例資料(有助於功能測試)

  • 設定說明(如何設定和使用測試帳戶)

  • 存取限制或限制(如果有)

  • 帳戶過期日期(如果是暫時的)

如何提供:

  • 包括在提交表單中

  • 如果高度敏感,請透過安全方法傳送

  • 確保帳戶在整個審查期間保持活躍

  • 提供足夠的存取級別以進行完整測試

最佳實踐:建立與生產分開的專用測試帳戶,以便:

  • 避免洩露生產資料

  • 控制審查者可以存取的內容

  • 批准後輕鬆撤銷存取權限

  • 追蹤測試帳戶使用情況

影響:如果需要時缺少,會延遲審查流程


需要什麼文件?

README.md 中的綜合文件,包含最少必需的部分。

最少必需的部分:

  1. 描述 - 清楚說明您的 MCPB 的功能

  2. 功能 - 主要功能和使用案例

  3. 安裝 - 如何安裝(通常:「從 Anthropic 目錄安裝」)

  4. 設定 - 必需的設定和設定步驟

  5. 使用範例 - 最少 3 個範例(見上面的部分)

  6. 隱私政策 - 連結到完整隱私政策

  7. 支援 - 使用者如何獲得幫助或報告問題

README.md 結構範例:

# 我的 MCPB 擴充功能

## 描述
此擴充功能的功能及其有用原因的簡要說明。

## 功能
- 功能 1:[描述]
- 功能 2:[描述]
- 功能 3:[描述]

## 安裝
從 Claude Desktop 設定 → 擴充功能中的 Anthropic 目錄安裝。

## 設定
1. 開啟設定 → 擴充功能 → [擴充功能名稱]
2. 新增 API 金鑰(如果需要)
3. 選擇工作區目錄
4. 設定可選設定

## 範例
[見上面的最少 3 個範例部分]

## 隱私政策
請參閱我們的隱私政策:https://your-domain.com/privacy

## 支援
如有問題或疑問:[email protected]
GitHub 問題:https://github.com/your-username/your-extension/issues

其他建議的部分:

  • 疑難排解 - 常見問題和解決方案

  • 版本相容性 - 支援的 Claude Desktop 版本

  • 變更日誌 - 版本歷史和變更

  • 貢獻 - 其他人如何貢獻(適用於開源)

最佳實踐:

  • 清晰簡潔的寫作

  • 螢幕截圖(可選但非常有幫助)

  • 逐步說明

  • 其他資源的連結


3. 提交流程

我如何提交到目錄?

在提交到目錄之前,請完成此逐步提交流程:

1. 提交前檢查清單:

測試您的 MCPB:

  • 通過所有 4 個測試階段(開發、乾淨環境、跨平台、Claude Desktop)

  • 在沒有開發工具的乾淨環境中運作

  • 可在 macOS 和 Windows 上移植

  • 依賴項最新且已捆綁

  • 錯誤訊息有幫助且可操作

  • 效能可接受

驗證強制性要求:

  • 所有工具都有 readOnlyHint 或 destructiveHint 註解

  • 隱私政策存在於 README.md 中

  • 隱私政策存在於 manifest.json privacy_policies 陣列中

  • 使用最新資訊清單版本以獲得最佳相容性

  • README 中記錄了最少 3 個可運作的範例

  • 提供了測試認證(如適用)

準備文件:

  • README.md 完整,包含所有必需的部分

  • 包含 LICENSE 檔案

  • 包含圖示(建議,512×512px PNG)

  • CHANGELOG.md(可選但建議)

2. 打包最終版本:

# 乾淨構建
rm -rf node_modules/.cache
npm install --production

# 打包
mcpb pack

# 驗證套件
mcpb info your-extension.mcpb

3. 透過官方表單提交:

必需資訊:伺服器詳細資訊、文件連結、測試認證、範例(最少 3 個)和聯絡資訊。表單提供完整清單。

雖然我們努力盡快審查每份提交,但由於興趣量很大,我們無法保證我們會接受您的提交或單獨回應。


4. 常見問題

修訂請求最常見的原因是什麼?

這些是基於提交資料的主要問題:

1. 缺少工具註解

  • 問題:工具缺少必需的 readOnlyHint 或 destructiveH

是否回答了您的問題?