MCP dokumentacija

Povežite Appalize s Claudeom, Cursorom i VS Codeom putem Model Context Protocola.

From analysis to an approved action

The assistant, API and MCP use the same operation registry. Discover what your account can access, inspect real data, then review the exact arguments of a proposed change.

  1. 1. Discover

    Get the current input schema and required scopes. Follow nextOffset for additional results.

  2. 2. Read or prepare

    Read operations return data. Other operations create an unapplied proposal with a 15-minute approval window.

  3. 3. Approve and verify

    Approval executes the exact saved arguments. For queued work, check the job status separately.

MCP · reviewed campaign change
search_platform_operations({
  "query": "update_apple_ads_campaign", "limit": 5
})

// After reading the schema and resolving the actual campaign ID:
run_platform_operation({
  "operation": "update_apple_ads_campaign",
  "arguments": { "campaignId": 123, "dailyBudget": 25 }
})

// Nothing has changed yet. Show the proposal to the user.
// Only after explicit approval, use the returned proposal ID:
commit_platform_operation({
  "proposalId": "<returned-proposal-id>", "approved": true
})

// On timeout, inspect this SAME proposal. Never prepare a duplicate.
get_platform_operation({ "proposalId": "<returned-proposal-id>" })
Operation status reference
StateMeaning and next step
approval_required / pendingNo operation has run. Review the arguments and approve or cancel. Preparation is not a provider dry run.
runningExecution has started. Read this proposal again. A process interruption can leave it running; inspect the affected resource before doing anything else.
succeededThe handler returned successfully. A dry run is still a dry run; a returned job ID is not a completed job. Inspect the result.
failed / uncertainA failure or timeout may leave partial changes. Inspect the provider resource. Never automatically create another proposal.
cancelled / expiredA pending proposal was cancelled or its approval window expired. No new execution can start from it.

Coverage and safety boundaries

Research keywords and competitors, inspect Apple Ads reports and bids, prepare metadata and review replies, manage releases, TestFlight, subscriptions and screenshot projects. Personal notes and notifications use separate workspace scopes. Plan entitlements, ownership and provider permissions still apply.

The proposal ID is the idempotency key, bound to the same identity and channel. A repeated commit returns its state without repeating execution. Records are retained for seven days; a missing record is never replayed. Credentials, OAuth, binary uploads and administrative access remain in dedicated trusted interfaces.

Existing named MCP write tools retain their original behavior and may apply immediately. Configure your MCP client to request human approval, or use the reviewed operation workflow. Appi itself has no commit tool: the user approves in the chat review card.

Use audit_seo_document to check supplied HTML and compare_keyword_coverage to compare supplied SEO or ASO keyword lists. These tools do not crawl websites, grant access to a customer's Google Search Console or guarantee indexing, traffic or rankings. Use verified first-party SEO data alongside Appalize research; save content plans as notes without publishing automatically.

Svestrane metode povezivanja.

Where do I get the API key?

Create it in the Appalize product at API Dashboard, then paste it into your MCP client config as `x-api-key`.

Specifikacija krajnje točke
HTTP: https://api.appalize.com/api/mcp
SSE:  https://api.appalize.com/api/mcp/sse

Header:
x-api-key: YOUR_API_KEY

MCP JSON definicija.

Konfiguracija poslužitelja
{
  "mcpServers": {
    "appalize": {
      "transport": "http",
      "url": "https://api.appalize.com/api/mcp",
      "headers": {
        "x-api-key": "YOUR_API_KEY"
      }
    }
  }
}

Podrška za dvostruki transport

Koristite HTTP za izravne klijentske pozive ili SSE kada vaš MCP klijent očekuje strujanje događaja.

Alati spremni za asistentne

Izložite radne procese za ključne riječi, rangiranje, aplikaciju i optimizaciju AI agentima putem jedinstvene definicije poslužitelja.

Brzo uvođenje

Zalijepite MCP blok, dodajte API ključ u zaglavlje i počnite testirati iz klijenta kojeg već koristite.

Jedna integracija, bezbrojni radni procesi.

Svaki klijent upravlja MCP konfiguracijom drugačije. Koristite korake u nastavku za povezivanje Appalizea.

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json

1

Open Claude Desktop settings.

2

Add the Appalize MCP server entry to your config file.

3

Restart Claude Desktop and re-authorize with your API key.

VS Code / Continue

~/.continue/config.json

1

Install Continue in VS Code.

2

Add an `mcpServers` entry pointing to the Appalize HTTP or SSE transport.

3

Reload the editor window to pick up the new tool server.

Cursor

~/.cursor/mcp.json

1

Enable MCP in Cursor settings.

2

Paste the Appalize MCP server definition with your API key.

3

Restart Cursor and test the manifest or health endpoint.

How the MCP surface stays current.

Appalize MCP is not a hand-maintained sidecar. The exposed catalog is filtered from the same registry and auth scope model that powers the backend integration layer.

Registry-driven surface

The MCP manifest, tools, resources, and scopes are generated from one backend registry so the AI surface stays aligned with the product API.

Scope-filtered catalog

Clients only see tools and resources their API key or dashboard JWT can actually use. Admin tools require an admin role as well as admin scopes.

Compact by default

The manifest omits input schemas unless `detail=full` is requested, reducing token usage for assistants that only need discovery.

Current workflow coverage

Appalize MCP now spans keyword research, app details, competitor analysis, Apple workspace operations, pricing context, and other growth workflows.

Give the assistant runtime instructions from MCP itself.

Appalize publishes model-readable resources and prompts so an assistant can verify the active account, inspect scopes, follow the manifest-first flow, and use safer write behavior before it calls tools.

appalize://mcp/usage-guide

Tool/resource ordering, manifest-first discovery, ASO all-locale defaults, lowercase keyword policy, and safe write rules.

appalize://mcp/account-profile

Safe metadata for the authenticated Appalize account: user ID, role, auth method, API key ID/name, label, and scopes. Raw secrets are never returned.

appalize://mcp/multi-account-guide

Client config pattern and routing rules for multiple Appalize accounts.

appalize_mcp_orientation

Prompt that tells the model to read account profile and usage guide resources before selecting tools, and to default ASO/cross-localization to all Appalize target locales unless a subset is explicit.

appalize_multi_account_routing

Prompt that tells the model to verify account context and ask before ambiguous writes.

Use one MCP server entry per Appalize account.

Create a separate Appalize API key for each Appalize account or client profile, then give each key its own MCP server name. The backend does not store other Appalize account keys for routing.

Read appalize://mcp/account-profile before account-specific work.
If the user does not specify an account and a write tool may be called, ask which profile to use.
Do not mix apps, drafts, campaigns, subscriptions, screenshots, or reports across server entries unless explicitly requested.
Multiple account MCP JSON config
{
  "mcpServers": {
    "appalize-personal": {
      "transport": "http",
      "url": "https://api.appalize.com/api/mcp",
      "headers": {
        "x-api-key": "APK_FOR_PERSONAL_ACCOUNT"
      }
    },
    "appalize-client-a": {
      "transport": "http",
      "url": "https://api.appalize.com/api/mcp",
      "headers": {
        "x-api-key": "APK_FOR_CLIENT_A"
      }
    },
    "appalize-client-b": {
      "transport": "http",
      "url": "https://api.appalize.com/api/mcp",
      "headers": {
        "x-api-key": "APK_FOR_CLIENT_B"
      }
    }
  }
}

Izložene operacije motora.

search_keywords

Look up keywords and suggestions with country-aware query support.

get_app_details

Fetch app records and related analytics context for a store identifier.

get_competitor_keywords

Inspect competitor keyword sets and ranking opportunities.

optimize_title

Generate AI-assisted title ideas using target keyword context.

Spremni za REST API?

Trebate sirove tokove podataka ili skupnu obradu? Naša REST API dokumentacija pruža sve detalje i testno okruženje.