Skip to main content
Glama

miro_update_document_from_file

Replace the file on an existing document item with a new local document. Supports PDF, Word, Excel, and other file types.

Instructions

Replace the file on an existing document item with a new local document file.

USE WHEN: User says "replace this document", "update the PDF", "swap the file on this document". Use this to change the file on an existing document item without creating a new one. For updating metadata only (title, position), use miro_update_document instead.

PARAMETERS:

  • board_id: Required

  • item_id: Required. The existing document item to update.

  • file_path: Absolute path to the new document file (required). Supports: pdf, doc, docx, ppt, pptx, xls, xlsx, txt, rtf, csv. Max 6 MB.

  • title: New document title

  • x, y: New position

  • parent_id: Frame ID to move document into

NOTE: The item must already exist as a document. The file must exist on the local filesystem.

RELATED: To create a new document from file, use miro_upload_document. To update metadata only, use miro_update_document.

VOICE-FRIENDLY: "Replaced document file on item"

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
board_idYesBoard ID
item_idYesDocument item ID to update
file_pathYesAbsolute path to the new document file on disk
titleNoNew document title
xNoNew X position
yNoNew Y position
parent_idNoFrame ID to move document into

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
item_urlNo
titleNo
messageYes
Behavior4/5

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

Annotations are minimal (only title). The description adds useful behavioral context: file must exist locally, supported formats, max 6 MB, and that the item must already be a document. However, it does not disclose whether the operation is destructive or reversible.

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?

Well-structured with sections (USE WHEN, PARAMETERS, NOTE, RELATED, VOICE-FRIENDLY). Front-loaded with purpose, no irrelevant sentences.

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

Completeness5/5

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

Given the tool has 7 parameters (3 required) and an output schema exists, the description covers purpose, parameter constraints, usage context, and related tools thoroughly. No gaps.

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

Parameters4/5

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

Schema coverage is 100%, but the description adds value by specifying supported file formats and max size for file_path, and clarifying that item_id refers to an existing document item. This goes beyond the schema descriptions.

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

Purpose5/5

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

The description clearly states it replaces the file on an existing document item with a new local file. It distinguishes from siblings (miro_update_document for metadata only, miro_upload_document for creating new).

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

Usage Guidelines5/5

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

Includes explicit 'USE WHEN' examples (replace this document, update the PDF, swap the file) and explicitly contrasts with alternative tools for different use cases (metadata updates, creation).

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/olgasafonova/miro-mcp-server'

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