使用说明

项目简介

'dub-ts' SDK 不仅是一个用于 Dub.co API 的 TypeScript 客户端库，它还内建了一个 Model Context Protocol (MCP) 服务器。这个服务器允许 AI 应用（如 Claude、Cursor）通过 MCP 协议调用 Dub.co API 的各项功能，从而为 AI 应用提供强大的链接管理和分析能力。

主要功能点

工具 (Tools): 将 Dub.co API 的各种操作 (例如创建短链接、查询分析数据、管理标签等) 暴露为 MCP 工具，供 AI 应用直接调用。通过这些工具，AI 应用可以方便地与 Dub.co 服务进行交互，实现链接的创建、管理和数据分析等功能。
资源 (Resources): 虽然文档中没有明确提及资源托管，但 SDK 本身作为 Dub.co API 的客户端，可以被视为访问和管理 Dub.co 服务的资源的接口。 AI 应用可以通过 MCP 服务器间接访问和利用 Dub.co 平台上的链接数据和分析信息。
Prompt 模板 (Prompts): 文档中没有提及 Prompt 模板功能，该仓库主要侧重于通过工具形式暴露 Dub.co API 功能，方便 AI 应用直接调用 API 功能完成特定任务。

安装步骤

使用 npm 安装 dub SDK:

npm install dub

或者，您可以使用 pnpm, bun, yarn 等其他 JavaScript 包管理器进行安装。

服务器配置

要将 'dub-ts' SDK 作为 MCP 服务器使用，您需要在 MCP 客户端（例如 Claude 或 Cursor）中配置服务器的启动命令。以下是配置示例，请根据您的 MCP 客户端类型选择相应的配置信息。

Claude 配置示例: 将以下 JSON 代码添加到你的 'claude_desktop_config.json' 文件中:

{
  "mcpServers": {
    "Dub": {
      "command": "npx",
      "args": [
        "-y", "--package", "dub",
        "--",
        "mcp", "start",
        "--api-token", "YOUR_DUB_API_KEY"  //  请替换为你的 Dub.co API 密钥
      ]
    }
  }
}

Cursor 配置示例: 在 Cursor 的设置 ('Cursor Settings > Features > MCP Servers > Add new MCP server') 中，添加一个新的 MCP 服务器，并使用以下配置:

Name: 'Dub'
Type: 'command'
Command:

npx -y --package dub -- mcp start --api-token YOUR_DUB_API_KEY  // 请替换为你的 Dub.co API 密钥

配置参数说明:

'--api-token': 必填参数。这是你的 Dub.co API 密钥，用于验证 API 请求的身份。请务必替换 'YOUR_DUB_API_KEY' 为你实际的 API 密钥。
'mcp start': 启动 MCP 服务器的命令。这是 'dub-ts' SDK 提供的用于启动 MCP 服务器的入口。
'npx -y --package dub --': 这部分命令使用 'npx' 工具来执行安装在 npm 包仓库中的 'dub' 包。'-y' 参数表示自动确认安装， '--package dub' 指定要运行的包是 'dub'，'--' 之后的部分是传递给 'dub' 包的参数。

基本使用方法

安装 SDK: 首先，确保你已经安装了 'dub-ts' SDK。
配置 MCP 客户端: 根据你的 MCP 客户端 (Claude 或 Cursor) 的类型，配置 Dub MCP 服务器的启动命令和 API 密钥。
调用工具: 在你的 MCP 客户端中，你可以像使用其他工具一样，调用 Dub MCP 服务器提供的工具。例如，你可以使用 'links_create' 工具来创建新的短链接，或使用 'analytics_retrieve' 工具来获取链接的分析数据。

工具的具体名称和参数可以参考仓库的 'src/mcp-server/tools' 目录下的文件，文件名 (去除 'tool$' 前缀和 '.ts' 后缀) 即为工具名，例如 'tool$linksCreate.ts' 对应的工具名为 'links_create'。工具的详细使用方法和参数说明请参考 Dub.co API 的官方文档。

关键词