Skip to main content
Glama

Read which Doc or HTML node is this space's welcome page

space_welcome_get
Read-only

Read which Doc or HTML node is this space's welcome page

GET /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

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": "space_welcome_get"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description correctly frames this as a read. It adds real context — the welcome page is an ordinary Doc or HTML node shown to every member who can read it — but then describes mutation semantics (expectedVersion conflicts, clearing via nodeId null) that do not apply to this tool's single-parameter read signature, which risks confusing the agent.

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

Conciseness3/5

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

The core statement is front-loaded and efficient, but the paragraph then drifts into setup/versioning instructions irrelevant to a read call, consuming most of the text with content an agent may misapply. Trimming the mutation guidance would sharpen it considerably.

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?

For a one-parameter, read-only lookup with full schema coverage and no output schema, the description covers the essential context: what the welcome page is, multi-space handling, and the read semantics. The only gap is the misleading overlap with the update workflow, which is a clarity issue rather than a missing-information one.

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% and the single targetSpaceId parameter is documented in the schema almost word-for-word identically to the description's multi-space advice. The description adds no syntax or format detail beyond what the schema already supplies, so baseline 3 is correct.

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 title and first line state a specific verb and resource: read which Doc or HTML node is this space's welcome page, with the HTTP endpoint reinforcing it. An agent can distinguish this read tool from the sibling space_welcome_update 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 Guidelines3/5

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

It does give one concrete precondition — for multi-space accounts call auth_verify and ask the user which space to use — which is genuinely useful routing guidance. However, the bulk of the usage prose ('write the guide as a Doc first (node_create), read it back, then pass its node id here', expectedVersion, nodeId null clears it) describes a mutation workflow that this read-only tool cannot perform, so the guidance is partly misplaced.

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.