Skip to main content
Glama

Worthune Verified Financial Models

create_household

Create a persistent household resource from a household-schema document (docs/household-schema-spec.md: members, accounts by tax wrapper, liabilities, income and expense streams). Validation rejects with JSON-path errors — fix the payload in one pass. Returns the household id to use with get/replace/project_household.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
labelNoYour own name for the household
api_keyNoWorthune API key (wk_…)
householdYesHousehold-schema document
importKeyNoYour own stable id for this household: a retry with the same importKey returns the household already created, never a twin (same contract as POST /api/v1/households).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / importKey
      Added value: +{
      +  "description": "Your own stable id for this household: a retry with the same importKey returns the household already created, never a twin (same contract as POST /api/v1/households).",
      +  "pattern": "^[A-Za-z0-9._:-]{1,128}$",
      +  "type": "string"
      +}
  2. Added

TDQS

A4.2/5.0
Behavior5/5

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

The description adds substantial behavior beyond the sparse annotations: persistence, JSON-path validation errors, the returned household id, and conditional idempotency when importKey is reused. This is especially valuable because idempotentHint is false while the description accurately discloses the idempotent retry contract. No annotation contradiction is present.

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?

The description is compact, front-loaded with the core purpose, and every sentence carries information: resource type, source schema, validation behavior, return value, and downstream usage. There is no redundant restatement of the tool name or schema fields.

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 tool with a nested household object, no output schema, and a large sibling set, the description provides enough context to invoke it correctly: what valid input looks like, what errors look like, how idempotency works, and what is returned. The reference to the schema spec covers the detailed document structure. Missing sibling comparisons are a usage-guidance issue, not a completeness gap.

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 the baseline is 3. The description adds meaning beyond the schema by explaining what the household-schema document contains (members, accounts by tax wrapper, liabilities, income and expense streams) and by setting expectations for validation errors. It does not need to re-explain label, api_key, or importKey because the schema already documents them well.

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 states a specific verb and resource: it creates a persistent household resource from a household-schema document. It also clarifies what the returned id is for by naming get/replace/project_household. However, it does not explicitly differentiate this tool from siblings like import_households, patch_household, or replace_household, so it stops short of full sibling-level distinction.

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?

The description implies the primary use case: create a new persistent household. It also gives practical guidance about validation (fix the payload in one pass) and retry semantics via importKey. But it does not explicitly say when to choose this over alternatives such as import_households for bulk imports or patch_household/replace_household for updates.

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