get_board
Retrieve a specific dashboard from Honeycomb observability data to access its ID, name, description, and timestamps for analysis.
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 |
|---|---|---|---|
| environment | Yes | The Honeycomb environment | |
| boardId | Yes | The ID of the board to retrieve |
Implementation Reference
- src/tools/get-board.ts:25-55 (handler)The async handler function for the 'get_board' tool. Validates environment and boardId parameters, fetches the board using HoneycombAPI.getBoard, formats the response as MCP content with metadata, and 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-359 (schema)Zod schema defining the input parameters for the get_board tool: required environment (string) and boardId (string).
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)The get_board tool is instantiated via createGetBoardTool(api) and added to the array of tools that are registered with the MCP server in the registerTools function.
createGetBoardTool(api),