Skip to main content
Glama

Create Workspace

create_workspace

Create a new AFFiNE workspace with an initial document accessible in the UI, optionally setting a name and avatar.

Instructions

Create a new workspace with initial document (accessible in UI)

Input Schema

NameRequiredDescriptionDefault
nameYesWorkspace name
avatarNoAvatar emoji or URL

Output Schema

NameRequiredDescriptionDefault
idNo
okNo
urlNo
codeNo
kindNo
nameNo
errorNo
avatarNo
statusNo
detailsNo
messageNo
causeCodeNo
retryableNo
firstDocIdNo
syncStatusNo
workspaceIdNo
recoveryGuidanceNo
requiresManualRepairNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.10.2

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=false, readOnlyHint=false, and non-idempotency, so the safety profile is covered. The description adds genuine context beyond that: creation also produces an initial document and the result is visible in the UI. It does not say whether duplicate names are rejected, what permissions are required, or what the initial document contains.

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?

A single front-loaded sentence with no padding. The parenthetical "(accessible in UI)" is slightly ambiguous — unclear whether it modifies the workspace or the initial document — but the overall length is well matched to the task.

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

Completeness3/5

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

With an output schema present, the description needn't describe return values, and annotations cover the safety profile. However, for a creation tool with an undocumented side effect (initial document), it should say more about what that document is and any naming constraints.

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% with only two parameters, both fully described in the schema, so the baseline is 3. The description adds no format, length, or uniqueness constraints for `name`, nor does it explain how `avatar` is interpreted as emoji versus URL.

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?

States a specific verb+resource ("Create a new workspace") and adds a distinguishing detail: it also creates an initial document. An agent can identify the operation without opening the schema. It stops short of naming how it differs from the sibling create_workspace_blueprint.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool versus alternatives such as create_workspace_blueprint, nor any prerequisite or exclusion guidance. The agent must infer selection criteria from the name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools