mirror of
https://github.com/hyperdxio/hyperdx
synced 2026-04-21 13:37:15 +00:00
9781ae6387
## Summary Adds an MCP (Model Context Protocol) server to the HyperDX API, enabling AI assistants (Claude, Cursor, OpenCode, etc.) to query observability data, manage dashboards, and explore data sources directly via standardized tool calls. Key changes: - **MCP server** (`packages/api/src/mcp/`) — Streamable HTTP transport at `/api/mcp`, authenticated via Personal API Access Key - **Tools** — `hyperdx_list_sources`, `hyperdx_query`, `hyperdx_get_dashboard`, `hyperdx_save_dashboard`, `hyperdx_delete_dashboard`, `hyperdx_query_tile` - **Dashboard prompts** — Detailed prompt templates that guide LLMs in generating valid, high-quality dashboards - **Shared logic** — Refactored dashboard validation/transformation out of the external API router into reusable utils (`packages/api/src/routers/external-api/v2/utils/dashboards.ts`) - **Documentation** — `MCP.md` with setup instructions for Claude Code, OpenCode, Cursor, MCP Inspector, and other clients - **Tests** — Unit tests for dashboard tools, query tools, tracing, and response trimming ### Screenshots https://github.com/user-attachments/assets/8c5aa582-c79e-47e0-8f75-e03feabdf8a6 ### How to test locally 1. Start the dev stack: `yarn dev` 2. Connect an MCP client (e.g. MCP Inspector): ```bash cd packages/api && yarn dev:mcp ``` Then configure the inspector: - **Transport Type:** Streamable HTTP - **URL:** `http://localhost:8080/api/mcp` - **Header:** `Authorization: Bearer <your-personal-access-key>` - Click **Connect** 3. Alternatively, connect via Claude Code or OpenCode: ```bash claude mcp add --transport http hyperdx http://localhost:8080/api/mcp \ --header "Authorization: Bearer <your-personal-access-key>" ``` 4. Try listing sources, querying data, or creating/updating a dashboard through the connected AI assistant. 5. Run unit tests: ```bash cd packages/api && yarn ci:unit ``` ### References - Linear Issue: HDX-3710
74 lines
2.6 KiB
TypeScript
74 lines
2.6 KiB
TypeScript
import { parseTimeRange } from '../tools/query/helpers';
|
|
|
|
describe('parseTimeRange', () => {
|
|
it('should return default range (last 15 minutes) when no arguments provided', () => {
|
|
const before = Date.now();
|
|
const result = parseTimeRange();
|
|
const after = Date.now();
|
|
|
|
expect(result).not.toHaveProperty('error');
|
|
if ('error' in result) return;
|
|
|
|
// endDate should be approximately now
|
|
expect(result.endDate.getTime()).toBeGreaterThanOrEqual(before);
|
|
expect(result.endDate.getTime()).toBeLessThanOrEqual(after);
|
|
// startDate should be ~15 minutes before endDate
|
|
const diffMs = result.endDate.getTime() - result.startDate.getTime();
|
|
expect(diffMs).toBe(15 * 60 * 1000);
|
|
});
|
|
|
|
it('should use provided startTime and endTime', () => {
|
|
const result = parseTimeRange(
|
|
'2025-01-01T00:00:00Z',
|
|
'2025-01-02T00:00:00Z',
|
|
);
|
|
expect(result).not.toHaveProperty('error');
|
|
if ('error' in result) return;
|
|
|
|
expect(result.startDate.toISOString()).toBe('2025-01-01T00:00:00.000Z');
|
|
expect(result.endDate.toISOString()).toBe('2025-01-02T00:00:00.000Z');
|
|
});
|
|
|
|
it('should default startTime to 15 minutes before endTime', () => {
|
|
const result = parseTimeRange(undefined, '2025-06-15T10:00:00Z');
|
|
expect(result).not.toHaveProperty('error');
|
|
if ('error' in result) return;
|
|
|
|
expect(result.endDate.toISOString()).toBe('2025-06-15T10:00:00.000Z');
|
|
expect(result.startDate.toISOString()).toBe('2025-06-15T09:45:00.000Z');
|
|
});
|
|
|
|
it('should default endTime to now', () => {
|
|
const before = Date.now();
|
|
const result = parseTimeRange('2025-06-15T11:00:00Z');
|
|
const after = Date.now();
|
|
|
|
expect(result).not.toHaveProperty('error');
|
|
if ('error' in result) return;
|
|
|
|
expect(result.startDate.toISOString()).toBe('2025-06-15T11:00:00.000Z');
|
|
expect(result.endDate.getTime()).toBeGreaterThanOrEqual(before);
|
|
expect(result.endDate.getTime()).toBeLessThanOrEqual(after);
|
|
});
|
|
|
|
it('should return error for invalid startTime', () => {
|
|
const result = parseTimeRange('not-a-date', '2025-01-01T00:00:00Z');
|
|
expect(result).toHaveProperty('error');
|
|
if (!('error' in result)) return;
|
|
|
|
expect(result.error).toContain('Invalid');
|
|
});
|
|
|
|
it('should return error for invalid endTime', () => {
|
|
const result = parseTimeRange('2025-01-01T00:00:00Z', 'garbage');
|
|
expect(result).toHaveProperty('error');
|
|
if (!('error' in result)) return;
|
|
|
|
expect(result.error).toContain('Invalid');
|
|
});
|
|
|
|
it('should return error when both times are invalid', () => {
|
|
const result = parseTimeRange('bad', 'also-bad');
|
|
expect(result).toHaveProperty('error');
|
|
});
|
|
});
|