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

paydirt_setup

Initiates Paydirt setup by returning an authorization URL and finish arguments, or checks a setup session's status when a session ID is provided.

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_idNoExisting Paydirt app ID, including the ID in a website setup handoff. Reconnect this exact app and reuse its saved Slack/delivery settings instead of creating another app.
app_nameNoPreferred app name to reuse or create during setup
bundle_idNoPreferred iOS bundle ID to match during setup
use_casesNoConfirmed feedback experiences to install. The recommended plan is Suggest a Feature plus trial and paid cancellation when subscriptions exist.
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.
feature_placementNoDeveloper-confirmed placement for Suggest a Feature, such as settings or after_successful_export. Defaults to settings.
form_plan_confirmedNoSet true when the developer explicitly requested these voice forms or confirmed the proposed plan. An explicit installation request already confirms its scope; do not ask the same question again. Ask only when the requested forms or placement are ambiguous.
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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.4.0
    • addedInput schema / properties / app_id
      Added value: +{
      +  "description": "Existing Paydirt app ID, including the ID in a website setup handoff. Reconnect this exact app and reuse its saved Slack/delivery settings instead of creating another app.",
      +  "type": "string"
      +}
    • addedInput schema / properties / feature_placement
      Added value: +{
      +  "description": "Developer-confirmed placement for Suggest a Feature, such as settings or after_successful_export. Defaults to settings.",
      +  "type": "string"
      +}
    • addedInput schema / properties / form_plan_confirmed
      Added value: +{
      +  "description": "Set true when the developer explicitly requested these voice forms or confirmed the proposed plan. An explicit installation request already confirms its scope; do not ask the same question again. Ask only when the requested forms or placement are ambiguous.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / use_cases / description
      Previous value: -"Feedback experiences to install. Defaults to regular feedback, trial cancellation, and subscription cancellation."New value: +"Confirmed feedback experiences to install. The recommended plan is Suggest a Feature plus trial and paid cancellation when subscriptions exist."
    • changedInput schema / properties / use_cases / items / enum
      Previous value: -[
      -  "regular_feedback",
      -  "trial_cancellation",
      -  "subscription_cancellation"
      -]New value: +[
      +  "regular_feedback",
      +  "feature_request",
      +  "trial_cancellation",
      +  "subscription_cancellation"
      +]
  2. First observedv2.1.6

TDQS

A4.7/5.0
Behavior4/5

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

Discloses that it never opens a browser or blocks, and explains what happens with and without session_id. It does not explicitly state that setup may create or reconfigure an app, but the annotations and description make the mutating nature reasonably clear.

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 a bit long but each sentence serves a purpose: compatibility guidance, behavior distinction, non-blocking assurance, and sibling preference. The parameter descriptions add necessary nuance without being redundant.

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?

The description fully explains the tool's role, its two modes, return behavior, and relationship to sibling tools. It gives enough context for an agent to decide when and how to call it, including the handoff scenario.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Every parameter is documented with meaningful context, including the app_id handoff reuse, use_cases recommendation, subscription_provider preference over deprecated input, and the nuanced form_plan_confirmed behavior. This goes well beyond the schema alone.

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?

Clearly identifies itself as a compatibility endpoint for older clients and states it either starts or finishes setup depending on session_id. It also distinguishes itself from paydirt_begin_setup and paydirt_finish_setup.

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?

Explicitly instructs when to use the tool ('older client expects the single setup tool') and directs new agents to prefer begin_setup/finish_setup. The session_id-dependent behavior is also clearly explained.

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