Skip to main content
Glama

get-group

Retrieve information about a specific group on a Miro board by providing the board ID and group ID.

Instructions

Retrieve information about a specific group on a Miro board

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardIdYesID of the board that contains the group
groupIdYesID of the group that you want to retrieve

Implementation Reference

  • The handler function executes the tool logic: validates inputs, calls MiroClient.getApi().getGroupById(boardId, groupId), stringifies and returns the result, or handles errors.
    fn: async ({ boardId, groupId }) => {
      try {
        if (!boardId) {
          return ServerResponse.error("Board ID is required");
        }
    
        if (!groupId) {
          return ServerResponse.error("Group ID is required");
        }
    
        const result = await MiroClient.getApi().getGroupById(boardId, groupId);
    
        return ServerResponse.text(JSON.stringify(result, null, 2));
      } catch (error) {
        process.stderr.write(`Error retrieving group: ${error}\n`);
        return ServerResponse.error(error);
      }
    }
  • Tool schema defining name, description, and input arguments schema using Zod for boardId and groupId.
    name: "get-group",
    description: "Retrieve information about a specific group on a Miro board",
    args: {
      boardId: z.string().describe("ID of the board that contains the group"),
      groupId: z.string().describe("ID of the group that you want to retrieve")
    },
  • src/index.ts:180-180 (registration)
    Registers the getGroupTool with the ToolBootstrapper instance.
    .register(getGroupTool)
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'retrieve information' which implies a read-only operation, but does not disclose behavioral traits like authentication needs, rate limits, error handling, or what specific information is returned (e.g., group metadata, permissions). This leaves gaps for a tool with no annotation coverage.

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 is front-loaded and appropriately sized for its function.

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

Completeness3/5

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

Given no annotations and no output schema, the description is minimal but covers the basic purpose. It lacks details on return values, error cases, or operational context, making it adequate but incomplete for a read operation tool in this environment.

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 clear descriptions for 'boardId' and 'groupId'. The description adds no additional parameter semantics beyond what the schema provides, such as format examples or constraints. Baseline 3 is appropriate as the schema adequately documents parameters.

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 verb 'retrieve' and resource 'information about a specific group on a Miro board', making the purpose evident. However, it does not explicitly differentiate from sibling tools like 'get-all-groups' (which retrieves multiple groups) or 'get-group-items' (which retrieves items within a group), missing full sibling distinction.

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 such as 'get-all-groups' for listing groups or 'get-group-items' for group contents. The description implies usage for a specific group but lacks explicit context or exclusions.

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