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

paydirt_finish_setup

Idempotent

Check a Paydirt setup session after user authorization, securely save credentials when ready, and return the host-app build, verification details, and post-verification delivery choice.

Instructions

Use this when the user has opened the authorization URL returned by paydirt_begin_setup. Checks one setup session and returns immediately. If pending, do not loop or sleep. When ready, securely saves credentials and returns the host-app build, visible verification, and post-verification delivery-choice contract.

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_idYesThe session_id returned by paydirt_begin_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.4/5.0
Behavior4/5

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

The description discloses key side effects and behavior: it checks one session, returns immediately, does not block, and securely saves credentials when ready. It does not contradict the annotations, and it adds useful non-obvious context about not polling or sleeping.

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?

The description is compact and well structured: the trigger condition comes first, followed by the immediate return behavior, the anti-loop instruction, and the eventual outcome. Every sentence contributes essential usage context without redundancy.

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?

The description gives enough workflow context to call the tool correctly: it references the prior begin_setup step, explains the pending state behavior, and states what will be returned once setup is ready. It does not explain every failure mode, but the output schema and annotations cover the remaining contract sufficiently.

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% and every parameter already has a meaningful description, including enum guidance and deprecation notes. The tool description itself does not add much parameter-level meaning beyond what the schema provides, so the baseline score applies.

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 states a specific action: finish the setup flow initiated by paydirt_begin_setup. It names the exact trigger condition, the single-session check behavior, and the eventual credential-save and return contract, making it easy to distinguish from sibling setup and management tools.

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?

The description explicitly says when to use the tool: after the user has opened the authorization URL from paydirt_begin_setup. It also gives direct operational guidance: check once, return immediately, and do not loop or sleep if pending, which prevents common misuse.

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