使用说明

项目简介

HoneyHive TypeScript SDK 不仅是一个用于与 HoneyHive API 交互的软件开发工具包，同时也可以作为一个独立的 Model Context Protocol (MCP) 服务器安装和运行。此 MCP 服务器允许 AI 应用程序通过标准化的 MCP 协议调用 SDK 中提供的各种方法作为工具，从而实现上下文信息的管理和功能扩展。

主要功能点

资源管理: 通过 SDK 提供的方法管理和访问各种资源，例如数据集 (datasets)、项目 (projects)、配置 (configurations) 等。
工具注册与执行: 将 SDK 中预置的各种方法（例如数据点操作、事件管理、会话控制等）注册为工具，允许 LLM 客户端调用这些工具以扩展其功能。
会话管理: 支持会话的启动和检索，方便 LLM 应用进行上下文跟踪和管理。
标准化协议: 遵循 Model Context Protocol (MCP) 标准，确保与兼容 MCP 协议的 LLM 客户端互操作。

安装步骤

安装 SDK: 使用 npm 或其他 JavaScript 包管理器安装 HoneyHive SDK。
```
npm add honeyhive
```
或使用 yarn:
```
yarn add honeyhive zod
```
请注意，Yarn 需要手动安装 'zod' 依赖。
Node.js 版本要求: 确保您的 Node.js 版本为 v20 或更高，以运行 MCP 服务器。

服务器配置

MCP 服务器需要通过 MCP 客户端进行配置才能连接。以下是针对 Claude 和 Cursor 客户端的配置示例。您需要将以下 JSON 配置添加到您的 MCP 客户端配置文件中（例如 'claude_desktop_config.json' 或 '.cursor/mcp.json'）。

{
  "mcpServers": {
    "HoneyHive": {
      "command": "npx",
      "args": [
        "-y", "--package", "honeyhive",
        "--",
        "mcp", "start",
        "--bearer-auth", "<YOUR_BEARER_TOKEN_HERE>"
      ]
    }
  }
}

配置参数说明:

'"HoneyHive"': MCP 服务器的名称，可以自定义。
'"command": "npx"': 指定用于启动服务器的命令，这里使用 'npx' 来运行 npm 包。
'"args"': 传递给 'npx' 的参数列表，用于指定要运行的包和命令：
- '"-y", "--package", "honeyhive"': 安装并运行 'honeyhive' 包。
- '"--"': 分隔 'npx' 参数和 'honeyhive' 包的参数。
- '"mcp", "start"': 指定 'honeyhive' 包运行 'mcp start' 命令，启动 MCP 服务器。
- '"--bearer-auth", "<YOUR_BEARER_TOKEN_HERE>"': 重要: 您需要将 '<YOUR_BEARER_TOKEN_HERE>' 替换为您的 HoneyHive API 密钥，用于服务器的身份验证。

基本使用方法

配置完成后，您的 MCP 客户端（如 Claude 或 Cursor）将能够识别并连接到 HoneyHive MCP 服务器。之后，您可以在客户端中调用 HoneyHive SDK 提供的各种工具，例如：

'HoneyHive.configurations.getConfigurations': 检索配置列表。
'HoneyHive.datapoints.getDatapoints': 检索数据点列表。
'HoneyHive.datasets.getDatasets': 获取数据集。
'HoneyHive.events.createEvent': 创建新事件。
'HoneyHive.projects.getProjects': 获取项目列表。
'HoneyHive.session.startSession': 开始新会话。
'HoneyHive.tools.getTools': 检索工具列表。

具体的工具和操作方法请参考仓库的 Available Resources and Operations 部分和 SDK 文档。您可以通过 'npx -y --package honeyhive -- mcp start --help' 命令查看服务器的完整参数列表。

关键词

使用说明

信息