Skip to main content
Glama

update-frame-item

Modify a frame's properties on a Miro board, including its content, position, size, and style.

Instructions

Update a frame on a Miro board based on the data, style, or geometry properties provided in the request body

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardIdYesUnique identifier (ID) of the board where you want to update the frame
itemIdYesUnique identifier (ID) of the frame that you want to update
dataNoThe updated content and configuration of the frame
positionNoUpdated position of the frame on the board
geometryNoUpdated dimensions of the frame
styleNoUpdated style configuration of the frame

Implementation Reference

  • The asynchronous handler function that validates inputs, constructs a FrameUpdateRequest object, and calls the Miro API to update the frame item.
    fn: async ({ boardId, itemId, data, position, geometry, style }: {
      boardId: string,
      itemId: string,
      data?: {
        title?: string,
        format?: string,
        type?: string,
        showContent?: boolean
      },
      position?: {
        x: number,
        y: number
      },
      geometry?: {
        width?: number,
        height?: number
      },
      style?: {
        fillColor?: string
      }
    }) => {
      try {
        if (!boardId) {
          return ServerResponse.error("Board ID is required");
        }
    
        if (!itemId) {
          return ServerResponse.error("Item ID is required");
        }
    
        const updateRequest = new FrameUpdateRequest();
        
        if (data) {
          const frameData = new FrameChanges();
          
          if (data.title !== undefined) frameData.title = data.title;
          if (data.format !== undefined) frameData.format = data.format;
          if (data.type !== undefined) frameData.type = data.type;
          if (data.showContent !== undefined) frameData.showContent = data.showContent;
          
          updateRequest.data = frameData;
        }
        
        if (position) {
          updateRequest.position = position;
        }
        
        if (geometry) {
          updateRequest.geometry = geometry;
        }
        
        if (style) {
          updateRequest.style = style;
        }
    
        const result = await MiroClient.getApi().updateFrameItem(boardId, itemId, updateRequest);
        return ServerResponse.text(JSON.stringify(result, null, 2));
      } catch (error) {
        return ServerResponse.error(error);
      }
    }
  • ToolSchema definition including name, description, and Zod input schema for parameters.
    const updateFrameItemTool: ToolSchema = {
      name: "update-frame-item",
      description: "Update a frame on a Miro board based on the data, style, or geometry properties provided in the request body",
      args: {
        boardId: z.string().describe("Unique identifier (ID) of the board where you want to update the frame"),
        itemId: z.string().describe("Unique identifier (ID) of the frame that you want to update"),
        data: z.object({
          title: z.string().optional().nullish().describe("Title of the frame. This title appears at the top of the frame."),
          format: z.string().optional().nullish().describe("Format of the frame. Only 'custom' is supported currently."),
          type: z.string().optional().nullish().describe("Type of the frame. Only 'freeform' is supported currently."),
          showContent: z.boolean().optional().nullish().describe("Hide or reveal the content inside a frame (Enterprise plan only).")
        }).optional().nullish().describe("The updated content and configuration of the frame"),
        position: z.object({
          x: z.number().describe("X coordinate of the frame"),
          y: z.number().describe("Y coordinate of the frame")
        }).optional().nullish().describe("Updated position of the frame on the board"),
        geometry: z.object({
          width: z.number().optional().nullish().describe("Width of the frame"),
          height: z.number().optional().nullish().describe("Height of the frame")
        }).optional().nullish().describe("Updated dimensions of the frame"),
        style: z.object({
          fillColor: z.string().optional().nullish().describe("Fill color for the frame. Hex values like #f5f6f8, #d5f692, etc.")
        }).optional().nullish().describe("Updated style configuration of the frame")
      },
  • src/index.ts:140-140 (registration)
    Registration of the updateFrameItemTool in the ToolBootstrapper.
    .register(updateFrameItemTool)
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states it's an update operation, implying mutation, but doesn't cover critical aspects like required permissions, whether changes are reversible, error handling, or response format. For a mutation tool with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every part of the sentence contributes essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what happens on success or failure, any side effects, or how partial updates are handled. Given the complexity of updating multiple property types, more context is needed to guide effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds minimal value by listing the categories of properties ('data, style, or geometry') but doesn't provide additional syntax, constraints, or examples beyond what's in the schema. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Update a frame') and the resource ('on a Miro board'), specifying the properties that can be updated ('data, style, or geometry properties'). It distinguishes from siblings like 'create-frame' or 'delete-frame-item' by focusing on modification, but doesn't explicitly differentiate from other update tools like 'update-item-position' which might overlap in functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. For example, it doesn't mention when to choose 'update-item-position' for only positional changes or 'update-frame-item' for broader updates. There's no information on prerequisites, such as needing board and item IDs, or context for when frame updates are appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/k-jarzyna/mcp-miro'

If you have feedback or need assistance with the MCP directory API, please join our Discord server