Skip to main content
Glama

Create a new flat

wg_create

Creates a new shared flat with the caller as its first member and admin, returning a share code other tools use to manage that flat.

Instructions

Create a new, separate flat with the caller as its first member and admin. Use it only when the user wants a new flat; to change an existing flat use wg_update, to see the flats the account already belongs to use wg_list. Works on the account level, so wgCode is not needed. Returns wg { id, shareCode, name } and creator { id, name }; pass shareCode as wgCode to other tools to work in the new flat. The share code only addresses the flat in tools; people cannot join with it, so to add flatmates create an invite link with invite_create or send one with invite_email. Fails with account_deletion_pending if the account is being deleted and with wg_create_rate_limited after 10 creations per hour from one IP address.

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": {
      "name": "<name>",
      "creatorName": "<creatorName>"
    },
    "name": "wg_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDisplay name of the flat, for example "Elm Street 4".
creatorNameYesName the caller goes by inside this flat; other members see it on expenses, chores and chat. Does not change the account's name in other flats.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.1
    • addedInput schema / properties / creatorName / description
      Added value: +"Name the caller goes by inside this flat; other members see it on expenses, chores and chat. Does not change the account's name in other flats."
    • addedInput schema / properties / name / description
      Added value: +"Display name of the flat, for example \"Elm Street 4\"."
  2. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations cover the safety profile (non-read-only, non-idempotent, non-destructive), and the description adds substantial context beyond them: the return payload shape, how to carry shareCode forward as wgCode, the caveat that shareCode cannot be used by people to join, and both failure modes (account_deletion_pending, wg_create_rate_limited at 10/hour per IP). That rate-limit and error disclosure is exactly the kind of behavior annotations cannot convey.

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

Conciseness5/5

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

Front-loads the core action, then routes to alternatives, then scoping, then return value and share-code handoff, then error cases — a logical progression with no filler. Every sentence carries operational 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?

Even without an output schema, the description enumerates the returned fields (wg { id, shareCode, name }, creator { id, name }) and explains the downstream use of shareCode. For a 2-param creation tool with annotations, nothing an agent needs to invoke it correctly is missing.

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 100%, so name and creatorName are already documented there, and the description adds meaning at the parameter-set level by stating wgCode is not required because the tool is account-scoped. It does not elaborate on name/creatorName semantics, which is acceptable given full schema coverage but keeps it below a 5.

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 ('Create a new, separate flat') plus the resulting caller role ('first member and admin'), and explicitly contrasts with wg_update and wg_list. An agent can distinguish this from sibling creation 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 when-to-use ('only when the user wants a new flat') and names two alternatives with their respective conditions (wg_update for changes, wg_list for existing flats). It also clarifies scope ('works on the account level, so wgCode is not needed'), removing a common invocation doubt.

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