Skip to main content
Glama
Paydirt-AI
by Paydirt-AI

paydirt_setup

Starts a single-call Paydirt SDK setup for older clients, returning an authorization URL and finish arguments. With a session ID, it checks setup status without opening a browser.

Instructions

Use this when an older client expects the single setup tool. Without session_id it starts setup and immediately returns authorization_url plus finish arguments; with session_id it checks once and returns pending, expired, or the complete installation contract. It never opens a browser or blocks. New agents should prefer paydirt_begin_setup and paydirt_finish_setup.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_nameNoPreferred app name to reuse or create during setup
bundle_idNoPreferred iOS bundle ID to match during setup
use_casesNoFeedback experiences to install. Defaults to regular feedback, trial cancellation, and subscription cancellation.
session_idNoSetup session returned by the first call. When present, this call behaves like paydirt_finish_setup.
app_descriptionNoOptional app description to save when creating or repairing setup
uses_revenuecatNoDeprecated compatibility input. Prefer subscription_provider.
subscription_providerNoSubscription source of truth discovered in the host app. Use auto only when it could not be resolved before setup.
subscription_product_idsNoNative StoreKit auto-renewable product IDs. Required for a complete storekit integration.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
messageNo
successYes
Behavior5/5

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

The description adds critical behavioral details not present in annotations: it never opens a browser or blocks, returns authorization_url plus finish arguments on first call, and returns pending/expired/complete contract on subsequent calls. No contradiction with existing annotations.

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?

Three sentences, front-loaded, with no fluff. Every sentence earns its place: when to use, what happens in each mode, and what it does not do.

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?

Despite having 8 parameters, the description is complete for the tool's purpose: it defines the compatibility scope, alternative tools, dual-mode behavior, and non-blocking guarantee. The presence of an output schema means return values need not be described.

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 schema already covers all 8 parameters with 100% description coverage, so baseline is 3. The description adds meaningful semantic detail for session_id, explaining that its presence changes the call to behave like paydirt_finish_setup. This extra context justifies a 4.

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 clearly identifies this as a compatibility wrapper for older clients, distinct from the newer paydirt_begin_setup and paydirt_finish_setup tools. It specifies the core behavior (start setup or check status) and the title 'Compatibility' reinforces the purpose.

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?

It explicitly states when to use the tool ('when an older client expects the single setup tool'), when not to use it ('New agents should prefer paydirt_begin_setup and paydirt_finish_setup'), and how behavior changes based on presence of session_id. This is exemplary guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Paydirt-AI/paydirt-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server