get-embed-item
Retrieve details of a specific embed item on a Miro board using board and item IDs to access embedded content information.
Instructions
Retrieve information about a specific embed item on a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that contains the embed | |
| itemId | Yes | Unique identifier (ID) of the embed that you want to retrieve |
Implementation Reference
- src/tools/getEmbedItem.ts:13-28 (handler)The handler function implementing the 'get-embed-item' tool logic. Validates inputs, calls Miro API to retrieve the embed item, formats the response, and handles errors.
fn: async ({ boardId, itemId }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!itemId) { return ServerResponse.error("Item ID is required"); } const result = await MiroClient.getApi().getEmbedItem(boardId, itemId); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { return ServerResponse.error(error); } } - src/tools/getEmbedItem.ts:6-12 (schema)Schema definition for the 'get-embed-item' tool, including name, description, and Zod schemas for input parameters boardId and itemId.
const getEmbedItemTool: ToolSchema = { name: "get-embed-item", description: "Retrieve information about a specific embed item on a Miro board", args: { boardId: z.string().describe("Unique identifier (ID) of the board that contains the embed"), itemId: z.string().describe("Unique identifier (ID) of the embed that you want to retrieve") }, - src/index.ts:62-62 (registration)Import statement for the getEmbedItemTool module.
import getEmbedItemTool from './tools/getEmbedItem.js'; - src/index.ts:162-162 (registration)Registration of the getEmbedItemTool in the ToolBootstrapper instance.
.register(getEmbedItemTool)