Skip to main content
Glama

Add symbol instance

swebsy_add_symbol_instance

Add a linked INSTANCE of an existing symbol (see list_symbols) to the CURRENT page. The instance stays in sync with the symbol main and every other instance — the way to reuse one navbar/footer/CTA across pages. Select the target page with select_page first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
positionNoWhere to place it on the page: 'start' prepends (e.g. a shared navbar), 'end' appends (e.g. a shared footer). 'before-selected'/'after-selected' land it next to `targetPath` — how you put a shared CTA ABOVE an existing footer without deleting the footer. Default 'end'.
symbolIdYesId of the symbol main (from list_symbols).
targetPathNoZero-based component indexes from read_page identifying the section to sit next to. Required for 'before-selected'/'after-selected' — an agent has no canvas selection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations only cover the safety profile (readOnly=false, destructive=false, openWorld=false). The description adds substantive behavioral context beyond that: instances remain linked and stay in sync with the symbol main and all other instances. It also implies the operation affects the currently selected page, a meaningful side-effect note. It doesn't describe failure modes if no page is selected, keeping it just short of 5.

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?

Three tight sentences, front-loaded with the action and resource before the rationale. Every clause carries information — sync behavior, the reuse pattern, and the page-selection prerequisite — with no filler.

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?

For a mutation tool with annotations covering safety and a fully-documented schema, the description supplies the missing behavioral context (linking/sync semantics) and the required prerequisite sequence (list_symbols, select_page). No output schema exists but the effect is well-enough implied; minor gap on error/precondition behavior when no page is selected.

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%, so the schema already documents symbolId, position, and targetPath thoroughly (including enum meanings and the before/after-selected target requirement). The description largely restates that the target is the CURRENT page and references list_symbols for symbolId, adding little beyond the schema. Baseline 3 applies.

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?

States a specific verb (Add) and resource (a linked INSTANCE of an existing symbol) and explains the mechanism that makes it a distinct operation: it stays in sync with the symbol main and other instances. It clearly separates itself from add_section and promote_to_symbol by naming the reuse goal (one navbar/footer/CTA across pages).

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

Usage Guidelines4/5

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

Provides explicit prerequisites and pointers — call list_symbols to get the symbolId and select_page to set the target page before invoking. It also frames the use case (reusing a shared element across pages) which implies when to choose this over other add options, though it does not explicitly contrast against add_section or insert_block.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources