Skip to main content
Glama

miro_get_document

Read-only

Retrieve a document's details from a Miro board, including its hosted URL and title.

Instructions

Get details of a document on a Miro board, including its Miro-hosted URL and title. For image items, use miro_get_image instead.

USE WHEN: "get document details", "what document is this", "document URL"

VOICE-FRIENDLY: "Document 'Q4 Report' hosted at Miro"

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
item_idYesDocument item ID
board_idYesBoard ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
xNo
yNo
idYes
titleNo
widthNo
heightNo
messageYes
parent_idNo
document_urlNo
Behavior4/5

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

Annotations already mark readOnlyHint=true, so the description's behavioral disclosure is less critical. It adds context by stating it returns URL and title, and includes a voice-friendly example. No contradictions with annotations.

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?

Extremely concise: three sentences covering purpose, usage, and a voice-friendly example. No redundant words; front-loaded with key information.

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

Completeness4/5

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

Given an output schema exists, the description need not detail return values. It covers purpose, usage, and alternative tools sufficiently. Slightly lacking in edge-case information but complete for a straightforward get tool.

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 coverage is 100%, so the description does not need to add parameter meaning beyond what the schema provides. Baseline 3 is appropriate as no additional param details are offered.

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 'Get details of a document on a Miro board, including its Miro-hosted URL and title,' using a specific verb and resource. It distinguishes from the sibling tool miro_get_image by explicitly noting when to use that alternative.

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?

Provides explicit 'USE WHEN' phrases such as 'get document details', 'what document is this', and 'document URL', guiding the agent on appropriate contexts. Also indicates when not to use (for image items).

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