Skip to main content
Glama

dForms

Get a workspace link page

get_link_page
Read-onlyIdempotent

One of the workspace public pages: the default one (at /{accountCode}) unless page_id names another. Answers the stored page or null, whether it is live at public_url, the forms a button can point at and the brand kit it is styled with. Typically read before update_link_page, since that call replaces the whole page. Any member can use it.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_link_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
page_idNoThe page id, from list_link_pages. Absent: the default page, the one at /{accountCode}.
workspace_idNoThe workspace this call acts in: an id from list_my_workspaces. Required for a person signed in with several workspaces and for staff of this deployment; optional with an API key or with only one workspace.

Output Schema

NameRequiredDescriptionDefault
liveYesTrue when the page is saved with enabled: true, so public_url serves it. False: public_url answers 404.
nameYesThe internal name; blank when nobody named it.
pageYesThe stored page, ready to send back to update_link_page after changing it; null when there is none.
slugYesThe page slug; the default page is served at /{accountCode} whatever its slug.
formsYesThe workspace forms a form button can point at, by id.
page_idYesThe page id; null when the workspace has no page yet.
brand_kitYesThe brand kit the page takes its type, default colors and default logo from.
workspaceYesThe workspace this call acted in, to compare with the one the user means.
is_defaultYesTrue for the page at /{accountCode}.
public_urlYesThe page address, to give to users exactly as returned; null when the deployment has no public address.
account_codeYesThe workspace code the pages live under.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds value beyond that: a null result when no page exists, a liveness signal at public_url, the permission breadth (any member), and the warning that update_link_page replaces the entire page. It does not discuss caching, ordering, or rate behavior, but nothing required is missing.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four compact sentences, front-loaded with the resource and its default-page scoping before the return contents and the update_link_page caveat. Every sentence carries information. The opening nominal fragment ("One of the workspace public pages:") is slightly awkward as a lead, keeping it from a 5.

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?

An output schema exists, so the description need not fully specify return values, yet it still summarizes them usefully. Access requirements, default-page semantics, the null case, and the paired mutation tool are all covered. Only marginal gaps remain, such as interaction with list_link_pages or pagination-style concerns, which are minimal for a two-parameter read.

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 100%, so both parameters are already documented, including page_id's default-page fallback and workspace_id's conditional requirement. The description restates the page_id default and the '{accountCode}' path form but adds no new syntax or edge-case detail, and says nothing about workspace_id. Baseline 3 is appropriate when the schema does the heavy lifting.

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 states a concrete resource (the workspace public link page) and pins down the default-page behavior at /{accountCode} versus a page named by page_id. It also enumerates what is answered back (stored page or null, live status, button forms, brand kit), which distinguishes it from update_link_page and list_link_pages. The verb itself is left implicit ("Answers") and the title carries it, so it falls just short of a 5.

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 explicitly positions the tool before update_link_page, explaining why (that call replaces the whole page), which is real when-to-use guidance tied to a named sibling. It also gives an access condition ("Any member can use it"). There is no explicit statement of when not to call it, e.g. versus list_link_pages for enumeration, so it lands at 4 rather than 5.

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