loading…
Search for a command to run...
loading…
Lets AI agents launch scans, inspect results, manage campaigns and policies, and read alerts directly against your Kaminari Ad workspace via your API key, with
Lets AI agents launch scans, inspect results, manage campaigns and policies, and read alerts directly against your Kaminari Ad workspace via your API key, with 82 tools covering most of the API surface.
Official Model Context Protocol (MCP) server for Kaminari Ad — the ad verification platform from the team behind Kaminari Click.
Lets AI agents (Cursor, Claude Desktop, Cline, and any MCP-compatible client) launch scans, inspect results, manage campaigns and policies, and read alerts directly against your Kaminari Ad workspace via your API key.
npm version npm downloads License: MIT node CI Provenance MCP Registry
Download `kaminari-ad-mcp.mcpb` → double-click to install. Claude Desktop shows a config form for your API key.
claude mcp add kaminari-ad -- npx -y @kaminari-ad/mcp
export KAMINARI_AD_API_KEY=your-key
Full installation docs — see Quick start below.
Keys are opaque random strings — no required prefix or fixed length. Treat the whole value as a raw secret and paste it verbatim into your client config.
Tip for evaluators / Anthropic Software Directory reviewers: ask the team at [email protected] for a sandboxed test account with seeded sample scans, campaigns, and alerts.
Add to your MCP client config (Cursor: ~/.cursor/mcp.json; Claude Desktop: ~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"kaminari-ad": {
"command": "npx",
"args": ["-y", "@kaminari-ad/mcp"],
"env": {
"KAMINARI_AD_API_KEY": "<your-kaminari-ad-api-key>",
},
},
},
}
Restart your client. You should see kaminari-ad in the MCP servers list with 83 tools exposed.
For cloud agents or clients without a local Node runtime, point at the hosted endpoint:
{
"mcpServers": {
"kaminari-ad": {
"url": "https://mcp.kaminari.ad/mcp",
"headers": {
"Authorization": "Bearer <your-kaminari-ad-api-key>",
},
},
},
}
The hosted server publishes RFC 9728 protected-resource metadata at
https://mcp.kaminari.ad/.well-known/oauth-protected-resource
and points at the Kaminari Ad Authorization Server
(https://app.kaminari.ad). Any unauthenticated request to /mcp
returns a WWW-Authenticate: Bearer resource_metadata="…" header so
spec-compliant MCP clients (Claude.ai, Claude Code, third-party
agents) can complete an OAuth 2.0 authorization-code flow with PKCE
S256 + Dynamic Client Registration (RFC 7591).
# Discovery — works without any credential
curl -sk https://mcp.kaminari.ad/.well-known/oauth-protected-resource
# Triggering the WWW-Authenticate hint
curl -isk https://mcp.kaminari.ad/mcp -X POST \
-H 'content-type: application/json' \
-d '{"jsonrpc":"2.0","method":"tools/list","id":1}'
API keys remain the recommended path for CLIs and one-off
scripting — OAuth is only for interactive agents that want per-app
consent and per-app revocation. Both Bearer flavours hit the same
/mcp endpoint; the server forwards the token verbatim to the API,
which decides which credential type minted it.
83 tools mirroring most of the public /api/v1 surface of Kaminari Ad. Every tool carries MCP behaviour annotations (title, readOnlyHint, destructiveHint, idempotentHint, openWorldHint) so MCP clients can warn before destructive actions. Highlights:
get_account, update_org, list_org_users, invite_user, update_user_role, remove_user, transfer_ownership, list_org_roles, list_api_keys, create_api_key, revoke_api_keylist_scans, get_scan, create_scan, create_bulk_scans, recheck_scans, cancel_scanlist_campaigns, list_campaigns_picker, get_campaign, create_campaign, update_campaign, archive_campaign, unarchive_campaign, cancel_campaign, run_campaign, list_campaign_runspause_campaign_group_schedule, resume_campaign_group_scheduleget_run, list_run_scans, cancel_run (use list_campaign_runs to enumerate runs of a campaign — the API has no standalone /runs index)list_tags, get_tag_definition, update_tag_definition, delete_tag_definition, list_scan_tagslist_custom_rules, get_custom_rule, create_custom_rule, update_custom_rule, delete_custom_rule, test_custom_rulelist_policy_sets, get_policy_set, create_policy_set, update_policy_set, delete_policy_set, request_policy_set_approvallist_alerts, update_alert_status, get_alert_statslist_webhooks, get_webhook, create_webhook, update_webhook, delete_webhook, list_webhook_event_types, list_webhook_deliveries, test_webhook, rotate_webhook_secret, replay_webhook_delivery, bulk_replay_webhookget_billing_summary, list_usage, get_usage_summary, list_balance_historylist_invoiceslist_alert_destinations, delete_alert_destination, set_alert_destination_version, get_campaign_alert_overrides, set_campaign_alert_overrideslist_geos, list_emulatorsNot exposed (intentionally): binary scan-screenshot fetchers, invoice PDF, and the public marketing forms (/contact, /demo-inquiries). Open an issue if you need one of those.
These three prompts each exercise a different cross-section of tools and demonstrate the typical agent workflow:
list_emulators → create_bulk_scans → wait → list_scans (status=completed) → get_scan → list_scan_tags.list_emulators → list_policy_sets (find one with malware) → create_campaign (schedule_enabled=true) → list_alert_destinations → set_campaign_alert_overrides.get_usage_summary → list_usage (with date_from/date_to) → group by scan_id → get_scan → get_campaign for attribution.Full machine-readable tool listing is exposed by the server itself — connect with any MCP client and call tools/list.
The hosted HTTP endpoint serves many organizations from a single process. We take cross-tenant isolation very seriously:
Authorization header to the Kaminari Ad API verbatim and stores no per-tenant state between requests.KAMINARI_AD_API_KEY env var is rejected on startup in HTTP mode (stdio only) — no default fallback token exists.To report a security issue, see SECURITY.md.
The Docker path (no local Node required for the build, but see CONTRIBUTING for the host-side commit hooks):
make check # lint + format-check + typecheck + arch-gates + test-cov
make test # full test suite
make test-unit # unit only
make test-isolation # tenant-isolation suite
Or directly with npm if you have Node >=22.19.0 on the host (matches engines.node; .nvmrc pins the minor for dev parity with CI). The package gates strictly at 22.19.0 because [email protected] requires markAsUncloneable from node:worker_threads (Node 22.19+).
npm ci --legacy-peer-deps
npm run lint && npm run typecheck && npm test
See CONTRIBUTING.md for the development workflow and how to add a tool.
The maintainers run the full development gate (integration tests, deploy automation, prod smoke) on a private GitLab instance and mirror the repo to GitHub. The public CI on GitHub Actions (.github/workflows/ci.yml) runs lint + typecheck + unit tests + build + bundle-size check on every community PR, so contributors get fast green/red feedback without needing access to the internal infra. Tag pushes (
v*.*.*) trigger .github/workflows/release.yml, which publishes the package to npm with OIDC provenance and creates the GitHub Release.
The public surface of this package is:
kaminari-ad-mcp and its --transport stdio|http flag, the env vars documented in .env.example, and the exit codes (0 / 1 fatal / 2 invalid config).Everything else — the TypeScript types exported from dist/bin.d.ts, deep imports, internal class shapes — is not part of the public contract and may change in any release. Treat this package as a CLI, not a library.
We follow Semantic Versioning for the two items above. See CHANGELOG.md for the per-release record.
Authorization header it forwards. In HTTP mode, only ephemeral per-request scoped state (session id ↔ Bearer hash, leaky-bucket rate limit by Bearer hash) is held in memory./api/v1 over HTTPS. The Kaminari Ad privacy policy applies: https://kaminari.ad/legal/privacy.bearer_hash = sha256(token).slice(0,8) makes it into a log line, alongside request_id, tool_name, api_status, elapsed_ms. Tool inputs (which may contain customer scan IDs / URLs) are NOT logged.NoopErrorReporter. We do not bundle Sentry, OpenTelemetry exporters, or PostHog.To report a security or privacy issue, see SECURITY.md.
MIT — see LICENSE.
Run in your terminal:
claude mcp add kaminari-ad-mcp -- npx