Skip to main content
Glama

get-connectors

Retrieve all connectors from a Miro board to access connection data between board elements for analysis or integration purposes.

Instructions

Retrieve all connectors on a specific Miro board

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
boardIdYesUnique identifier (ID) of the board whose connectors you want to retrieve
limitNoMaximum number of connectors to return (default: 50)
cursorNoCursor for pagination

Implementation Reference

  • The handler function that implements the logic for the 'get-connectors' tool. It validates the boardId, prepares query parameters, calls the MiroClient API to retrieve connectors, and returns the result or error.
    fn: async ({ boardId, limit, cursor }) => {
      try {
        if (!boardId) {
          return ServerResponse.error("Board ID is required");
        }
    
        const queryParams: { limit?: string; cursor?: string } = {};
        if (limit) queryParams.limit = limit.toString();
        if (cursor) queryParams.cursor = cursor;
    
        const connectorsData = await MiroClient.getApi().getConnectors(boardId, queryParams);
        return ServerResponse.text(JSON.stringify(connectorsData, null, 2));
      } catch (error) {
        return ServerResponse.error(error);
      }
    }
  • The schema definition for the 'get-connectors' tool, including name, description, and Zod-based input schema for parameters.
    const getConnectorsTool: ToolSchema = {
      name: "get-connectors",
      description: "Retrieve all connectors on a specific Miro board",
      args: {
        boardId: z.string().describe("Unique identifier (ID) of the board whose connectors you want to retrieve"),
        limit: z.number().optional().nullish().describe("Maximum number of connectors to return (default: 50)"),
        cursor: z.string().optional().nullish().describe("Cursor for pagination")
      },
  • src/index.ts:130-130 (registration)
    Registration of the 'get-connectors' tool via ToolBootstrapper's register method in the main index file.
    .register(getConnectorsTool)
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 'retrieves' data, implying a read-only operation, but doesn't disclose pagination behavior (implied by 'cursor' parameter), rate limits, authentication requirements, or error conditions. The description adds little beyond what's obvious from the tool name.

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 with zero wasted words. It's appropriately front-loaded and earns its place by clearly communicating the core functionality.

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?

For a read operation with 100% schema coverage but no output schema, the description is minimally adequate. It specifies the resource (connectors) and scope (board), but lacks context about return format, pagination behavior, or error handling. Given the absence of annotations and output schema, more behavioral context would be 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 clear documentation for all three parameters (boardId, limit, cursor). The description doesn't add any parameter semantics beyond what the schema provides—it mentions 'specific Miro board' which aligns with boardId but offers no additional context about parameter usage or interactions.

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 ('all connectors on a specific Miro board'), making the purpose unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'get-specific-connector' or 'get-items-on-board', which might retrieve similar data with different scopes or filters.

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 sibling tools like 'get-specific-connector' (for a single connector) or 'get-items-on-board' (which might include connectors among other items), leaving the agent to infer usage context from tool names alone.

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