Honeycomb MCP Server

🚀 Honeycomb MCP Server

The Honeycomb MCP (Middleware Processing) Server is a middleware solution for interacting with the Honeycomb platform. It offers a series of API endpoints to create, query, and manage Honeycomb datasets.

🚀 Quick Start

Installation and Configuration

1. Clone the repository:

git clone https://github.com/your-username/honeycomb-mcp-server.git

2. Install dependencies:

npm install

3. Start the service:

node index.js

Core API Endpoints

Create a Dataset

Request Example:

POST /api/datasets
{
  "name": "Application Monitoring",
  "description": "Monitoring for our production application"
}

Response Example:

{
  "dataset": {
    "id": "60a3c5d94b16f00079b4c8d2",
    "name": "Application Monitoring",
    "description": "Monitoring for our production application",
    "created_at": "2025-03-25T14:30:00Z"
  }
}

Query Data

Request Example:

GET /api/datasets/{datasetId}/events?from=2025-03-25T14%3A30%3A00Z&to=2025-03-26T14%3A30%3A00Z

Response Example:

{
  "events": [
    {
      "id": "1",
      "data": {
        "service": "api-server",
        "message": "User login successful",
        "duration_ms": 45,
        "status_code": 200,
        "endpoint": "/api/login",
        "timestamp": "2025-03-25T14:30:00Z"
      }
    }
  ]
}

✨ Features

• Event Ingestion: Supports efficient upload of batch or single events.
• Dataset Management: Easily create, update, and delete datasets.
• Query Functionality: Conduct data analysis through flexible query APIs, including filtering, grouping, and aggregation operations.
• Error Handling: Detailed error messages help quickly locate issues.

📚 Documentation

Data Model

All event data must conform to the following structure:

{
  "id": string,
  "data": {
    // Custom fields
  },
  "timestamp": string // ISO format time string
}

Query Syntax

Supported query operators include =, !=, >, <, >=, <=, IN, NOT IN. You can also combine multiple conditions using logical operators AND and OR.

Error Handling

When an error occurs, the server returns error information in a unified format:

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

Common Error Codes

• BAD_REQUEST: Invalid request parameters.
• NOT_FOUND: Resource does not exist.
• INTERNAL_SERVER_ERROR: Internal server error.

🔧 Technical Details

Development Process

1. Clone the repository:

git clone https://github.com/your-username/honeycomb-mcp-server.git

2. Install dependencies:

npm install

3. Start the development environment:

npm run dev

Coding Standards

• Follow the ESLint coding standard.
• Provide detailed commit messages, including problem descriptions and solutions.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.