Speakeasy API 工具 MCP 服务器

项目简介

Speakeasy Client SDK for TypeScript 不仅是一个用于 Speakeasy API 的客户端 SDK，它还可以作为一个 MCP 服务器运行。这意味着您可以将 SDK 中包含的各种 API 方法作为工具，通过 Model Context Protocol (MCP) 提供给支持 MCP 协议的 LLM 客户端（如 Claude、Cursor 等）。

主要功能点

资源访问: 通过 SDK 提供的工具，LLM 应用可以访问和管理 Speakeasy 平台上的各种资源，例如制品 (Artifacts)、工作空间 (Workspaces)、组织 (Organizations) 等。
工具调用: SDK 的每个方法都被转化为一个独立的工具，LLM 应用可以调用这些工具来执行各种操作，例如创建远程源、获取访问令牌、生成代码示例预览等。
标准化接口: 通过 MCP 协议，LLM 应用可以使用标准化的 JSON-RPC 接口与 Speakeasy MCP 服务器进行通信，无需关心底层 API 细节。

安装步骤

安装 Node.js: 确保您的环境中安装了 Node.js v20 或更高版本。

安装 SDK: 使用 npm 或 yarn 等包管理器安装 '@speakeasy-api/speakeasy-client-sdk-typescript' 包。例如，使用 npm：

npm add @speakeasy-api/speakeasy-client-sdk-typescript

服务器配置

要将 Speakeasy Client SDK 配置为 MCP 服务器，您需要在 MCP 客户端（例如 Claude 或 Cursor）的配置文件中添加服务器定义。以下是 Claude 客户端的配置示例 ('claude_desktop_config.json')：

{
  "mcpServers": {
    "Speakeasy": {  // 服务器名称，可以自定义
      "command": "npx",  // 运行命令，npx 用于执行本地 node 包
      "args": [
        "-y", "--package", "@speakeasy-api/speakeasy-client-sdk-typescript", // 指定要执行的 npm 包
        "--",
        "mcp", "start",  //  指定执行 mcp server 的启动命令
        "--api-key", "YOUR_API_KEY",  // Speakeasy API 密钥 (必需)
        "--bearer", "YOUR_BEARER_TOKEN", // Bearer Token (如果需要)
        "--workspace-identifier", "YOUR_WORKSPACE_IDENTIFIER", // 工作空间标识符 (如果需要)
        "--workspace-id", "YOUR_WORKSPACE_ID" // 工作空间 ID (如果需要)
      ]
    }
  }
}

参数说明:

'server name': MCP 服务器的名称，可以自定义，例如 "Speakeasy"。
'command': 启动 MCP 服务器的命令，这里使用 'npx' 来执行安装在 'node_modules' 中的包。
'args': 传递给 'npx' 命令的参数列表，用于配置 Speakeasy MCP 服务器：
- '--package @speakeasy-api/speakeasy-client-sdk-typescript': 指定要执行的 npm 包为 Speakeasy Client SDK。
- 'mcp start': SDK 提供的启动 MCP 服务器的命令。
- '--api-key YOUR_API_KEY': 必需参数，您的 Speakeasy API 密钥。您需要在 Speakeasy 平台获取 API 密钥。
- '--bearer YOUR_BEARER_TOKEN': 可选参数，Bearer Token，如果您的 Speakeasy API 需要 Bearer Token 认证，请提供。
- '--workspace-identifier YOUR_WORKSPACE_IDENTIFIER': 可选参数，工作空间标识符，根据您的 Speakeasy 工作空间配置决定是否需要。
- '--workspace-id YOUR_WORKSPACE_ID': 可选参数，工作空间 ID，根据您的 Speakeasy 工作空间配置决定是否需要。

基本使用方法

配置 MCP 客户端: 根据您的 LLM 客户端 (如 Claude, Cursor) 的文档，配置上述 MCP 服务器定义。
启动 MCP 服务器: 当您启动支持 MCP 的 LLM 客户端后，客户端会自动尝试连接并启动 Speakeasy MCP 服务器。
在 LLM 中使用工具: 在 LLM 应用中，您可以像使用其他工具一样，发现并调用 Speakeasy MCP 服务器提供的工具。工具名称通常会反映 SDK 方法的名称，例如 'artifacts.createRemoteSource', 'auth.getAccessToken', 'codeSamples.generateCodeSamplePreview' 等。
查阅 SDK 文档: 您可以参考 Speakeasy Client SDK for TypeScript 文档了解每个工具的详细功能、参数和使用方法。

注意: 您需要替换配置示例中的 'YOUR_API_KEY', 'YOUR_BEARER_TOKEN', 'YOUR_WORKSPACE_IDENTIFIER', 'YOUR_WORKSPACE_ID' 为您实际的 Speakeasy API 密钥和工作空间信息。

关键词

Speakeasy API 工具 MCP 服务器

信息