get_board
Retrieve detailed information about a specific dashboard from a Honeycomb environment, including ID, name, description, and timestamps. Ideal for accessing and analyzing board data directly.
Instructions
Retrieves a specific board (dashboard) from a Honeycomb environment. This tool returns a detailed object containing the board's ID, name, description, creation time, and last update time.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | The ID of the board to retrieve | |
| environment | Yes | The Honeycomb environment |
Implementation Reference
- src/tools/get-board.ts:25-54 (handler)Core handler function executing the get_board tool logic: validates parameters, fetches board data via API, formats response as MCP content with metadata, handles errors.handler: async ({ environment, boardId }: z.infer<typeof GetBoardSchema>) => { // Validate input parameters if (!environment) { return handleToolError(new Error("environment parameter is required"), "get_board"); } if (!boardId) { return handleToolError(new Error("boardId parameter is required"), "get_board"); } try { // Fetch board from the API const board = await api.getBoard(environment, boardId); return { content: [ { type: "text", text: JSON.stringify(board, null, 2), }, ], metadata: { environment, boardId, name: board.name } }; } catch (error) { return handleToolError(error, "get_board"); }
- src/types/schema.ts:355-358 (schema)Zod schema defining input parameters for the get_board tool: required environment and boardId strings.export const GetBoardSchema = z.object({ environment: z.string().min(1).trim().describe("The Honeycomb environment"), boardId: z.string().min(1).trim().describe("The ID of the board to retrieve"), }).describe("Parameters for retrieving a specific Honeycomb board with all its queries and visualizations.");
- src/tools/index.ts:37-37 (registration)Creation of the get_board tool instance using createGetBoardTool(api), added to tools array and subsequently registered with MCP server in registerTools function.createGetBoardTool(api),
- src/api/client.ts:717-736 (helper)HoneycombAPI.getBoard method: retrieves specific board by ID from API with caching support, called by the tool handler.async getBoard(environment: string, boardId: string): Promise<Board> { const cache = getCache(); // Check cache first const cachedBoard = cache.get<Board>(environment, 'board', boardId); if (cachedBoard) { return cachedBoard; } // Fetch from API if not in cache const board = await this.requestWithRetry<Board>( environment, `/1/boards/${boardId}` ); // Cache the result cache.set<Board>(environment, 'board', board, boardId); return board; }