Skip to main content
Glama

Link page

swebsy_link_page

Wire an existing link to a project page by setting its page target or href, keeping navbar hrefs and active states in sync after page creation.

Instructions

Point an existing link at a project page — the same wiring the UI's 'Link to' picker does. Pass the link's targetId or targetPath (from read_page) and the target page (id or name). For a navbar link this sets its page target so the href and active state stay in sync; for a plain link or button it sets href to the page's ./slug.html. Use after create_page to wire a navbar to the new page.

Input Schema

NameRequiredDescriptionDefault
pageYesPage id or name to link to.
targetIdNoThe link by its id, as `read_page` shows it after `#` (e.g. "ieyubib", or "call-2-2" in a symbol instance). Stays valid when other components move or are added, unlike a path. Pass this OR the path, not both.
targetPathNoZero-based component indexes from the current page root, exactly as returned by `read_page` (e.g. the nav link inside the navbar).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.13.1
    • addedInput schema / properties / targetId
      Added value: +{
      +  "description": "The link by its id, as `read_page` shows it after `#` (e.g. \"ieyubib\", or \"call-2-2\" in a symbol instance). Stays valid when other components move or are added, unlike a path. Pass this OR the path, not both.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "targetPath",
      -  "page"
      -]New value: +[
      +  "page"
      +]
  2. First observedv0.8.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare the operation is non-read-only and non-destructive, so the description adds useful specifics: for navbar links it sets the page target so href and active state stay in sync, and for plain links/buttons it sets href to the page's ./slug.html. It does not cover failure modes or permission requirements, but the added behavioral detail is substantial.

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 sentences, front-loaded with the core action and followed by parameter guidance and usage context. Every sentence adds information without repetition or 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?

The definition covers purpose, parameters, mutation behavior, and the common create_page-to-navbar workflow. Given rich schema coverage and annotations, it is nearly complete; only edge cases such as missing target/page errors are unaddressed.

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 explains targetId, targetPath, and page in detail. The description reinforces the read_page workflow and the id-or-name choice for page, but does not add syntax or format meaning beyond what the schema provides.

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?

The description states a specific verb and resource: pointing an existing link at a project page, matching the UI's 'Link to' picker. It clearly distinguishes this from sibling operations such as create_page and read_page by describing the exact wiring behavior.

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?

It gives clear usage context, including 'Use after create_page to wire a navbar to the new page' and explains behavior for navbar links versus plain links/buttons. It does not explicitly name when not to use it or alternative tools, which keeps it below a 5.

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