Skip to main content
Glama
getpopapi
by getpopapi

Save Account Setup Configuration

pop_onboarding_save_account_setup

Save the account setup configuration and optionally activate SdI or Peppol integration. Completes the onboarding sequence.

Instructions

Save the account setup configuration and optionally activate SdI or Peppol integration.

This is step 5 of 5 in the onboarding sequence.

Integration rules:

  • To activate SdI (Italy/San Marino): set active_sdipop_integration=1 and active_peppol_integration=0

  • To activate Peppol (EU countries): set active_peppol_integration=1 and active_sdipop_integration=0, and provide all peppol_* fields

  • SdI and Peppol are mutually exclusive — never set both to 1

  • For 'basic' variant accounts (non-IT, non-EU): do not send integration toggle fields

Key behaviours:

  • general_store_vat_number must be unique on the target environment. 422 if already in use.

  • Sending 0 for an integration toggle means "do not activate" — the value stores as null in configurations. Always read the effective activation state from integration_state.environments.*.sdi.enabled.

  • Once wizard is complete (wizard_completed=true), calling this again returns the current state without writing (applied_changes=false).

  • Once Peppol is registered (peppol_legal_entity_uuid set), all Peppol fields are locked permanently.

  • If SdI activation fails at ACube, the account data is still saved — retry is safe.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
environmentNoWhich POP environment to configure. 'live' affects your production account; 'sandbox' is for testing.live
configurationsYesAccount setup fields. Send only the fields you want to set. Locked fields (field_locks=true) cannot be changed.
onboarding_tokenYesToken returned by pop_onboarding_verify_otp. Expires 30 minutes after issue.
Behavior5/5

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

Beyond the annotations (which only indicate non-read-only, non-idempotent, non-destructive), the description adds rich behavioral context: uniqueness requirement with 422 error, the meaning of sending 0 (stores null), the non-writing behavior after wizard completion (applied_changes=false), permanent locking of Peppol fields, and retry safety after SdI failure. This is value-added disclosure.

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 the core purpose and uses clear bullet points for integration rules and key behaviors. It is longer than a simple two-sentence description, but this is justified by the tool's complexity. Minor inefficiency: the 'Key behaviours' list could be split further, but substance outweighs length.

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 tool has 18 nested sub-parameters and no output schema, yet the description covers the critical side effects (uniqueness, wizard completion guard, Peppol locking, SdI failure retry) and even hints at response fields (applied_changes, integration_state). It stops short of describing the full response structure or all error cases, but for a save action it is largely complete.

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 input schema already provides 100% coverage for all parameters, so the baseline is 3. The description goes further by explaining the conditional logic between integration toggle fields (mutual exclusion, required peppol_* fields when active_peppol_integration=1) and the meaning of 0 for toggles, which is not evident from individual schema descriptions.

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 opens with a specific verb+resource ('Save the account setup configuration') and clearly states its role as step 5 of 5 in the onboarding sequence. It distinguishes itself from sibling tools like pop_onboarding_get_account_setup by focusing on the write/update action.

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?

The description provides explicit integration rules (SdI vs Peppol, mutual exclusion, basic variant exclusion) and notes when it is safe/appropriate to call again (wizard incomplete, retry after SdI failure). It does not explicitly name alternative tools, but the step positioning and integration constraints implicitly guide selection away from read-only siblings.

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/getpopapi/pop-mcp'

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