使用说明

项目简介

ding-typescript SDK 是一个用于访问 Ding API 的 Typescript/Javascript 库。除了作为 SDK 使用，它还可以作为一个 Model Context Protocol (MCP) 服务器安装，将 SDK 中提供的各种方法以工具 (Tools) 的形式暴露出来，供 AI 应用程序调用。

主要功能点

资源 (Resources) 托管和数据访问: 虽然仓库信息没有明确提及资源管理，但 MCP 服务器本身具备资源管理能力，该服务器可以潜在地扩展以支持资源托管。当前主要通过工具提供数据访问能力。
工具 (Tools) 注册和执行: 将 SDK 的方法（如发送 OTP 验证码、校验验证码、查询电话号码信息等）注册为 MCP 工具，允许 LLM 客户端调用这些工具来执行特定功能。
Prompt 模板 (Prompts) 渲染: 仓库信息中没有明确提及 Prompt 模板功能，但 MCP 服务器的架构本身支持 Prompt 模板的定义和渲染，该服务器未来可能扩展此功能。
基于 JSON-RPC 协议通信: MCP 服务器通过 JSON-RPC 协议与客户端通信，接收和响应客户端请求。
支持 Stdio 和 SSE 传输协议: 提供 Stdio 和 SSE 两种传输协议选项，以适应不同的应用场景和客户端需求。

安装步骤

SDK 安装

可以使用 npm, pnpm, bun 或 yarn 等包管理器安装 SDK：

npm add @ding-live/ding

MCP 服务器安装

该 SDK 同时也是一个可安装的 MCP 服务器。运行 MCP 服务器需要 Node.js v20 或更高版本。

Claude 安装步骤

将以下服务器定义添加到你的 'claude_desktop_config.json' 文件中：

{
  "mcpServers": {
    "Ding": {
      "command": "npx",
      "args": [
        "-y", "--package", "@ding-live/ding",
        "--",
        "mcp", "start",
        "--api-key", "YOUR_API_KEY"
      ]
    }
  }
}

Cursor 安装步骤

在 Cursor 设置中，进入 'Cursor Settings > Features > MCP Servers > Add new MCP server'，并使用以下设置：

Name: Ding
Type: 'command'
Command:

npx -y --package @ding-live/ding -- mcp start --api-key YOUR_API_KEY

服务器配置

MCP 服务器启动命令及参数

MCP 服务器的启动命令是 'npx -y --package @ding-live/ding -- mcp start'。

以下是 'args' 参数的详细说明，用于配置 MCP 服务器的运行：

'-y'： (npm 参数) 自动同意安装过程中所有提示。
'--package @ding-live/ding': (npm 参数) 指定要安装和运行的 npm 包为 '@ding-live/ding'。
'--': 分隔 npm 参数和应用程序参数。
'mcp start': 指定运行 'ding' 包中的 'mcp' 应用，并执行 'start' 命令，即启动 MCP 服务器。
'--api-key YOUR_API_KEY': 必需参数。用于 Ding API 鉴权的 API 密钥。请替换 'YOUR_API_KEY' 为你实际的 Ding API 密钥。

更多服务器参数选项，可以运行以下命令查看帮助信息：

npx -y --package @ding-live/ding -- mcp start --help

基本使用方法

安装并配置 MCP 服务器后，AI 应用程序（如 Claude, Cursor 等 MCP 客户端）可以通过 MCP 协议连接到该服务器，并调用 SDK 暴露的工具 (Tools)。

可用工具 (Tools)

该 MCP 服务器将 Ding SDK 的以下方法暴露为工具，AI 应用可以调用这些工具来使用 Ding API 的功能：

'lookup_lookup': 查询电话号码信息。
'otp_check': 校验 OTP 验证码。
'otp_create-authentication': 发送 OTP 验证码。
'otp_feedback': 发送用户反馈。
'otp_get-authentication-status': 获取验证状态。
'otp_retry': 重新发送 OTP 验证码。

AI 应用可以根据自身需求，选择合适的工具进行调用，实现例如用户身份验证、电话号码信息查询等功能。

示例：在 Claude 中使用 'otp_create-authentication' 工具

在 Claude 中，你可以通过自然语言指令，结合工具调用来让 Claude 调用 'otp_create-authentication' 工具发送验证码。具体的指令格式和工具参数需要参考 Claude 客户端的文档和工具的参数定义。

例如，假设 'otp_create-authentication' 工具接受 'phoneNumber' 和 'customerUuid' 作为参数，你可以在 Claude 中类似这样指示：

'请使用 Ding 工具发送验证码到电话号码 +1234567890，客户 UUID 是 cf2edc1c-7fc6-48fb-86da-b7508c6b7b71'

Claude (或其他 MCP 客户端) 会解析你的指令，识别出需要调用 'otp_create-authentication' 工具，并提取参数 'phoneNumber: "+1234567890"' 和 'customerUuid: "cf2edc1c-7fc6-48fb-86da-b7508c6b7b71"'，然后通过 MCP 协议发送请求给 MCP 服务器，MCP 服务器执行工具并返回结果给 Claude。

注意: 实际使用中，工具的名称和参数可能会略有不同，请参考实际的工具定义和 MCP 客户端的使用说明。

关键词