Skip to main content
Glama

add_connector

Connects two board objects with an arrow that follows them when moved; use IDs from add_shape or describe_board to link shapes.

Instructions

Connects two objects with an arrow that follows them when they move (ids returned by add_shape or describe_board).

Input Schema

NameRequiredDescriptionDefault
toYes
fromYes
pageNoPage: number (from 1) or name. Defaults to the first.
pathNoPath of the board file (.inkboard; .inkboard.json and .tableau.json also accepted). Optional when the application is open: the tool then acts live on the displayed board (undoable with Ctrl+Z).
arrowNoArrowheads (default: end).
labelNo
routeNo
strokeNoColor "#rrggbb" or "ink" (the theme's text color).
markdownNoDefault false (text taken literally). true: `label` is Markdown: **bold**, *italic* (or _italic_), __underline__, ~~strike~~, {color=#e03131}text{/}, {bg=#ffec99}text{/}, {color=#e03131 bg=ink}text{/} (colors: #rrggbb or ink); nesting allowed; \ escapes * _ ~ { } \. Markup that cannot be applied stays literal text and is listed in the `warnings` of the result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations, so the description carries the full burden. It discloses one genuinely valuable behavioral trait — connectors re-anchor and follow objects when moved — but says nothing about whether the connector itself is returned with an id, whether the call is undoable, permission/board-context needs, or what happens with invalid ids. Safety and mutation semantics are left entirely implicit.

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?

One sentence, front-loaded with the action and behavior, with the id-provenance hint tucked into a parenthetical. Every clause earns its place and nothing is padded.

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 9-parameter mutation tool with no annotations and no output schema, a single sentence is thin: the return value (does it return the new connector's id?), live-vs-file behavior, and error conditions are unaddressed. The schema does cover the trickier parameters (path, arrow, stroke, markdown), which keeps this from being inadequate, but the description should do more for a write 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 56% across 9 parameters; 'from', 'to', 'label' and 'route' have no schema descriptions. The description usefully clarifies that from/to are object ids sourced from add_shape or describe_board, which is real added meaning, but it says nothing about arrow, route, stroke, label or page.

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?

A precise verb-plus-resource statement: 'connects two objects with an arrow', plus the non-obvious property that the connector follows the objects when they move. It even names the sibling tools that supply the required ids (add_shape, describe_board), so an agent can distinguish it from add_shape or format_text without opening a schema.

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

Usage Guidelines3/5

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

Usage is implied rather than stated, but the parenthetical gives a genuine prerequisite: from/to must be object ids obtained from add_shape or describe_board. There is no when-not guidance, no mention of what to do when ids are stale or objects are on different pages, and no alternative routing (e.g. import_mermaid for bulk connectors).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.