Skip to main content
Glama

finance

by com.zoninga
OverviewDiscussionsAdmin

Onboarding: Get setup status

get_setup_status
Read-onlyIdempotent
    Get the user's onboarding/setup progress — the agent's setup curriculum.

    Reports what the user still needs to be "hands-off ready", computed
    from live data. Most useful near the start of a new user's
    conversation.

    Finish line is "fast to hands-off": at least one account, an income
    signal, and an ACTIVE daily-monitoring plan. Budgets and goals are
    offered but optional.

    Returns:
        ``is_new_user`` (no accounts yet), ``hands_off_ready`` (all required
        steps done), ``next_step`` / ``next_step_label``,
        ``required_remaining`` (keys), the ordered ``steps`` (each
        ``{key, label, done, required, detail}``), ``completed_count`` /
        ``total_count``, and a ``guidance`` string describing the
        recommended next setup step. When ``hands_off_ready`` is True,
        required setup is complete.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare the safe read-only/idempotent profile, but the description adds real value beyond them: results are 'computed from live data', the completion criteria are defined (one account, an income signal, an ACTIVE daily-monitoring plan), and budgets/goals are flagged as optional. It could say more about latency of the live computation, but the added context is substantial.

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?

Purpose is front-loaded in the first sentence, and the rest is organized into scannable blocks. It is somewhat long, but the detail is content-bearing, especially the Returns block, which compensates for the missing output schema.

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 no-parameter, read-only status tool with no output schema, the description covers everything an agent needs: what is reported, how completion is determined, what is optional, and the exact shape of the returned fields including the guidance string and next_step.

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?

The tool takes zero parameters, so per the rubric the baseline is 4. There is no argument surface that needs additional semantic explanation in the description.

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 combination ('Get the user's onboarding/setup progress') and frames it as the agent's setup curriculum, computed from live data. This clearly distinguishes it from lookalike siblings such as get_user_profile or get_monitoring_plan, which report persistent state rather than onboarding completion.

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

Usage Guidelines4/5

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

Gives a clear usage context: 'Most useful near the start of a new user's conversation.' However, it names no alternative tool and gives no explicit when-not guidance (e.g., once hands_off_ready is True, use X instead), so it stops short of the 5 tier.

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

All finance toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources