get-embed-item
Retrieve detailed information about a specific embed item on a Miro board by providing the board ID and embed item ID.
Instructions
Retrieve information about a specific embed item on a Miro board
Input 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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "Unique identifier (ID) of the board that contains the embed",
"type": "string"
},
"itemId": {
"description": "Unique identifier (ID) of the embed that you want to retrieve",
"type": "string"
}
},
"required": [
"boardId",
"itemId"
],
"type": "object"
}
Implementation Reference
- src/tools/getEmbedItem.ts:13-28 (handler)The main handler function for the 'get-embed-item' tool. It validates the required boardId and itemId parameters, calls the MiroClient API to fetch the embed item, and returns the JSON result or an error response.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:9-12 (schema)Zod schema defining the input parameters for the tool: boardId and itemId as strings with descriptions.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:162-162 (registration)Registers the getEmbedItemTool with the ToolBootstrapper instance in the main server index file..register(getEmbedItemTool)
- src/index.ts:62-62 (registration)Imports the getEmbedItemTool from its implementation file for registration.import getEmbedItemTool from './tools/getEmbedItem.js';