🚀 Kiteworks MCP 服務器
Kiteworks MCP 服務器允許大語言模型(LLM)應用程序通過模型上下文協議(MCP)與您的 Kiteworks 實例進行安全交互。這個跨平臺服務器使 AI 助手能夠在您的 Kiteworks 環境中管理文件、文件夾和用戶信息,同時保持企業級的安全性。
🚀 快速開始
Kiteworks MCP 服務器旨在讓大語言模型(LLM)應用程序通過模型上下文協議(MCP)安全地與您的 Kiteworks 實例進行交互。以下是快速開始使用該服務器的步驟:
- 設置 OAuth 應用程序:在 Kiteworks 管理界面中創建一個自定義 OAuth 應用程序,並確保其具有必要的權限和設置。
- 安裝服務器:根據您的操作系統(Windows、Linux 或 macOS)下載並安裝 Kiteworks MCP 服務器。
- 配置服務器:使用
setup
命令配置服務器,輸入 Kiteworks 實例的 URL,並根據需要提供自定義 CA 證書。
- 啟動服務器:使用
start
命令啟動服務器,並確保它可以通過 MCP 客戶端訪問。
- 驗證配置:使用 MCP 檢查器或其他工具驗證服務器配置是否正確,並確保可以與 Kiteworks 實例進行交互。
✨ 主要特性
- 文件管理:上傳、下載 Kiteworks 中的文件,並檢索文件元數據。
- 文件夾操作:瀏覽文件夾層次結構、創建新文件夾並管理文件夾結構。
- 用戶信息:訪問當前用戶詳細信息和認證狀態。
- OAuth 2.0 認證:支持刷新令牌的安全授權。
- 速率限制:內置保護,可配置請求限制。
- 跨平臺支持:提供適用於 Windows、Linux 和 macOS 的原生二進制文件。
📦 安裝指南
Kiteworks 設置
重要提示:在開始之前,您需要在 Kiteworks 管理界面中設置一個自定義 OAuth 應用程序。導航至“應用程序設置” -> “客戶端和插件” -> “API”。
確保 OAuth 應用程序具有以下範圍:
- 文件:
CREATE
、READ
- 文件夾:
CREATE
、READ
- 用戶:
READ
此外,確保您已啟用:
授權碼
流程
刷新令牌
- 將重定向 URI 設置為
http://localhost:9999/callback
將提供的 客戶端應用程序 ID
和 客戶端密鑰
保存在安全的地方。在首次運行 MCP 服務器時,您需要輸入這些信息。
Windows 客戶端
- 下載適用於 Windows 的二進制文件。
- 啟動設置(一次性 OAuth 流程):
C:\Path\To\kiteworks-mcp.exe setup https://your.kiteworks.domain
- Claude Code 設置:
claude mcp add --transport stdio kiteworks C:\Path\To\kiteworks-mcp.exe start https://your.kiteworks.domain
MacOS 客戶端
- 下載適用於 MacOS 的二進制文件。
- 啟動設置(一次性 OAuth 流程):
/Path/To/kiteworks-mcp setup https://your.kiteworks.domain
- Claude Code 設置:
claude mcp add --transport stdio kiteworks /Path/To/kiteworks-mcp start https://your.kiteworks.domain
Linux 客戶端
Linux 的安裝說明與 MacOS 相同。
注意:Linux 實現依賴於 Secret Service dbus 接口,該接口由 GNOME Keyring 提供(https://wiki.gnome.org/Projects/GnomeKeyring)。
Visual Studio Code
有關在 VS Code 中設置 MCP 服務器的說明,您可以參考這篇文章:https://code.visualstudio.com/docs/copilot/customization/mcp-servers
MCP 檢查器
- 命令:
/Path/To/kiteworks-mcp
- 參數:
start https://your.kiteworks.domain
- 傳輸方式:
STDIO
💻 使用示例
基礎用法
配置示例
kiteworks-mcp start --insecure-absolute-paths --ca-cert path_to_cert/ca_chain.pem https://your.kiteworks.domain
轉換為 Claude Desktop 的 JSON 配置:
{
"mcpServers": {
"kiteworks": {
"command": "path_to/kiteworks-mcp",
"args": [
"start",
"--insecure-absolute-paths",
"--ca-cert",
"path_to_cert/ca_chain.pem",
"https://your.kiteworks.domain"
]
}
}
}
高級用法
絕對路徑操作示例
upload_file(parent_id="folder123", source="/Users/john/Desktop/report.pdf")
download_file(file_id="file456", target="C:\Users\jane\Documents\downloaded.xlsx")
📚 詳細文檔
命令參考
Kiteworks MCP 服務器提供以下命令:
setup
設置 Kiteworks 連接(一次性 OAuth 認證)。
kiteworks-mcp setup [flags] <kiteworks URL>
標誌:
--port, -p <port>
:在發生衝突時指定不同的 OAuth 回調服務器端口(默認值:9999,範圍:1024 - 65535)
--ca-cert, -c <path>
:PEM 格式的自定義 CA 證書的路徑
示例:
kiteworks-mcp setup https://your.kiteworks.domain
kiteworks-mcp setup --port 8080 --ca-cert /path/to/ca_chain.pem https://your.kiteworks.domain
start
運行 MCP 服務器(需要事先設置)。
kiteworks-mcp start [flags] <Kiteworks URL>
標誌:
--port, -p <port>
:在發生衝突時指定不同的 OAuth 回調服務器端口(默認值:9999,範圍:1024 - 65535)
--ca-cert, -c <path>
:PEM 格式的自定義 CA 證書的路徑
--insecure-absolute-paths
:允許在操作中使用絕對文件路徑(不安全)
示例:
kiteworks-mcp start https://your.kiteworks.domain
kiteworks-mcp start --ca-cert /path/to/ca_chain.pem https://your.kiteworks.domain
kiteworks-mcp start --insecure-absolute-paths https://your.kiteworks.domain
remove
刪除 Kiteworks 服務器的所有存儲憑證和令牌。
kiteworks-mcp remove <Kiteworks URL>
示例:
kiteworks-mcp remove https://your.kiteworks.domain
version
打印版本信息。
kiteworks-mcp version
TLS 證書驗證
如果您的 Kiteworks 實例使用自簽名證書或來自未知證書頒發機構的證書,在 OAuth 認證期間可能會遇到 TLS 驗證錯誤。您可以使用 --ca-cert
(或 -c
)標誌提供根 CA 鏈:
kiteworks-mcp setup --ca-cert ca_cert_chain.pem https://your.kiteworks.domain
kiteworks-mcp start --ca-cert ca_cert_chain.pem https://your.kiteworks.domain
注意:CA 證書必須是 PEM 格式,幷包含完整的證書鏈。
絕對路徑訪問
默認情況下,為了增加安全性,MCP 服務器將文件操作限制為僅使用相對路徑。上傳和下載將使用 MCP 客戶端的當前工作目錄。
您可以使用 start
命令的 --insecure-absolute-paths
標誌啟用完整的文件系統訪問。
啟用後,文件操作可以訪問:
- 完整的系統目錄:
/home/user/documents/file.txt
- 根文件系統訪問:
/etc/passwd
、/var/log/system.log
- Windows 系統路徑:
C:\Windows\System32\config.txt
macOS 用戶快速入門指南
OAuth 應用程序
在您的管理控制檯中創建一個自定義 OAuth 應用程序:
確保:
- 重定向 URI 設置為
http://localhost:9999/callback
- 啟用
授權碼
流程
- 啟用
刷新令牌
確保 OAuth 應用程序至少具有以下基本功能範圍:
- 文件夾的
READ
和 CREATE
- 文件的
READ
和 CREATE
- 用戶的
READ
將提供的 客戶端應用程序 ID
和 客戶端密鑰
保存在安全的地方。
如果自定義應用程序創建成功,它將出現在可用應用程序列表中。
認證 OAuth 客戶端
下載 適用於 macOS 的最新基於 Darwin 的 Kiteworks MCP 服務器二進制文件。
對先前創建的 OAuth 應用程序進行認證:
<FOLDER_WITH_MCP_BINARY>/kiteworks-mcp setup https://your.kiteworks.domain
如果上述命令執行成功,瀏覽器將自動打開。登錄到您的 Kiteworks 賬戶並授予自定義應用程序訪問權限。
使用 MCP 檢查器運行 Kiteworks MCP 服務器
MCP 檢查器是一個方便的工具,用於調查 MCP 服務器的功能。
確保已安裝 node.js v18+。
啟動 MCP 檢查器(瀏覽器將自動打開):
npx @modelcontextprotocol/inspector
在打開的 MCP 檢查器窗口中,確保:
- 傳輸類型為
STDIO
。
- 命令是
kiteworks-mcp
二進制文件的路徑。
- 參數是
start https://your.kiteworks.domain
。
按下 "Connect"
按鈕,即可訪問 Kiteworks MCP 服務器上可用的提示、工具和資源列表。
配置 MCP 客戶端
客戶需要自帶 MCP 客戶端和大語言模型(LLM)才能與 Kiteworks MCP 服務器進行交互。
MCP 客戶端和 LLM 可以有不同的組合,本指南將描述兩種可能的組合:
- Claude Desktop
- 搭配 AWS Bedrock 的 Claude Code
⚠️ 大語言模型(LLM)集成免責聲明
重要提示:客戶負責選擇和配置自己的 MCP 客戶端和 LLM。
- 所選的 LLM 必須符合客戶的內部合規政策、安全要求和數據處理指南。
- 請注意,不同的 LLM 提供商提供不同級別的數據隱私和安全保障。一些提供商可能會保留、記錄或使用輸入數據進行訓練或其他目的。
- Kiteworks 提供 LLM 集成指導,但不對使用第三方 LLM 服務導致的任何數據洩露、合規違規或其他風險承擔任何責任。
配置 Claude Desktop
前提條件:
注意:Claude Desktop 提供了由 Anthropic 預配置的 LLM。客戶必須確保在其組織內允許使用公共 Anthropic LLM(請參閱上述免責聲明)。
打開 Claude Desktop 設置並按下 "Edit Config"。
在提供的 JSON 配置文件中包含以下內容:
{
"mcpServers": {
"kiteworks": {
"command": "<FOLDER_WITH_MCP_BINARY>/kiteworks-mcp",
"args": [
"start",
"https://your.kiteworks.domain"
]
}
}
}
要允許完整的文件系統訪問,請使用 --insecure-absolute-paths
標誌:
{
"mcpServers": {
"kiteworks": {
"command": "<FOLDER_WITH_MCP_BINARY>/kiteworks-mcp",
"args": [
"start",
"--insecure-absolute-paths",
"https://your.kiteworks.domain"
]
}
}
}
對於自簽名證書,請使用 --ca-cert
(或 -c
)標誌:
{
"mcpServers": {
"kiteworks": {
"command": "<FOLDER_WITH_MCP_BINARY>/kiteworks-mcp",
"args": [
"start",
"--ca-cert",
"path_to_cert/ca_chain.pem",
"https://your.kiteworks.domain"
]
}
}
}
重要提示:重啟 Claude Desktop 以應用新配置。瀏覽器將自動打開。登錄到您的 Kiteworks 賬戶並授予自定義應用程序訪問權限。
驗證 Kiteworks MCP 服務器是否正在運行。
現在,您可以向 Claude 詢問 Kiteworks MCP 服務器的功能。
祝您使用愉快!
配置搭配 AWS Bedrock 的 Claude Code
前提條件:
- 已安裝 AWS CLI。
- 已安裝並認證 Claude Code。
- 已啟用 AWS Bedrock 訪問。
可以將 Anthropic 提供的 LLM 與 Claude Code 一起使用,不過,我們的客戶也可以使用通過流行雲服務(如 Google Cloud、AWS、MS Azure)提供的自己的 LLM。
在本示例中,我們將使用 AWS Bedrock 作為安全的 LLM 提供商。我們從 AWS Bedrock 中選擇了兩個模型:
- Claude Sonnet 4.5(用於深度思考的較大模型)
- Claude 3.5 Haiku(用於簡單請求的較小模型)
通過環境變量為 Claude Code 激活 AWS Bedrock 模型:
export CLAUDE_CODE_USE_BEDROCK=1
export AWS_REGION=<YOUR_AWS_REGION>
export ANTHROPIC_MODEL=<CLAUDE_SONNET_4.5_MODEL_ID>
export ANTHROPIC_SMALL_FAST_MODEL=<CLAUDE_3.5_HAIKU_MODEL_ID>
export AWS_PROFILE=<AWS_PROFILE>
將 Kiteworks MCP 服務器添加到 Claude 配置中:
claude mcp add --transport stdio kiteworks <FOLDER_WITH_MCP_BINARY>/kiteworks-mcp start https://your.kiteworks.domain
一切設置就緒!運行 claude
命令並輸入提示 "What can I do with Kiteworks MCP server?"
使用 /status
提示驗證 Claude 是否使用 AWS Bedrock。
祝您使用愉快!
🔧 技術細節
Kiteworks MCP 服務器作為基於本地 STDIO 的服務器構建,它在每個用戶的機器上運行,通過安全的 OAuth 2.0 認證將 LLM 客戶端連接到 Kiteworks。
📄 許可證
文檔未提及相關信息,故跳過該章節。
⚠️ 安全注意事項
- 此 MCP 服務器可能處理敏感數據,這些數據將可供您連接的大語言模型(LLM)訪問。請確保僅安裝受信任和經過驗證的 MCP 服務器。
- Kiteworks MCP 服務器不會向 LLM 暴露憑證或安全令牌,它們會安全地存儲在您的操作系統鑰匙串/憑證存儲中。
- Kiteworks MCP 服務器不會將其傳輸的數據提供給 LLM(在 LLM 上下文中)。此外,默認情況下,不允許使用絕對路徑進行上傳或存儲下載的內容。例如,您將無法上傳
/etc/passwd
或下載到 /etc/passwd
。若要允許使用絕對路徑,請參考命令行選項。
- Kiteworks MCP 服務器會驗證其連接的遠程 Kiteworks 服務器的 TLS 證書。如果無法驗證,它將中止連接,以防止中間人攻擊。如果您的 Kiteworks 實例使用自簽名證書或來自未知證書頒發機構的證書,您可以使用命令行選項提供根 CA 鏈。