Skip to main content
Glama

Choose or clear this space's welcome page (space managers only)

space_welcome_update

Choose or clear this space's welcome page (space managers only)

PUT /api/v1/space-welcome

For multi-space accounts, call auth_verify, ask the user which space to use, and pass targetSpaceId. The welcome page is an ordinary Doc or HTML node that Home shows at the top for every member who can read it. To set one up, write the guide as a Doc or HTML node first (node_create), read it back, then pass its node id here. Choosing it requires workspace management access and the current expectedVersion; nodeId null clears it. Change it only when the user asks; a conflict means reload rather than overwrite.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "nodeId": "<nodeId>",
      "expectedVersion": "<expectedVersion>"
    },
    "name": "space_welcome_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeIdYes
targetSpaceIdNoBusabase space id. Call auth_verify first and ask the user which space to use when more than one is returned.
expectedVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare the mutation safety profile, and the description adds substantive context beyond them: it requires workspace management access and the current expectedVersion, nodeId null clears the page, and a version conflict should be resolved by reloading. It also explains the blast radius — every member who can read the node sees it on Home.

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?

Purpose and endpoint are front-loaded, then prerequisites, then semantics, then caution — a logical order. The first line duplicates the title verbatim, which is minor waste, but every other sentence carries information the agent needs.

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?

For a mutation tool with no output schema, the description supplies the prerequisite workflow, permission requirement, concurrency model, clear-vs-set semantics, and conflict handling — everything needed to invoke it correctly and safely.

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

Parameters5/5

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

Schema coverage is only 33%, but the description compensates fully: nodeId is described as the id of an already-created Doc or HTML node with null meaning clear, expectedVersion as the current version whose mismatch signals a conflict, and targetSpaceId as required for multi-space accounts via auth_verify.

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 pair and resource ('Choose or clear this space's welcome page') plus the actor constraint ('space managers only'), and implicitly contrasts with the sibling space_welcome_get by covering only the write side. An agent can distinguish it from adjacent space_* tools without opening the schema.

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 preconditions and alternatives: call auth_verify and ask the user which space for multi-space accounts, use node_create plus a read-back before passing a node id, and 'Change it only when the user asks.' It also prescribes recovery behavior on conflict (reload rather than overwrite).

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.