🚀 蜂巢（Honeycomb）MCP 服务器文档
蜂巢（Honeycomb）MCP（管理控制平面）服务器是与 Honeycomb 数据库交互的接口。它支持创建、查询和管理数据集，还具备详细的错误处理和日志记录功能，能有效提升数据管理效率。
🚀 快速开始
创建事件
要向 Honeycomb 数据库添加单个事件，请使用以下 API：
POST /api/v1/event
Content-Type: application/json
{
"dataset": "string",
"body": {
"key": "value"
}
}
您还可以批量上传多个事件：
POST /api/v1/events
Content-Type: application/json
[
{
"dataset": "string",
"body": {
"key": "value"
}
},
...
]
创建数据集
要创建一个新数据集，您可以使用以下命令：
POST /api/v1/dataset
Content-Type: application/json
{
"name": "string",
"description": "string"
}
✨ 主要特性
- 事件创建：支持批量或单个事件的添加。
- 数据集管理：方便地创建、更新和删除数据集。
- 查询功能：强大的过滤器和计算功能，帮助您高效分析数据。
- 错误处理：统一的错误返回格式，便于调试和处理异常。
📦 安装指南
文档中未提及安装相关内容，暂不提供安装指南。
💻 使用示例
基础用法
以下是向数据库添加单个事件的示例：
POST /api/v1/event
Content-Type: application/json
{
"dataset": "string",
"body": {
"key": "value"
}
}
高级用法
以下是进行高级查询的示例，支持分组和排序：
GET /api/v1/dataset/{datasetSlug}/advanced-query
Query Parameters:
- filter: 过滤条件
- groupBy: 分组字段
- orderBy: 排序字段
- limit: 结果数量限制
📚 详细文档
数据集管理
更新数据集
更新现有数据集的名称或描述：
PUT /api/v1/dataset/{datasetSlug}
Content-Type: application/json
{
"name": "string",
"description": "string"
}
删除数据集
删除指定的数据集：
DELETE /api/v1/dataset/{datasetSlug}
查询功能
基本查询
获取特定数据集的所有事件：
GET /api/v1/dataset/{datasetSlug}/events
您还可以添加过滤器和计算：
GET /api/v1/dataset/{datasetSlug}/query
Query Parameters:
- filter: 过滤条件，例如 `column=value`
- calculate: 计算操作，例如 `count(*)`
高级查询
支持更多复杂的查询选项，如分组和排序：
GET /api/v1/dataset/{datasetSlug}/advanced-query
Query Parameters:
- filter: 过滤条件
- groupBy: 分组字段
- orderBy: 排序字段
- limit: 结果数量限制
错误处理
错误格式
当发生错误时，服务器会返回以下结构：
{
"error": {
"message": "详细错误描述",
"code": "ERROR_CODE"
}
}
常见错误代码
| 错误代码 | 详情 |
|---|---|
AUTH_ERROR |
认证失败。请检查您的 API 密钥。 |
NOT_FOUND |
请求的资源未找到。 |
INVALID_REQUEST |
请求格式有误。 |
INTERNAL_SERVER_ERROR |
服务器内部错误。 |
故障排除
验证 API 密钥
确保您使用的 API 密钥正确且具有适当的权限。
GET /api/v1/whoami
检查数据集存在性
在进行查询或更新操作之前，确认目标数据集已存在。
HEAD /api/v1/dataset/{datasetSlug}
🔧 技术细节
文档中未提及具体的技术实现细节，暂不提供技术细节说明。
📄 许可证
Honeycomb MCP 服务器遵循 MIT 许可证。请参阅 LICENSE 文件以获取详细信息。
感谢您使用 Honeycomb MCP 服务器！如需进一步帮助，请随时查看我们的 FAQ 或联系支持团队。
贡献指南
如何贡献
欢迎社区成员为 Honeycomb MCP 服务器做出贡献！您可以通过以下方式参与：
- 提交问题报告。
- 创建功能请求。
- 提交代码修复或新功能。
开发流程
- 克隆仓库：
git clone https://github.com/honeycomb/mcp.git
- 安装依赖：
npm install
- 启动开发服务器：
npm run dev