Skip to main content
Glama

dForms

Get the workspace link code

get_workspace_link_code
Read-onlyIdempotent

The code every public form link of this workspace starts with: the custom one (vanity_slug) when the workspace claimed one, else its short code, and whether a custom one can still be claimed. Claiming one is done in the dForms dashboard. Form links are not built from it: the form tools return each exact public_url.

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_workspace_link_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
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
can_claimYes
workspaceYesThe workspace this call acted in, to compare with the one the user means.
short_codeYesThe code links use when there is no custom one.
vanity_slugYesThe custom code, or null when none was claimed.

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 readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered; the description adds scope semantics instead — that the code is workspace-wide and shared across all public form links, and that the response also reports whether a custom slug can still be claimed. It also discloses that this tool cannot perform the claim action, preventing a failed attempt. No contradictions with the read-only annotations.

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?

Three sentences, no filler, and the most load-bearing constraint (links are not built from this code) is stated plainly. The first sentence is a long nested clause with two parenthetical insertions, which slightly slows parsing, but every sentence carries distinct information.

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 return shape needn't be spelled out, and the description still conveys the semantic meaning of the returned values (custom slug vs short code vs claimable). For a single-parameter read tool with full annotations, the remaining need is minor. Adding a concrete use case for retrieving the code would make it complete.

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% and the single workspace_id parameter is fully documented in the schema, including its optionality for API-key and single-workspace callers. The description only echoes the workspace scoping ('of this workspace') without adding format or resolution detail beyond the schema. Baseline 3 applies 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 identifies the resource precisely: the prefix code shared by every public form link of a workspace, distinguishing the custom vanity_slug from the fallback short code and adding a claimable flag. It also explicitly separates itself from the form tools that return public_url, so an agent can tell it isn't a link builder. It opens with a noun phrase rather than a verb like 'Returns', which costs a little immediacy but not comprehension.

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 states an explicit exclusion ('Form links are not built from it: the form tools return each exact public_url') and routes the mutation elsewhere ('Claiming one is done in the dForms dashboard'). That is real when-not guidance with an alternative path. It doesn't say when an agent positively needs the code (e.g., display/branding), but the exclusion covers the main misuse case.

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