JinDaGe - mcp MCP Details

article

README

🚀 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。

注意：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