Kajirita2002 Honeycomb MCP Server

🚀 Honeycomb (Honeycomb) MCP Server Documentation

Honeycomb MCP (Management Control Plane) server is an interface for interacting with the Honeycomb database. It allows you to create, query, and manage datasets while providing detailed error handling and logging capabilities.

✨ Features

• Event Creation: Supports adding events in batches or individually.
• Dataset Management: Easily create, update, and delete datasets.
• Query Functionality: Powerful filtering and calculation features to help you analyze data efficiently.
• Error Handling: Unified error return format for easy debugging and exception handling.

🚀 Quick Start

Create an Event

To add a single event to the Honeycomb database, use the following API:

POST /api/v1/event
Content-Type: application/json

{
  "dataset": "string",
  "body": {
    "key": "value"
  }
}

You can also upload multiple events in batches:

POST /api/v1/events
Content-Type: application/json

[
  {
    "dataset": "string",
    "body": {
      "key": "value"
    }
  },
  ...
]

Create a Dataset

To create a new dataset, you can use the following command:

POST /api/v1/dataset
Content-Type: application/json

{
  "name": "string",
  "description": "string"
}

📦 Dataset Management

Update a Dataset

Update the name or description of an existing dataset:

PUT /api/v1/dataset/{datasetSlug}
Content-Type: application/json

{
  "name": "string",
  "description": "string"
}

Delete a Dataset

Delete a specified dataset:

DELETE /api/v1/dataset/{datasetSlug}

💻 Usage Examples

Basic Queries

Get all events from a specific dataset:

GET /api/v1/dataset/{datasetSlug}/events

You can also add filters and calculations:

GET /api/v1/dataset/{datasetSlug}/query
Query Parameters:
- filter: Filter conditions, e.g., `column=value`
- calculate: Calculation operations, e.g., `count(*)`

Advanced Queries

Support more complex query options such as grouping and sorting:

GET /api/v1/dataset/{datasetSlug}/advanced-query
Query Parameters:
- filter: Filter conditions
- groupBy: Grouping fields
- orderBy: Sorting fields
- limit: Limit the number of results

🔧 Error Handling

Error Format

When an error occurs, the server will return the following structure:

{
  "error": {
    "message": "Detailed error description",
    "code": "ERROR_CODE"
  }
}

Common Error Codes

• AUTH_ERROR: Authentication failed. Please check your API key.
• NOT_FOUND: The requested resource was not found.
• INVALID_REQUEST: The request format is incorrect.
• INTERNAL_SERVER_ERROR: An internal server error occurred.

Troubleshooting

Verify API Key

Ensure that the API key you are using is correct and has the appropriate permissions.

GET /api/v1/whoami

Check Dataset Existence

Before performing query or update operations, confirm that the target dataset exists.

HEAD /api/v1/dataset/{datasetSlug}

Contribution Guidelines

How to Contribute

Community members are welcome to contribute to the Honeycomb MCP server! You can participate in the following ways:

• Submit issue reports.
• Create feature requests.
• Submit code fixes or new features.

Development Process

1. Clone the repository:

git clone https://github.com/honeycomb/mcp.git

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

📄 License

The Honeycomb MCP server is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

Thank you for using the Honeycomb MCP server! For further assistance, please refer to our FAQ or contact the support team.