Skip to main content
Glama

get_miro_board

Retrieve details for a specific Miro board by providing its board ID, enabling access to board information within the Learning Hour MCP server for technical coaching sessions.

Instructions

Get details about a specific Miro board

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardIdYesID of the Miro board to get details for

Implementation Reference

  • Main handler function for the 'get_miro_board' tool. Extracts boardId from input arguments, checks for Miro integration, calls MiroIntegration.getBoardInfo, and returns formatted text blocks with board details.
    private async getMiroBoard(args: any) {
      try {
        if (!this.miroIntegration) {
          throw new Error('Miro integration not initialized. Ensure MIRO_ACCESS_TOKEN is set in the environment.');
        }
    
        const boardId = args.boardId;
        if (!boardId) {
          throw new Error('Board ID is required');
        }
    
        const board = await this.miroIntegration.getBoardInfo(boardId);
    
        return {
          content: [
            {
              type: "text",
              text: `Board Details:`,
            },
            {
              type: "text",
              text: `Name: ${board.name}`,
            },
            {
              type: "text",
              text: `ID: ${board.id}`,
            },
            {
              type: "text",
              text: `Description: ${board.description || 'No description'}`,
            },
            {
              type: "text",
              text: `View Link: ${board.viewLink}`,
            },
            {
              type: "text",
              text: `Created: ${board.createdAt}`,
            },
            {
              type: "text",
              text: `Modified: ${board.modifiedAt}`,
            },
          ],
        };
      } catch (error) {
        throw new Error(`Failed to get Miro board: ${error instanceof Error ? error.message : String(error)}`);
      }
    }
  • Core helper method in MiroIntegration class that performs the actual API call to Miro's /boards/{boardId} endpoint to fetch board information.
    async getBoardInfo(boardId: string): Promise<MiroBoard> {
      try {
        const response = await axios.get(`${this.miroApiUrl}/boards/${boardId}`, {
          headers: {
            'authorization': `Bearer ${this.accessToken}`,
          }
        });
    
        return response.data;
      } catch (error) {
        throw new Error(`Failed to get board info: ${error instanceof Error ? error.message : String(error)}`);
      }
    }
  • src/index.ts:202-215 (registration)
    Tool registration entry in the ListTools response, defining the tool name, description, and input schema requiring a 'boardId' string.
    {
      name: "get_miro_board",
      description: "Get details about a specific Miro board",
      inputSchema: {
        type: "object",
        properties: {
          boardId: {
            type: "string",
            description: "ID of the Miro board to get details for",
          },
        },
        required: ["boardId"],
      },
    },
  • TypeScript interface defining the structure of a MiroBoard object returned by the getBoardInfo method.
    interface MiroBoard {
      id: string;
      name: string;
      description?: string;
      createdAt: string;
      modifiedAt: string;
      viewLink: string;
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It states it 'gets details' but doesn't disclose what details are returned, error conditions, authentication needs, rate limits, or whether it's read-only (implied but not confirmed). This is inadequate for a tool with zero annotation coverage, lacking critical context for safe invocation.

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, clear sentence with zero waste—it directly states the tool's function without fluff. It's appropriately sized for a simple retrieval tool and front-loaded with the core action, making it easy to parse quickly. Every word earns its place.

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?

Given the tool's simplicity (1 parameter, 100% schema coverage) but lack of annotations and output schema, the description is incomplete. It doesn't explain what 'details' are returned, potential errors, or behavioral traits, leaving the AI agent under-informed. For a retrieval tool with no structured output, more context is needed to be fully helpful.

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%, with the parameter 'boardId' fully documented in the schema. The description adds no additional meaning beyond implying retrieval for a 'specific Miro board', which aligns with the schema. Since the schema does the heavy lifting, the baseline score of 3 is appropriate, as the description doesn't compensate or add extra value.

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 ('Get details') and resource ('about a specific Miro board'), making the purpose immediately understandable. It doesn't explicitly differentiate from sibling tools like 'list_miro_boards' or 'create_miro_board', but the specificity of 'specific Miro board' versus 'list' implies scope distinction. No tautology or misleading elements are present.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a board ID), contrast with 'list_miro_boards' for browsing, or specify use cases like retrieving metadata for editing. Usage is implied by the name but not explicitly stated, leaving gaps for an AI agent.

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/SDiamante13/learning-hour-mcp'

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