Skip to main content
Glama

broker_sync_register_user

Register an end user with SnapTrade to obtain a brokerage connection-portal URL for onboarding. Use it when setting up a new user, not for reading data from an already connected account.

Instructions

[Broker Sync API] Register a user with SnapTrade and get a brokerage connection-portal URL.

Use when you are onboarding a user and need a SnapTrade brokerage connection-portal URL. Not for reading data for an already connected user.

Behavior: writes state upstream (not read-only); needs the credentials or wallet signature noted above where applicable.

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": {
      "user_id": "<user_id>"
    },
    "name": "broker_sync_register_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
user_idYesYour application's stable identifier for this end user.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.1/5.0
Behavior4/5

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

The description adds meaningful behavioral context beyond annotations: it states that the tool writes state upstream and requires credentials or a wallet signature where applicable. This complements readOnlyHint=false and openWorldHint=true. It does not elaborate on non-idempotency or what happens if the user already exists, but annotations already declare idempotentHint=false.

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 front-loaded with purpose and usage, then behavior, with no major digressions. The phrase 'noted above where applicable' is slightly vague and boilerplate-like, keeping it from a perfect conciseness score.

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

Completeness4/5

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

For a one-parameter registration tool with no output schema, the description covers purpose, usage, side effect, and the returned portal URL. The main remaining gap is that it does not specify behavior when user_id already exists or exactly which credentials are needed, but annotations cover the core safety profile.

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%, and the sole user_id parameter is well documented in the schema as the application's stable identifier for the end user. The description does not add parameter-specific semantics beyond the schema, so the baseline of 3 is appropriate.

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?

The description states a specific action (register a user with SnapTrade) and a concrete outcome (get a brokerage connection-portal URL). It also distinguishes this onboarding flow from reading data for an already connected user, which separates it from sibling read tools like broker_sync_balances and broker_sync_connections.

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?

It gives explicit when-to-use guidance (onboarding a user who needs a SnapTrade connection-portal URL) and a clear when-not condition (reading data for an already connected user). It does not name the specific alternative sibling to use for reading data, so it falls just short of full alternative routing.

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