Vee3
REMOTE · MCP.VEE3.IO · SCANNED AUG 3
Hosted MCP with 91 agent tools: X, domains, SEO, Maps, Trends, Search, YouTube, TikTok, and more.
Available components
How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. How we score →
Endpoint Security57
- The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
- Authorisation not fully verified: no authorisation is required to call this server, and 240 tool(s) never declared a destructiveHint. The MCP spec treats an absent hint as destructive by default, so we cannot call this surface safe. See how to fix → View diagnostics → Unverified
- HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
- HSTS check failed: the Strict-Transport-Security header is absent. See how to fix → View diagnostics → Fail
- DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail
Transport & Reachability100
- Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass
Schema Quality & AI Usability63
- AI-judged instruction clarity (good).Pass
- Context-footprint check failed: tool/resource definitions use about 34744 tokens (~144/item across 240 items; 240 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management6
- Stability check failed: schema churn in the 8 days we've observed: 62 tool removals, 0 breaking changes, 0 auth/transport breaks, 6 additions. See how to fix → Fail
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
- Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
remote · mcp.vee3.io
claude mcp add --transport http vee3io-vee3 https://mcp.vee3.io/mcp
[mcp_servers.vee3io-vee3] url = "https://mcp.vee3.io/mcp"
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"vee3io-vee3": {
"type": "remote",
"url": "https://mcp.vee3.io/mcp",
"enabled": true
}
}
} openclaw mcp add vee3io-vee3 --url https://mcp.vee3.io/mcp --transport streamable-http
mcp_servers:
vee3io-vee3:
url: "https://mcp.vee3.io/mcp" {
"mcpServers": {
"vee3io-vee3": {
"type": "http",
"url": "https://mcp.vee3.io/mcp"
}
}
} The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 2 Aug 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 0 to 2.
- 31 Jul 26 −1
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 29 Jul 26 +1
- This server's schema is too large to store in full, so we cannot compare its tools day to day functional
- 28 Jul 26 0
- This server's schema is too large to store in full, so we cannot compare its tools day to day functional
- 27 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 26 Jul 26 60
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 3 Aug 2026 · Probed https://mcp.vee3.io/mcp
TLS valid
Negotiated TLS 1.3 with TLS_AES_128_GCM_SHA256 .
| Subject | Issuer | Valid from | Valid until | Key | Signature | Serial |
|---|---|---|---|---|---|---|
| CN=mcp.vee3.io | CN=WR3,O=Google Trust Services,C=US | 19 Jul 2026 | 17 Oct 2026 | RSA 2048 | SHA256-RSA | 299afbdbcd59affa0a0a4719cdd2adf2 |
| SANs: mcp.vee3.io | ||||||
| CN=WR3,O=Google Trust Services,C=US (CA) | CN=GTS Root R1,O=Google Trust Services LLC,C=US | 13 Dec 2023 | 20 Feb 2029 | RSA 2048 | SHA256-RSA | 7ff005a91568d63abc22861684aa4b5a |
| CN=GTS Root R1,O=Google Trust Services LLC,C=US (CA) | CN=GlobalSign Root CA,OU=Root CA,O=GlobalSign nv-sa,C=BE | 19 Jun 2020 | 28 Jan 2028 | RSA 4096 | SHA256-RSA | 77bd0d6cdb36f91aea210fc4f058d30d |
DNSSEC insecure
Validation of mcp.vee3.io. — Not signed
| Zone | DS | Keys | Algorithms | Outcome |
|---|---|---|---|---|
| . | trust_anchor | 20326, 38696 | 8, 8 | Verified |
| io. | present | 57355 | 8 | Verified |
| vee3.io. | absent | Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation |
Authentication No authorisation required
The endpoint answered without asking for a token. Anyone who knows the URL can reach it.
| Result | No authorisation required |
|---|---|
| HTTP status | 200 |
Transports 2 probes
| Transport | URL | Outcome | Status | Location |
|---|---|---|---|---|
| streamable-http | https://mcp.vee3.io/mcp | Verified | 200 | |
| http (plaintext) | http://mcp.vee3.io/mcp | HTTPS enforced | 302 | https://mcp.vee3.io/mcp |
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
clerk.add_domain ~134
Add a custom domain to a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created domain with CNAME targets for DNS setup. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| is_satellite | boolean | yes | Whether this is a satellite domain. |
| name | string | yes | Domain hostname to add. |
| proxy_url | — | — | Proxy URL when using a satellite domain behind a reverse proxy. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Created Clerk domain from the Backend API. |
No examples provided.
clerk.ban_users ~114
Ban one or more Clerk users, preventing them from signing in. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated user summaries and total count. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| user_ids | array | yes | List of one or more Clerk user ids (user_...) to ban. |
| Name | Type | Req | Description |
|---|---|---|---|
| total_count | — | — | Number of users that were banned. |
| users | — | — | Updated user summaries for all banned users. |
No examples provided.
clerk.change_instance_domain ~144
Change the primary or secondary home URL for a connected Clerk instance. WARNING: Destructive operation — changing the instance domain invalidates active sessions and may cause brief downtime. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns whether Clerk accepted the domain change request. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| home_url | string | yes | New home URL for the instance domain. |
| is_secondary | — | — | When true, change the secondary domain instead of the primary. |
| Name | Type | Req | Description |
|---|---|---|---|
| accepted | — | — | Whether Clerk accepted the domain change request. |
No examples provided.
clerk.count_users ~115
Return the total number of users in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cheaper than listing users when you only need the total count. Cost = 2 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| query | — | — | Optional filter query forwarded to Clerk (email, phone, username, or external id). |
| Name | Type | Req | Description |
|---|---|---|---|
| total_count | — | — | Total number of users in the Clerk application. |
No examples provided.
clerk.create_actor_token ~218
Create an actor token that lets one user impersonate another in a connected Clerk application. **Sensitive** — the returned token is a high-privilege secret that grants impersonation access; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 15 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| actor_sub | string | yes | Clerk user id (user_...) of the impersonating actor (maps to actor.sub). |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| expires_in_seconds | — | — | Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour). |
| session_max_duration_in_seconds | — | — | Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes). |
| user_id | string | yes | Clerk user id (user_...) of the user being impersonated. |
| Name | Type | Req | Description |
|---|---|---|---|
| actor_token | — | — | Created Clerk actor token object from the Backend API. |
No examples provided.
clerk.create_admin_portal_link_token ~183
Create an admin portal link token in a connected Clerk instance. **Sensitive** — the returned token is a single-use deep-link secret; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 15 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| it_contact_id | — | — | Optional opaque IT contact reference for the link. |
| organization_id | — | — | Optional organization id (org_...) to scope the admin portal link. |
| scopes | — | — | Optional scopes for the link (for example "admin_portal:read"). |
| seconds_until_expiration | — | — | Link token lifetime in seconds (default 3600, max 86400). |
| Name | Type | Req | Description |
|---|---|---|---|
| admin_portal_link_token | — | — | Created admin portal link token from the Backend API. |
No examples provided.
clerk.create_allowlist_identifier ~151
Add an identifier to the allowlist in a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created allowlist identifier summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| identifier | string | yes | Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address. |
| notify | — | — | When true, notify the user by email or SMS that they were added to the allowlist. |
| Name | Type | Req | Description |
|---|---|---|---|
| identifier | — | — | Created allowlist identifier object from the Backend API. |
No examples provided.
clerk.create_api_key ~232
Create an API key in a connected Clerk application. **Sensitive** — the returned secret is a high-privilege credential; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new API key summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| claims | — | — | Custom claims to embed in tokens minted from this API key. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| created_by | — | — | User id to record as the creator of this API key. |
| description | — | — | Optional description for the API key. |
| key_type | — | — | API key type (typically "api_key"). |
| name | string | yes | Human-readable name for the new API key. |
| scopes | — | — | Permission scopes to grant the API key. |
| seconds_until_expiration | — | — | Seconds from creation until the API key expires. |
| subject | string | yes | Subject the API key is scoped to (user_... or org_...). |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | — | — | Newly created Clerk API key from the Backend API. |
No examples provided.
clerk.create_blocklist_identifier ~131
Add an identifier to the blocklist in a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Blocked identifiers cannot sign up or sign in. Returns the created blocklist identifier summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| identifier | string | yes | Identifier to block: email, domain, E.164 phone (+15555555555), or Web3 wallet address. |
| Name | Type | Req | Description |
|---|---|---|---|
| identifier | — | — | Created blocklist identifier object from the Backend API. |
No examples provided.
clerk.create_email_address ~153
Create a new email address for a Clerk user. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created email address summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| email_address | string | yes | Email address to create for the user. |
| primary | — | — | When true, set this email as the user's primary email address. |
| user_id | string | yes | Clerk user id (user_...) to retrieve or modify. |
| verified | — | — | When true, the email address is created as verified. |
| Name | Type | Req | Description |
|---|---|---|---|
| email_address | — | — | Created Clerk email address summary. |
No examples provided.
clerk.create_enterprise_connection ~268
Create a SAML or OIDC enterprise SSO connection in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new enterprise_connection summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| active | — | — | Whether the connection is active. |
| allow_organization_account_linking | — | — | Whether account linking via organization membership is allowed. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| custom_attributes | — | — | Custom attribute mappings from the IdP to user metadata. |
| disable_additional_identifications | — | — | Whether to block additional identifications for this connection. |
| domains | array | yes | Email domains that may use this connection. |
| name | string | yes | Display name for the enterprise connection. |
| oidc | — | — | OIDC client configuration when provider uses OAuth. |
| organization_id | — | — | Clerk organization id (org_...) to link to this connection. |
| provider | string | yes | Identity provider key (for example saml_custom or oidc_custom). |
| saml | — | — | SAML IdP configuration when provider uses SAML. |
| sync_user_attributes | — | — | Whether to sync user attributes on each sign-in. |
| Name | Type | Req | Description |
|---|---|---|---|
| enterprise_connection | — | — | Newly created enterprise SSO connection. |
No examples provided.
clerk.create_enterprise_connection_test_run ~128
Start an SSO test flow for an enterprise connection in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a short-lived url that opens the IdP test flow. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| connection_id | string | yes | Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test. |
| Name | Type | Req | Description |
|---|---|---|---|
| url | — | — | Short-lived URL to start the enterprise SSO test flow. |
No examples provided.
clerk.create_invitations ~125
Invite one or more email addresses to sign up for a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| invitations | array | yes | One or more invitation objects. Each item requires email_address (string). Optional fields per item: role (string), redirect_url (string), public_metadata (object). |
| Name | Type | Req | Description |
|---|---|---|---|
| invitations | — | — | Created Clerk invitation summaries. |
No examples provided.
clerk.create_jwt_template ~199
Create a new JWT template in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new template summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| allowed_clock_skew | — | — | Allowed clock skew in seconds (0–300). |
| claims | object | yes | JWT claims template as a JSON object. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| custom_signing_key | — | — | Whether to use a custom signing key and algorithm. |
| lifetime | — | — | Token lifetime in seconds (30–315360000). |
| name | string | yes | Unique JWT template name. |
| signing_algorithm | — | — | Custom signing algorithm (required when custom_signing_key is true). |
| signing_key | — | — | Custom signing private key (required when custom_signing_key is true). |
| Name | Type | Req | Description |
|---|---|---|---|
| jwt_template | — | — | Newly created Clerk JWT template summary. |
No examples provided.
clerk.create_m2m_token ~202
Create an M2M token in a connected Clerk instance. **Sensitive** — the returned token is a high-privilege secret; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created M2M token. Cost = 15 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| claims | — | — | Optional custom claims embedded in the token. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| machine_secret_key | string | yes | Machine secret key (msk_...) used to authenticate the create request. |
| min_remaining_ttl_seconds | — | — | For opaque tokens, reuse an existing token with at least this TTL remaining. |
| seconds_until_expiration | — | — | Token lifetime in seconds. |
| token_format | — | — | Token format: "opaque" (default) or "jwt". |
| Name | Type | Req | Description |
|---|---|---|---|
| m2m_token | — | — | Created M2M token from the Backend API. |
No examples provided.
clerk.create_machine ~162
Create a machine in a connected Clerk instance for machine-to-machine authentication. **Sensitive** — the response may include a machine secret_key on creation; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| default_token_ttl | — | — | Default M2M token lifetime in seconds (minimum 1). |
| name | string | yes | Machine display name (1–255 characters). |
| scoped_machines | — | — | Machine ids (mch_...) this machine may access (max 150). |
| Name | Type | Req | Description |
|---|---|---|---|
| machine | — | — | Created machine object from the Backend API. |
No examples provided.
clerk.create_machine_scope ~128
Create a machine scope so one machine can access another. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created machine scope. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| machine_id | string | yes | Clerk machine id (mch_...) to retrieve or modify. |
| to_machine_id | string | yes | Target machine id (mch_...) to grant access to. |
| Name | Type | Req | Description |
|---|---|---|---|
| machine_scope | — | — | Created machine scope from the Backend API. |
No examples provided.
clerk.create_oauth_application ~199
Create a new OAuth application in a connected Clerk application (Clerk as IdP). **Sensitive** — client_secret may be present for confidential clients; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new OAuth application summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| consent_screen_enabled | — | — | Whether to show the OAuth consent screen during authorization. |
| name | string | yes | Display name for the new OAuth application. |
| public | — | — | Whether this is a public OAuth client (no client secret; PKCE-capable). |
| redirect_uris | — | — | Allowed redirect URIs for the OAuth authorization flow. |
| scopes | — | — | Space-delimited scopes (e.g. profile email public_metadata). |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_application | — | — | Newly created Clerk OAuth application summary. |
No examples provided.
clerk.create_organization ~169
Create a new organization in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new organization summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| created_by | string | yes | Clerk user id (user_...) of the user creating the organization. |
| max_allowed_memberships | — | — | Optional maximum number of memberships allowed. |
| name | string | yes | Organization display name. |
| private_metadata | — | — | Optional private metadata as a JSON object. |
| public_metadata | — | — | Optional public metadata as a JSON object. |
| slug | — | — | Optional URL-friendly slug for the organization. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization | — | — | Newly created Clerk organization summary. |
No examples provided.
clerk.create_organization_domain ~159
Add a domain to a Clerk organization. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created domain summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| enrollment_mode | — | — | Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion. |
| name | string | yes | Domain name to add (for example example.com). |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| verified | — | — | Whether the domain is verified. Defaults to true when omitted. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Created organization domain summary. |
No examples provided.
clerk.create_organization_invitations ~150
Invite one or more email addresses to join a Clerk organization with specific roles. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the list of created invitation summaries. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| invitations | array | yes | One or more invitation objects. Each item requires email_address (string) and role (string, e.g. org:admin, org:member). |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| Name | Type | Req | Description |
|---|---|---|---|
| invitations | — | — | Created invitation summaries. |
No examples provided.
clerk.create_organization_membership ~156
Add a user to a Clerk organization with a specified role. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created membership. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) to add the member to. |
| role | string | yes | Role to assign to the user in the organization (e.g. org:member, org:admin). |
| user_id | string | yes | Clerk user id (user_...) of the user to add. |
| Name | Type | Req | Description |
|---|---|---|---|
| membership | — | — | Created organization membership. |
No examples provided.
clerk.create_organization_permission ~115
Create a new organization permission in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new permission summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| description | — | — | Permission description. |
| key | string | yes | Unique permission key. |
| name | string | yes | Permission display name. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_permission | — | — | Newly created organization permission summary. |
No examples provided.
clerk.create_organization_role ~147
Create a new organization role in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new role summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| description | — | — | Role description. |
| include_in_initial_role_set | — | — | Whether to include this role in the initial role set. |
| key | string | yes | Unique role key. |
| name | string | yes | Role display name. |
| permissions | — | — | Permission keys to assign to the new role. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_role | — | — | Newly created organization role summary. |
No examples provided.
clerk.create_phone_number ~177
Create a phone number for a Clerk user. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created phone number summary. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| phone_number | string | yes | Phone number in E.164 format (e.g. +15551234567). |
| primary | — | — | Whether this should be the user's primary phone number. |
| reserved_for_second_factor | — | — | Whether to reserve this number for multi-factor authentication. |
| user_id | string | yes | Clerk user id (user_...) to retrieve or modify. |
| verified | — | — | Whether the phone number should be marked verified. Defaults to false. |
| Name | Type | Req | Description |
|---|---|---|---|
| phone_number | — | — | Created Clerk phone number object from the Backend API. |
No examples provided.
clerk.create_redirect_url ~105
Add an allowed redirect URL to a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created redirect URL. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| url | string | yes | Redirect URL to allow for sign-in and sign-up flows. |
| Name | Type | Req | Description |
|---|---|---|---|
| redirect_url | — | — | Created Clerk redirect URL from the Backend API. |
No examples provided.
clerk.create_session ~133
Create a new session for a Clerk user in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created session object with id, user_id, status, last_active_at, expire_at, client_id, created_at, and updated_at. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| user_id | string | yes | Clerk user id (user_...) to create a session for. |
| Name | Type | Req | Description |
|---|---|---|---|
| client_id | — | — | Clerk client id associated with this session. |
| created_at | — | — | Unix timestamp in milliseconds when the session was created. |
| expire_at | — | — | Unix timestamp in milliseconds when this session expires. |
| id | — | — | Clerk session id (sess_...). |
| last_active_at | — | — | Unix timestamp in milliseconds of the last activity on this session. |
| status | — | — | Current status of the session. |
| updated_at | — | — | Unix timestamp in milliseconds when the session was last updated. |
| user_id | — | — | Clerk user id (user_...) that owns this session. |
No examples provided.
clerk.create_session_token ~174
Create a session token (JWT) for an active session in a connected Clerk application. Optionally pass template_name to create the token from a named JWT template. **Sensitive** — the returned JWT grants access on behalf of the user; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a jwt field containing the signed token. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| session_id | string | yes | Clerk session id (sess_...) to retrieve or modify. |
| template_name | — | — | Optional JWT template name. When set, the session token is created from that template. |
| Name | Type | Req | Description |
|---|---|---|---|
| jwt | — | — | Signed JWT for the session. Treat as a secret — do not log. |
No examples provided.
clerk.create_sign_in_token ~174
Create a sign-in token for a user in a connected Clerk application. The token can be used once to sign the user in without credentials (magic-link style). **Sensitive** — the returned token is a high-privilege secret that grants sign-in access; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 15 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| expires_in_seconds | — | — | Token lifetime in seconds (minimum 1). Defaults to 2592000 (30 days). |
| user_id | string | yes | Clerk user id (user_...) to retrieve or modify. |
| Name | Type | Req | Description |
|---|---|---|---|
| sign_in_token | — | — | Created Clerk sign-in token object from the Backend API. |
No examples provided.
clerk.create_svix_app ~97
Create a Svix app and associate it with a connected Clerk application for webhook delivery. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a temporary svix_url from Clerk. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| svix | — | — | Svix app response from the Clerk Backend API. |
No examples provided.
clerk.create_svix_dashboard_url ~114
Generate a temporary URL for accessing the Svix management dashboard for a connected Clerk application. **Sensitive** — the returned URL grants access to webhook configuration; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns svix_url. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| svix | — | — | Temporary Svix dashboard URL from the Clerk Backend API. |
No examples provided.
clerk.create_user ~129
Create a user in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| email_address | string | yes | Primary email address for the new Clerk user. |
| first_name | — | — | Optional first name. |
| last_name | — | — | Optional last name. |
| password | — | — | Optional password. Omit to create a user without a password. |
| Name | Type | Req | Description |
|---|---|---|---|
| user | — | — | Created Clerk user object from the Backend API. |
No examples provided.
clerk.create_waitlist_entries ~143
Add one or more email addresses to the waitlist in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the created or existing waitlist entries. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| waitlist_entries | array | yes | One or more waitlist entry objects. Each item requires email_address (string). Optional fields per item: notify (boolean; whether to notify the user their email was added; defaults to true). |
| Name | Type | Req | Description |
|---|---|---|---|
| waitlist_entries | — | — | Created or existing Clerk waitlist entry summaries. |
No examples provided.
clerk.delete_allowlist_identifier ~110
Remove an allowlist identifier by id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a deleted confirmation. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| identifier_id | string | yes | Allowlist or blocklist identifier id (alid_... or blid_...) to delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted_identifier | — | — | Clerk deleted-object payload confirming removal. |
No examples provided.
clerk.delete_api_key ~119
Permanently delete an API key from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted API key id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| api_key_id | string | yes | Clerk API key id (ak_...) to retrieve, update, delete, or revoke. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | — | — | Deletion confirmation with API key id and deleted flag. |
No examples provided.
clerk.delete_blocklist_identifier ~110
Remove a blocklist identifier by id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a deleted confirmation. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| identifier_id | string | yes | Allowlist or blocklist identifier id (alid_... or blid_...) to delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted_identifier | — | — | Clerk deleted-object payload confirming removal. |
No examples provided.
clerk.delete_domain ~113
Remove a custom domain from a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted domain id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| domain_id | string | yes | Clerk organization domain id (dmn_...) to update, delete, or verify. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Clerk deleted-object payload confirming domain removal. |
No examples provided.
clerk.delete_email_address ~112
Delete a Clerk email address by its id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted email address summary when Clerk provides it. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| email_address_id | string | yes | Clerk email address id (idn_...) to retrieve or modify. |
| Name | Type | Req | Description |
|---|---|---|---|
| email_address | — | — | Deleted Clerk email address summary, when returned by Clerk. |
No examples provided.
clerk.delete_enterprise_connection ~118
Delete an enterprise SSO connection from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted enterprise connection object from Clerk. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| connection_id | string | yes | Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test. |
| Name | Type | Req | Description |
|---|---|---|---|
| enterprise_connection | — | — | Deleted enterprise connection object returned by Clerk. |
No examples provided.
clerk.delete_jwt_template ~122
Permanently delete a JWT template from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. This action is irreversible. Returns the deleted template id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| template_id | string | yes | Clerk JWT template id (jtmp_...) to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| jwt_template | — | — | Deletion confirmation with template id and deleted flag. |
No examples provided.
clerk.delete_machine ~105
Delete a machine by id from a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a deletion confirmation. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| machine_id | string | yes | Clerk machine id (mch_...) to retrieve or modify. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted_machine | — | — | Deleted machine confirmation from the Backend API. |
No examples provided.
clerk.delete_machine_scope ~129
Delete a machine scope, removing access from one machine to another. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns a deletion confirmation. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| machine_id | string | yes | Clerk machine id (mch_...) to retrieve or modify. |
| scope_id | string | yes | Target machine id (mch_...) for the scope to remove. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted_machine_scope | — | — | Deleted machine scope confirmation from the Backend API. |
No examples provided.
clerk.delete_oauth_application ~116
Permanently delete an OAuth application from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted OAuth application object from Clerk. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| oauth_application_id | string | yes | Clerk OAuth application id (oa_...) to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_application | — | — | Deleted Clerk OAuth application object from the Backend API. |
No examples provided.
clerk.delete_organization ~114
Permanently delete an organization from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. This action is irreversible. Returns the deleted organization id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization | — | — | Deletion confirmation with organization id and deleted flag. |
No examples provided.
clerk.delete_organization_domain ~114
Remove an organization domain from a Clerk organization. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted domain id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| domain_id | string | yes | Clerk organization domain id (dmn_...) to update, delete, or verify. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted_domain | — | — | Deletion confirmation with domain id and deleted flag. |
No examples provided.
clerk.delete_organization_membership ~126
Remove a user from a Clerk organization. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. This action cannot be undone. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) to remove the member from. |
| user_id | string | yes | Clerk user id (user_...) of the member to remove. |
| Name | Type | Req | Description |
|---|---|---|---|
| membership | — | — | Deleted organization membership object, when returned. |
No examples provided.
clerk.delete_organization_permission ~103
Delete an organization permission from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the Clerk deletion payload. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| permission_id | string | yes | Clerk organization permission id to update or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_permission | — | — | Clerk deletion payload for the organization permission. |
No examples provided.
clerk.delete_organization_role ~106
Delete an organization role from a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the Clerk deletion payload. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| role_id | string | yes | Clerk organization role id to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_role | — | — | Clerk deletion payload for the organization role. |
No examples provided.
clerk.delete_phone_number ~116
Delete a Clerk phone number by id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. This action cannot be undone. Returns a deleted confirmation. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| phone_number_id | string | yes | Clerk phone number id (idn_... or phn_...) to retrieve or modify. |
| Name | Type | Req | Description |
|---|---|---|---|
| deleted | — | — | Deleted object confirmation from the Clerk Backend API. |
No examples provided.
clerk.delete_redirect_url ~109
Remove an allowed redirect URL from a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the deleted redirect URL id and a deleted flag. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| redirect_url_id | string | yes | Clerk redirect URL id to retrieve or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| redirect_url | — | — | Clerk deleted-object payload confirming redirect URL removal. |
No examples provided.