Skip to main content
Glama

prepare_apartment_collect_income

Homes: prepare (unsigned) the income poke for an apartment: credits what it has earned into its safe. Anyone can call it for any apartment; it pays only the safe.

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": {
      "wallet": "<wallet>",
      "apartmentId": "<apartmentId>"
    },
    "name": "prepare_apartment_collect_income"
  }
}

Input Schema

NameRequiredDescriptionDefault
walletYesYour own 0x wallet address. Nothing is sent from it; it is used to read your balance and allowance and to simulate.
apartmentIdYesThe apartment id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior4/5

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

With no annotations, the description still discloses important behavior: the transaction is unsigned, it is permissionless across apartments, and payment is restricted to the safe. It leaves out return shape, failure conditions, and any submission step, but the core behavioral profile is unusually clear for a prepare tool.

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?

The description is compact and front-loads the key action, with the permission and payee constraints following immediately. The phrasing 'income poke' is slightly jargon-heavy, but overall it is efficient and well-structured.

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?

For a two-parameter prepare tool with no annotations and no output schema, the description covers the main action and its key constraints, but it does not explain what the prepared output is, how to submit it, or what failure cases exist. It is adequate but not fully complete.

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 description coverage is 100%, so both parameters are already documented in the input schema. The description does not add parameter-specific meaning beyond confirming that the apartment is the target and that the caller wallet is not debited, so the baseline is appropriate.

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 action and resource: preparing an unsigned apartment income collection that credits earned funds into the apartment safe. It is clear enough to distinguish from a generic apartment action, though it does not explicitly contrast with siblings such as deposit or withdraw.

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?

The description explains that anyone can call it for any apartment and that funds go only to the safe, but it gives no explicit guidance on when to use this tool versus related apartment tools. Usage is only inferable from the name and the phrase 'collect income'.

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