Skip to main content
Glama

Suggest a link

suggest_link
Read-only

The share link a NEW doc would get, before you publish it. People want to see and name their link before it exists, because changing it later breaks the copies already sent. So before host_html_content or finalize_upload creates a new doc, call this with the name you will publish under, show the person the full link, and ask whether they want a different ending, the part after the last slash. Pass the ending they settle on to the publish call as slug. Skip the question when they already chose the link or asked you to just publish. To check an ending they suggest, pass it as slug here. The answer says whether it is free and offers one that is if not. A name that matches one of their docs returns that doc's current link instead, because publishing under it updates that doc and keeps its link.

Input Schema

NameRequiredDescriptionDefault
nameYesThe page name you will publish under.
slugNoOptional. An ending the person suggested, to check. A whole link works too; only the part after the last slash counts. Defaults to one made from the name.
accountNoEmail address of the farm to act on. Omit for the signed-in farm. Only a connected account is accepted; call list_accounts to see which.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnly/non-destructive/openWorld=false; the description adds non-obvious behavior: the answer reports whether the ending is free and offers an alternative if not, and a name matching an existing doc returns that doc's current link because publishing updates that doc in place.

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?

Front-loads what the tool returns, then the workflow, then the skip condition. Dense and largely earned, though the motivational aside ('People want to see and name their link before it exists...') adds a sentence that could be trimmed.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description carries the return-value burden and does so: it explains the response reports availability and offers a fallback ending. The name-collision case is also covered, leaving no major gap for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3, but the description adds real meaning: slug is 'the ending they settle on' passed to the publish call, a whole link is acceptable with only the post-slash part counting, and name drives the default. It clarifies how the params connect to the downstream publish call.

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+resource+scope: it returns 'the share link a NEW doc would get, before you publish it.' It explicitly positions itself relative to siblings host_html_content and finalize_upload, so an agent can tell it apart without opening schemas.

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

Usage Guidelines5/5

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

Gives explicit when-to-use (before host_html_content or finalize_upload creates a new doc), explicit when-to-skip (when the person already chose the link or asked to just publish), and the alternative path for validating a suggested ending via slug.

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