Endpoints: 28,729MCP servers: 18,413Payout addresses: 2,071Paid calls: 1,536Letters: 14Defects: 1,322counted 3 min ago
teppi

Server definition

Hash
sha256:1daaf958b98689af93471b29641d2d1655c87e5e2f3fe138cc748c5af0711431
What it is
What a remote MCP server returned when asked what it offers: 269 tools

The blob, as servednamed by its sha256

{ "instructions": "Vee3 agent capabilities API.\n\nUse the **vee3** MCP server for live data and automation. Do not guess tool names, parameters, or token costs - discover them first.\n\n## How to use Vee3\n\nUse `meta-tools.search` when you are unsure which tool to use. It will return a list of tools that match your query.\nUse `meta-tools.describe` with the MCP tool name (for example `x-twitter.create_post`) for full schema, examples, and token pricing.\nTo get a high-level overview of capability areas, use `meta-tools.list_groups`.\nThen use `meta-tools.list_group_tools` with a relevant `group_id` when you know the area.\nCall `meta-tools.token_balance` to check your token balance.\nAlways call `meta-tools.report_bug` when a capability fails unexpectedly or returns wrong data.\nCall `meta-tools.request_feature` when you need something that is not available in the catalog.\n\nWhenever you need to upload or download a stored file, install the Vee3 CLI once with `npm install -g @vee3/cli` (requires Node 18+). That installs `vee3-upload` and `vee3-get-file`. Use `files.upload_file` then `vee3-upload {upload_code} {file_or_folder_path}` to upload a file or a whole folder in one command, or `files.download_file` then `vee3-get-file {download_code} [output_path]` to download. If installation fails with a TLS or certificate error or you get `fetch failed`, use Node 22.15 or newer with NODE_OPTIONS=--use-system-ca.\n\nCall `files.list_uploaded_files` to list files currently uploaded for this account.\n\nPublic catalog and examples: https://vee3.io/capabilities\nOfficial website: https://vee3.io\n## Capability groups\n\nThe user can enable and disable capability groups from Customize MCP in the dashboard: https://app.vee3.io/dashboard/customize-mcp. If a group is missing from this server, ask the user to enable it there and reconnect.\n\n- **Clerk** (`clerk`): Clerk API for agents: users, organizations, sessions, invitations, API keys, machines, webhooks, and instance settings in the user's own Clerk application.\n- **Domains** (`domains`): Domain name research, registration, and managed domains through Vee3. Check purchasable availability, quote and register domains, list and inspect owned domains, manage DNS host records, and research public DNS, WHOIS, RDAP, lookup, and TLD metadata.\n- **Files** (`files`): Upload, list, and download files for use with other Vee3 capabilities.\n- **Google Maps** (`google-maps`): Google Maps place data for agents: search places, find nearby locations, fetch place details, reviews, photos, and individual review content, plus language and place-type reference lists.\n- **Google Search** (`google-search`): Google Search keyword intelligence for agents: traffic insights, related keywords from seed terms or URLs, and search market filters.\n- **Google Search Console** (`google-search-console`): Add a site to Google Search Console. Query clicks and impressions, inspect URL indexing, and manage sitemaps. Vee3-managed domains verify automatically.\n- **Google Trends** (`google-trends`): Google Trends data. Explore trending searches, interest over time, related queries, and regional breakdowns.\n- **Image Generation** (`image-generation`): Generate and edit images from text and reference pictures.\n- **Meta tools** (`meta-tools`): Tools to help discover and introspect the Vee3 catalog.\n- **Pages** (`pages`): Host static websites. Create a page, deploy uploaded files to a CDN URL, set or buy a custom domain, and inspect traffic.\n- **Rotten Tomatoes** (`rotten-tomatoes`): Rotten Tomatoes movie and TV data for agents: search, scores, reviews, cast and crew, seasons, episodes, and celebrity filmography.\n- **SEO** (`seo`): Search engine optimization data for agents. Backlink analysis, domain authority and metrics, URL metrics, and keyword research.\n- **TikTok** (`tiktok`): TikTok data for agents: user profiles, followers and following, videos and reposts, search, comments and replies, music tracks, for you feeds, video and audio downloads.\n- **Website Screenshots** (`website-screenshots`): Capture screenshots of public websites.\n- **X / Twitter** (`x-twitter`): X (Twitter) API for agents: search and read posts, users, timelines, and bookmarks; publish, edit, reply, delete, repost, and bookmark via connected accounts.\n- **YouTube** (`youtube`): YouTube data for agents: channel and playlist metadata, channel videos, search, autocomplete, comments, and video details.\n\n", "tools": [ { "description": "Add a custom domain to a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created domain with CNAME targets for DNS setup.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "is_satellite": { "description": "Whether this is a satellite domain.", "title": "Is Satellite", "type": "boolean" }, "name": { "description": "Domain hostname to add.", "title": "Name", "type": "string" }, "proxy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Proxy URL when using a satellite domain behind a reverse proxy.", "title": "Proxy Url" } }, "required": [ "name", "is_satellite" ], "title": "add_clerk_domainArguments", "type": "object" }, "name": "clerk.add_domain", "outputSchema": { "$defs": { "AddClerkDomainResponseDomain": { "additionalProperties": true, "properties": { "accounts_portal_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Accounts portal URL for the domain.", "title": "Accounts Portal Url" }, "cname_targets": { "anyOf": [ { "items": { "$ref": "#/$defs/AddClerkDomainResponseDomainCnameTargetsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "CNAME records required to verify the domain.", "title": "Cname Targets" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin associated with the domain.", "title": "Development Origin" }, "frontend_api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Frontend API URL for the domain.", "title": "Frontend Api Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk domain id.", "title": "Id" }, "is_satellite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a satellite domain.", "title": "Is Satellite" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain hostname.", "title": "Name" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the domain.", "title": "Object" }, "proxy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Proxy URL when using a satellite domain behind a reverse proxy.", "title": "Proxy Url" } }, "title": "AddClerkDomainResponseDomain", "type": "object" }, "AddClerkDomainResponseDomainCnameTargetsItem": { "additionalProperties": true, "properties": { "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS host label for the CNAME record.", "title": "Host" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this CNAME record is required for domain verification.", "title": "Required" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS target value for the CNAME record.", "title": "Value" } }, "title": "AddClerkDomainResponseDomainCnameTargetsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/AddClerkDomainResponseDomain" }, { "type": "null" } ], "default": null, "description": "Created Clerk domain from the Backend API." } }, "title": "AddClerkDomainResponse", "type": "object" } }, { "description": "Ban one or more Clerk users, preventing them from signing in.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user summaries and total count.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_ids": { "description": "List of one or more Clerk user ids (user_...) to ban.", "items": { "type": "string" }, "title": "User Ids", "type": "array" } }, "required": [ "user_ids" ], "title": "ban_clerk_usersArguments", "type": "object" }, "name": "clerk.ban_users", "outputSchema": { "$defs": { "BanClerkUsersResponseUsersItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "BanClerkUsersResponseUsersItem", "type": "object" } }, "additionalProperties": true, "properties": { "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of users that were banned.", "title": "Total Count" }, "users": { "anyOf": [ { "items": { "$ref": "#/$defs/BanClerkUsersResponseUsersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Updated user summaries for all banned users.", "title": "Users" } }, "title": "BanClerkUsersResponse", "type": "object" } }, { "description": "Change the primary or secondary home URL for a connected Clerk instance.\n\nWARNING: Destructive operation — changing the instance domain invalidates active sessions and may cause brief downtime.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns whether Clerk accepted the domain change request.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "home_url": { "description": "New home URL for the instance domain.", "title": "Home Url", "type": "string" }, "is_secondary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, change the secondary domain instead of the primary.", "title": "Is Secondary" } }, "required": [ "home_url" ], "title": "change_clerk_instance_domainArguments", "type": "object" }, "name": "clerk.change_instance_domain", "outputSchema": { "additionalProperties": true, "properties": { "accepted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Clerk accepted the domain change request.", "title": "Accepted" } }, "title": "ChangeClerkInstanceDomainResponse", "type": "object" } }, { "description": "Return the total number of users in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCheaper than listing users when you only need the total count.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional filter query forwarded to Clerk (email, phone, username, or external id).", "title": "Query" } }, "title": "count_clerk_usersArguments", "type": "object" }, "name": "clerk.count_users", "outputSchema": { "additionalProperties": true, "properties": { "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of users in the Clerk application.", "title": "Total Count" } }, "title": "CountClerkUsersResponse", "type": "object" } }, { "description": "Create an actor token that lets one user impersonate another in a connected Clerk application.\n\n**Sensitive** — the returned token is a high-privilege secret that grants impersonation access; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "actor_sub": { "description": "Clerk user id (user_...) of the impersonating actor (maps to actor.sub).", "title": "Actor Sub", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "expires_in_seconds": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour).", "title": "Expires In Seconds" }, "session_max_duration_in_seconds": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes).", "title": "Session Max Duration In Seconds" }, "user_id": { "description": "Clerk user id (user_...) of the user being impersonated.", "title": "User Id", "type": "string" } }, "required": [ "user_id", "actor_sub" ], "title": "create_clerk_actor_tokenArguments", "type": "object" }, "name": "clerk.create_actor_token", "outputSchema": { "$defs": { "CreateClerkActorTokenResponseActorToken": { "additionalProperties": true, "properties": { "actor": { "anyOf": [ { "$ref": "#/$defs/CreateClerkActorTokenResponseActorTokenActor" }, { "type": "null" } ], "default": null, "description": "Actor payload; includes sub with the impersonating user id." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Actor token id.", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token status (pending, accepted, or revoked).", "title": "Status" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Actor token secret. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional sign-in URL that includes the actor token.", "title": "Url" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) being impersonated.", "title": "User Id" } }, "title": "CreateClerkActorTokenResponseActorToken", "type": "object" }, "CreateClerkActorTokenResponseActorTokenActor": { "additionalProperties": true, "properties": { "sub": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the impersonating actor.", "title": "Sub" } }, "title": "CreateClerkActorTokenResponseActorTokenActor", "type": "object" } }, "additionalProperties": true, "properties": { "actor_token": { "anyOf": [ { "$ref": "#/$defs/CreateClerkActorTokenResponseActorToken" }, { "type": "null" } ], "default": null, "description": "Created Clerk actor token object from the Backend API." } }, "title": "CreateClerkActorTokenResponse", "type": "object" } }, { "description": "Create an admin portal link token in a connected Clerk instance.\n\n**Sensitive** — the returned token is a single-use deep-link secret; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "it_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional opaque IT contact reference for the link.", "title": "It Contact Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional organization id (org_...) to scope the admin portal link.", "title": "Organization Id" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Optional scopes for the link (for example \"admin_portal:read\").", "title": "Scopes" }, "seconds_until_expiration": { "anyOf": [ { "maximum": 86400, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Link token lifetime in seconds (default 3600, max 86400).", "title": "Seconds Until Expiration" } }, "title": "create_clerk_admin_portal_link_tokenArguments", "type": "object" }, "name": "clerk.create_admin_portal_link_token", "outputSchema": { "$defs": { "CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken": { "additionalProperties": true, "properties": { "admin_portal_link_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Origin admin portal link id (apl_...).", "title": "Admin Portal Link Id" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the link token was created.", "title": "Created At" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the link token expires.", "title": "Expiration" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the link token has expired.", "title": "Expired" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Admin portal link token id (aplt_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...).", "title": "Instance Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the link token has been revoked.", "title": "Revoked" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.", "title": "Token" } }, "title": "CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken", "type": "object" } }, "additionalProperties": true, "properties": { "admin_portal_link_token": { "anyOf": [ { "$ref": "#/$defs/CreateClerkAdminPortalLinkTokenResponseAdminPortalLinkToken" }, { "type": "null" } ], "default": null, "description": "Created admin portal link token from the Backend API." } }, "title": "CreateClerkAdminPortalLinkTokenResponse", "type": "object" } }, { "description": "Add an identifier to the allowlist in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created allowlist identifier summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "identifier": { "description": "Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address.", "title": "Identifier", "type": "string" }, "notify": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, notify the user by email or SMS that they were added to the allowlist.", "title": "Notify" } }, "required": [ "identifier" ], "title": "create_clerk_allowlist_identifierArguments", "type": "object" }, "name": "clerk.create_allowlist_identifier", "outputSchema": { "$defs": { "CreateClerkAllowlistIdentifierResponseIdentifier": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowlist identifier id (alid_...).", "title": "Id" }, "identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowlisted email, phone, domain pattern, or Web3 wallet address.", "title": "Identifier" }, "identifier_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of identifier: \"email_address\", \"phone_number\", or \"web3_wallet\".", "title": "Identifier Type" }, "invitation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk invitation id (inv_...) when the entry was created from an invitation.", "title": "Invitation Id" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "CreateClerkAllowlistIdentifierResponseIdentifier", "type": "object" } }, "additionalProperties": true, "properties": { "identifier": { "anyOf": [ { "$ref": "#/$defs/CreateClerkAllowlistIdentifierResponseIdentifier" }, { "type": "null" } ], "default": null, "description": "Created allowlist identifier object from the Backend API." } }, "title": "CreateClerkAllowlistIdentifierResponse", "type": "object" } }, { "description": "Create an API key in a connected Clerk application.\n\n**Sensitive** — the returned secret is a high-privilege credential; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new API key summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "claims": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Custom claims to embed in tokens minted from this API key.", "title": "Claims" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id to record as the creator of this API key.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "description": "Human-readable name for the new API key.", "title": "Name", "type": "string" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes to grant the API key.", "title": "Scopes" }, "seconds_until_expiration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Seconds from creation until the API key expires.", "title": "Seconds Until Expiration" }, "subject": { "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject", "type": "string" } }, "required": [ "name", "subject" ], "title": "create_clerk_api_keyArguments", "type": "object" }, "name": "clerk.create_api_key", "outputSchema": { "$defs": { "CreateClerkApiKeyResponseApiKey": { "additionalProperties": true, "properties": { "claims": { "anyOf": [ { "$ref": "#/$defs/CreateClerkApiKeyResponseApiKeyClaims" }, { "type": "null" } ], "default": null, "description": "Custom claims embedded in tokens minted from this API key." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was created.", "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id that created the API key, when set.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key expires, if set.", "title": "Expiration" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk API key id (ak_...).", "title": "Id" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable API key name.", "title": "Name" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason recorded when the API key was revoked.", "title": "Revocation Reason" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the API key has been revoked.", "title": "Revoked" }, "scopes": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkApiKeyResponseApiKeyScopesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes granted to this API key.", "title": "Scopes" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was last updated.", "title": "Updated At" } }, "title": "CreateClerkApiKeyResponseApiKey", "type": "object" }, "CreateClerkApiKeyResponseApiKeyClaims": { "additionalProperties": true, "properties": { "claim_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key in the custom claims object.", "title": "Claim Key" } }, "title": "CreateClerkApiKeyResponseApiKeyClaims", "type": "object" }, "CreateClerkApiKeyResponseApiKeyScopesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A single scope string.", "title": "Item" } }, "title": "CreateClerkApiKeyResponseApiKeyScopesItem", "type": "object" } }, "additionalProperties": true, "properties": { "api_key": { "anyOf": [ { "$ref": "#/$defs/CreateClerkApiKeyResponseApiKey" }, { "type": "null" } ], "default": null, "description": "Newly created Clerk API key from the Backend API." } }, "title": "CreateClerkApiKeyResponse", "type": "object" } }, { "description": "Add an identifier to the blocklist in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nBlocked identifiers cannot sign up or sign in. Returns the created blocklist identifier summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "identifier": { "description": "Identifier to block: email, domain, E.164 phone (+15555555555), or Web3 wallet address.", "title": "Identifier", "type": "string" } }, "required": [ "identifier" ], "title": "create_clerk_blocklist_identifierArguments", "type": "object" }, "name": "clerk.create_blocklist_identifier", "outputSchema": { "$defs": { "CreateClerkBlocklistIdentifierResponseIdentifier": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Blocklist identifier id (blid_...).", "title": "Id" }, "identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Blocklisted email, domain, phone, or Web3 wallet address.", "title": "Identifier" }, "identifier_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of identifier: \"email_address\", \"phone_number\", or \"web3_wallet\".", "title": "Identifier Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "CreateClerkBlocklistIdentifierResponseIdentifier", "type": "object" } }, "additionalProperties": true, "properties": { "identifier": { "anyOf": [ { "$ref": "#/$defs/CreateClerkBlocklistIdentifierResponseIdentifier" }, { "type": "null" } ], "default": null, "description": "Created blocklist identifier object from the Backend API." } }, "title": "CreateClerkBlocklistIdentifierResponse", "type": "object" } }, { "description": "Create a new email address for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created email address summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "email_address": { "description": "Email address to create for the user.", "title": "Email Address", "type": "string" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, set this email as the user's primary email address.", "title": "Primary" }, "user_id": { "description": "Clerk user id (user_...) to retrieve or modify.", "title": "User Id", "type": "string" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, the email address is created as verified.", "title": "Verified" } }, "required": [ "user_id", "email_address" ], "title": "create_clerk_email_addressArguments", "type": "object" }, "name": "clerk.create_email_address", "outputSchema": { "$defs": { "CreateClerkEmailAddressResponseEmailAddress": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address value.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk email address id (idn_...).", "title": "Id" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's primary email address.", "title": "Primary" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this email address.", "title": "User Id" }, "verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verification status (e.g. verified, unverified, failed).", "title": "Verification Status" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the email address is verified.", "title": "Verified" } }, "title": "CreateClerkEmailAddressResponseEmailAddress", "type": "object" } }, "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "$ref": "#/$defs/CreateClerkEmailAddressResponseEmailAddress" }, { "type": "null" } ], "default": null, "description": "Created Clerk email address summary." } }, "title": "CreateClerkEmailAddressResponse", "type": "object" } }, { "description": "Create a SAML or OIDC enterprise SSO connection in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new enterprise_connection summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is allowed.", "title": "Allow Organization Account Linking" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "custom_attributes": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to block additional identifications for this connection.", "title": "Disable Additional Identifications" }, "domains": { "description": "Email domains that may use this connection.", "items": { "type": "string" }, "title": "Domains", "type": "array" }, "name": { "description": "Display name for the enterprise connection.", "title": "Name", "type": "string" }, "oidc": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "OIDC client configuration when provider uses OAuth.", "title": "Oidc" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) to link to this connection.", "title": "Organization Id" }, "provider": { "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider", "type": "string" }, "saml": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "SAML IdP configuration when provider uses SAML.", "title": "Saml" }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to sync user attributes on each sign-in.", "title": "Sync User Attributes" } }, "required": [ "name", "provider", "domains" ], "title": "create_clerk_enterprise_connectionArguments", "type": "object" }, "name": "clerk.create_enterprise_connection", "outputSchema": { "$defs": { "CreateClerkEnterpriseConnectionResponseEnterpriseConnection": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is supported.", "title": "Allow Organization Account Linking" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was created.", "title": "Created At" }, "custom_attributes": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether users may add additional identifications with this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email domains that may use this connection.", "title": "Domains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection id.", "title": "Id" }, "logo_public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public logo URL for the connection when available.", "title": "Logo Public Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the connection.", "title": "Name" }, "oauth_config": { "anyOf": [ { "$ref": "#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig" }, { "type": "null" } ], "default": null, "description": "OIDC configuration when the connection uses OAuth." }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Linked Clerk organization id (org_...) when the connection is org-scoped.", "title": "Organization Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider" }, "saml_connection": { "anyOf": [ { "$ref": "#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection" }, { "type": "null" } ], "default": null, "description": "SAML configuration when the connection uses SAML." }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether user attributes sync on each sign-in.", "title": "Sync User Attributes" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was last updated.", "title": "Updated At" } }, "title": "CreateClerkEnterpriseConnectionResponseEnterpriseConnection", "type": "object" }, "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem": { "additionalProperties": true, "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metadata key used to store the attribute on the user.", "title": "Key" }, "multi_valued": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the attribute supports multiple values.", "title": "Multi Valued" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the custom attribute.", "title": "Name" }, "scim_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "GJSON path to extract the value from SCIM resources.", "title": "Scim Path" }, "sso_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Path to extract the value from SSO claims.", "title": "Sso Path" } }, "title": "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem", "type": "object" }, "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id.", "title": "Client Id" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OIDC discovery URL.", "title": "Discovery Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth config id when the connection uses OIDC.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom OIDC provider display name.", "title": "Name" }, "provider_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider key (for example oidc_custom).", "title": "Provider Key" }, "requires_pkce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for this OAuth client.", "title": "Requires Pkce" } }, "title": "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig", "type": "object" }, "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection": { "additionalProperties": true, "properties": { "acs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Assertion Consumer Service URL.", "title": "Acs Url" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SAML connection is active.", "title": "Active" }, "allow_idp_initiated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether IdP-initiated SSO is allowed.", "title": "Allow Idp Initiated" }, "allow_subdomains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subdomains may use this connection.", "title": "Allow Subdomains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection id when the connection uses SAML.", "title": "Id" }, "idp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider entity id.", "title": "Idp Entity Id" }, "idp_sso_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider Single Sign-On URL.", "title": "Idp Sso Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection display name.", "title": "Name" }, "sp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Service Provider entity id (Clerk).", "title": "Sp Entity Id" } }, "title": "CreateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection", "type": "object" } }, "additionalProperties": true, "properties": { "enterprise_connection": { "anyOf": [ { "$ref": "#/$defs/CreateClerkEnterpriseConnectionResponseEnterpriseConnection" }, { "type": "null" } ], "default": null, "description": "Newly created enterprise SSO connection." } }, "title": "CreateClerkEnterpriseConnectionResponse", "type": "object" } }, { "description": "Start an SSO test flow for an enterprise connection in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a short-lived url that opens the IdP test flow.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "connection_id": { "description": "Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.", "title": "Connection Id", "type": "string" } }, "required": [ "connection_id" ], "title": "create_clerk_enterprise_connection_test_runArguments", "type": "object" }, "name": "clerk.create_enterprise_connection_test_run", "outputSchema": { "additionalProperties": true, "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short-lived URL to start the enterprise SSO test flow.", "title": "Url" } }, "title": "CreateClerkEnterpriseConnectionTestRunResponse", "type": "object" } }, { "description": "Invite one or more email addresses to sign up for a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "invitations": { "description": "One or more invitation objects. Each item requires email_address (string). Optional fields per item: role (string), redirect_url (string), public_metadata (object).", "items": { "additionalProperties": true, "type": "object" }, "title": "Invitations", "type": "array" } }, "required": [ "invitations" ], "title": "create_clerk_invitationsArguments", "type": "object" }, "name": "clerk.create_invitations", "outputSchema": { "$defs": { "CreateClerkInvitationsResponseInvitationsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the invitation was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk invitation id (inv_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the invitation has been revoked.", "title": "Revoked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: \"pending\", \"accepted\", \"revoked\", or \"expired\".", "title": "Status" } }, "title": "CreateClerkInvitationsResponseInvitationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "invitations": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkInvitationsResponseInvitationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Created Clerk invitation summaries.", "title": "Invitations" } }, "title": "CreateClerkInvitationsResponse", "type": "object" } }, { "description": "Create a new JWT template in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new template summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "allowed_clock_skew": { "anyOf": [ { "maximum": 300, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Allowed clock skew in seconds (0–300).", "title": "Allowed Clock Skew" }, "claims": { "additionalProperties": true, "description": "JWT claims template as a JSON object.", "title": "Claims", "type": "object" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to use a custom signing key and algorithm.", "title": "Custom Signing Key" }, "lifetime": { "anyOf": [ { "maximum": 315360000, "minimum": 30, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (30–315360000).", "title": "Lifetime" }, "name": { "description": "Unique JWT template name.", "title": "Name", "type": "string" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing algorithm (required when custom_signing_key is true).", "title": "Signing Algorithm" }, "signing_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing private key (required when custom_signing_key is true).", "title": "Signing Key" } }, "required": [ "name", "claims" ], "title": "create_clerk_jwt_templateArguments", "type": "object" }, "name": "clerk.create_jwt_template", "outputSchema": { "$defs": { "CreateClerkJwtTemplateResponseJwtTemplate": { "additionalProperties": true, "properties": { "allowed_clock_skew": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Allowed clock skew in seconds for the nbf claim.", "title": "Allowed Clock Skew" }, "claims": { "anyOf": [ { "$ref": "#/$defs/CreateClerkJwtTemplateResponseJwtTemplateClaims" }, { "type": "null" } ], "default": null, "description": "JWT claims template as a JSON object (may include Clerk shortcodes)." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was created.", "title": "Created At" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this template uses a custom signing key and algorithm.", "title": "Custom Signing Key" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk JWT template id (jtmp_...).", "title": "Id" }, "lifetime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (exp claim offset from issuance time).", "title": "Lifetime" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique template name used when minting tokens from this template.", "title": "Name" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing algorithm when custom_signing_key is enabled.", "title": "Signing Algorithm" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was last updated.", "title": "Updated At" } }, "title": "CreateClerkJwtTemplateResponseJwtTemplate", "type": "object" }, "CreateClerkJwtTemplateResponseJwtTemplateClaims": { "additionalProperties": true, "properties": { "aud": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Audience claim when set in the template.", "title": "Aud" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role claim when set in the template.", "title": "Role" } }, "title": "CreateClerkJwtTemplateResponseJwtTemplateClaims", "type": "object" } }, "additionalProperties": true, "properties": { "jwt_template": { "anyOf": [ { "$ref": "#/$defs/CreateClerkJwtTemplateResponseJwtTemplate" }, { "type": "null" } ], "default": null, "description": "Newly created Clerk JWT template summary." } }, "title": "CreateClerkJwtTemplateResponse", "type": "object" } }, { "description": "Create an M2M token in a connected Clerk instance.\n\n**Sensitive** — the returned token is a high-privilege secret; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created M2M token.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "claims": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional custom claims embedded in the token.", "title": "Claims" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_secret_key": { "description": "Machine secret key (msk_...) used to authenticate the create request.", "title": "Machine Secret Key", "type": "string" }, "min_remaining_ttl_seconds": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "For opaque tokens, reuse an existing token with at least this TTL remaining.", "title": "Min Remaining Ttl Seconds" }, "seconds_until_expiration": { "anyOf": [ { "minimum": 0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds.", "title": "Seconds Until Expiration" }, "token_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token format: \"opaque\" (default) or \"jwt\".", "title": "Token Format" } }, "required": [ "machine_secret_key" ], "title": "create_clerk_m2m_tokenArguments", "type": "object" }, "name": "clerk.create_m2m_token", "outputSchema": { "$defs": { "CreateClerkM2mTokenResponseM2mToken": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token expires.", "title": "Expiration" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has expired.", "title": "Expired" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token id (mt_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has been revoked.", "title": "Revoked" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...) that created or owns the token.", "title": "Subject" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token secret when returned on creation. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" } }, "title": "CreateClerkM2mTokenResponseM2mToken", "type": "object" } }, "additionalProperties": true, "properties": { "m2m_token": { "anyOf": [ { "$ref": "#/$defs/CreateClerkM2mTokenResponseM2mToken" }, { "type": "null" } ], "default": null, "description": "Created M2M token from the Backend API." } }, "title": "CreateClerkM2mTokenResponse", "type": "object" } }, { "description": "Create a machine in a connected Clerk instance for machine-to-machine authentication.\n\n**Sensitive** — the response may include a machine secret_key on creation; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "default_token_ttl": { "anyOf": [ { "maximum": 315360000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Default M2M token lifetime in seconds (minimum 1).", "title": "Default Token Ttl" }, "name": { "description": "Machine display name (1–255 characters).", "title": "Name", "type": "string" }, "scoped_machines": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Machine ids (mch_...) this machine may access (max 150).", "title": "Scoped Machines" } }, "required": [ "name" ], "title": "create_clerk_machineArguments", "type": "object" }, "name": "clerk.create_machine", "outputSchema": { "$defs": { "CreateClerkMachineResponseMachine": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was created.", "title": "Created At" }, "default_token_ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Default token lifetime in seconds for tokens created by this machine.", "title": "Default Token Ttl" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns the machine.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine display name.", "title": "Name" }, "secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key returned on create. Treat as high-privilege — do not log.", "title": "Secret Key" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was last updated.", "title": "Updated At" } }, "title": "CreateClerkMachineResponseMachine", "type": "object" } }, "additionalProperties": true, "properties": { "machine": { "anyOf": [ { "$ref": "#/$defs/CreateClerkMachineResponseMachine" }, { "type": "null" } ], "default": null, "description": "Created machine object from the Backend API." } }, "title": "CreateClerkMachineResponse", "type": "object" } }, { "description": "Create a machine scope so one machine can access another.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created machine scope.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" }, "to_machine_id": { "description": "Target machine id (mch_...) to grant access to.", "title": "To Machine Id", "type": "string" } }, "required": [ "machine_id", "to_machine_id" ], "title": "create_clerk_machine_scopeArguments", "type": "object" }, "name": "clerk.create_machine_scope", "outputSchema": { "$defs": { "CreateClerkMachineScopeResponseMachineScope": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the scope was created.", "title": "Created At" }, "from_machine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id that was granted access.", "title": "From Machine Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type (machine_scope).", "title": "Object" }, "to_machine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id that can be accessed.", "title": "To Machine Id" } }, "title": "CreateClerkMachineScopeResponseMachineScope", "type": "object" } }, "additionalProperties": true, "properties": { "machine_scope": { "anyOf": [ { "$ref": "#/$defs/CreateClerkMachineScopeResponseMachineScope" }, { "type": "null" } ], "default": null, "description": "Created machine scope from the Backend API." } }, "title": "CreateClerkMachineScopeResponse", "type": "object" } }, { "description": "Create a new OAuth application in a connected Clerk application (Clerk as IdP).\n\n**Sensitive** — client_secret may be present for confidential clients; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new OAuth application summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to show the OAuth consent screen during authorization.", "title": "Consent Screen Enabled" }, "name": { "description": "Display name for the new OAuth application.", "title": "Name", "type": "string" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (no client secret; PKCE-capable).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes (e.g. profile email public_metadata).", "title": "Scopes" } }, "required": [ "name" ], "title": "create_clerk_oauth_applicationArguments", "type": "object" }, "name": "clerk.create_oauth_application", "outputSchema": { "$defs": { "CreateClerkOauthApplicationResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "CreateClerkOauthApplicationResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOauthApplicationResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "Newly created Clerk OAuth application summary." } }, "title": "CreateClerkOauthApplicationResponse", "type": "object" } }, { "description": "Create a new organization in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new organization summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "created_by": { "description": "Clerk user id (user_...) of the user creating the organization.", "title": "Created By", "type": "string" }, "max_allowed_memberships": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Optional maximum number of memberships allowed.", "title": "Max Allowed Memberships" }, "name": { "description": "Organization display name.", "title": "Name", "type": "string" }, "private_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional private metadata as a JSON object.", "title": "Private Metadata" }, "public_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional public metadata as a JSON object.", "title": "Public Metadata" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional URL-friendly slug for the organization.", "title": "Slug" } }, "required": [ "name", "created_by" ], "title": "create_clerk_organizationArguments", "type": "object" }, "name": "clerk.create_organization", "outputSchema": { "$defs": { "CreateClerkOrganizationResponseOrganization": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the organization was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Id" }, "members_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current number of members in the organization.", "title": "Members Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization display name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL-friendly organization slug, if set.", "title": "Slug" } }, "title": "CreateClerkOrganizationResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "organization": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOrganizationResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Newly created Clerk organization summary." } }, "title": "CreateClerkOrganizationResponse", "type": "object" } }, { "description": "Add a domain to a Clerk organization.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created domain summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "name": { "description": "Domain name to add (for example example.com).", "title": "Name", "type": "string" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain is verified. Defaults to true when omitted.", "title": "Verified" } }, "required": [ "organization_id", "name" ], "title": "create_clerk_organization_domainArguments", "type": "object" }, "name": "clerk.create_organization_domain", "outputSchema": { "$defs": { "CreateClerkOrganizationDomainResponseDomain": { "additionalProperties": true, "properties": { "affiliation_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation email address for the domain, when set.", "title": "Affiliation Email Address" }, "affiliation_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation verification status (unverified, verified, failed, or expired).", "title": "Affiliation Verification Status" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was created.", "title": "Created At" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization domain id (dmn_...).", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain name (for example example.com).", "title": "Name" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this domain.", "title": "Organization Id" }, "ownership_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS ownership verification status (unverified, verified, failed, or expired).", "title": "Ownership Verification Status" }, "total_pending_invitations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending invitations associated with this domain.", "title": "Total Pending Invitations" }, "total_pending_suggestions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending membership suggestions associated with this domain.", "title": "Total Pending Suggestions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was last updated.", "title": "Updated At" } }, "title": "CreateClerkOrganizationDomainResponseDomain", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOrganizationDomainResponseDomain" }, { "type": "null" } ], "default": null, "description": "Created organization domain summary." } }, "title": "CreateClerkOrganizationDomainResponse", "type": "object" } }, { "description": "Invite one or more email addresses to join a Clerk organization with specific roles.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the list of created invitation summaries.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "invitations": { "description": "One or more invitation objects. Each item requires email_address (string) and role (string, e.g. org:admin, org:member).", "items": { "additionalProperties": true, "type": "object" }, "title": "Invitations", "type": "array" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id", "invitations" ], "title": "create_clerk_organization_invitationsArguments", "type": "object" }, "name": "clerk.create_organization_invitations", "outputSchema": { "$defs": { "CreateClerkOrganizationInvitationsResponseInvitationsItem": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization invitation id (inv_...).", "title": "Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this invitation.", "title": "Organization Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role assigned to the invitee (e.g. org:admin, org:member).", "title": "Role" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: pending, accepted, or revoked.", "title": "Status" } }, "title": "CreateClerkOrganizationInvitationsResponseInvitationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "invitations": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkOrganizationInvitationsResponseInvitationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Created invitation summaries.", "title": "Invitations" } }, "title": "CreateClerkOrganizationInvitationsResponse", "type": "object" } }, { "description": "Add a user to a Clerk organization with a specified role.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created membership.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) to add the member to.", "title": "Organization Id", "type": "string" }, "role": { "description": "Role to assign to the user in the organization (e.g. org:member, org:admin).", "title": "Role", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) of the user to add.", "title": "User Id", "type": "string" } }, "required": [ "organization_id", "user_id", "role" ], "title": "create_clerk_organization_membershipArguments", "type": "object" }, "name": "clerk.create_organization_membership", "outputSchema": { "$defs": { "CreateClerkOrganizationMembershipResponseMembership": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization membership id (orgmem_...).", "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role of the member in the organization (e.g. org:admin, org:member).", "title": "Role" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the member.", "title": "User Id" } }, "title": "CreateClerkOrganizationMembershipResponseMembership", "type": "object" } }, "additionalProperties": true, "properties": { "membership": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOrganizationMembershipResponseMembership" }, { "type": "null" } ], "default": null, "description": "Created organization membership." } }, "title": "CreateClerkOrganizationMembershipResponse", "type": "object" } }, { "description": "Create a new organization permission in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new permission summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "key": { "description": "Unique permission key.", "title": "Key", "type": "string" }, "name": { "description": "Permission display name.", "title": "Name", "type": "string" } }, "required": [ "name", "key" ], "title": "create_clerk_organization_permissionArguments", "type": "object" }, "name": "clerk.create_organization_permission", "outputSchema": { "$defs": { "CreateClerkOrganizationPermissionResponseOrganizationPermission": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "CreateClerkOrganizationPermissionResponseOrganizationPermission", "type": "object" } }, "additionalProperties": true, "properties": { "organization_permission": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOrganizationPermissionResponseOrganizationPermission" }, { "type": "null" } ], "default": null, "description": "Newly created organization permission summary." } }, "title": "CreateClerkOrganizationPermissionResponse", "type": "object" } }, { "description": "Create a new organization role in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new role summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role description.", "title": "Description" }, "include_in_initial_role_set": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to include this role in the initial role set.", "title": "Include In Initial Role Set" }, "key": { "description": "Unique role key.", "title": "Key", "type": "string" }, "name": { "description": "Role display name.", "title": "Name", "type": "string" }, "permissions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission keys to assign to the new role.", "title": "Permissions" } }, "required": [ "name", "key" ], "title": "create_clerk_organization_roleArguments", "type": "object" }, "name": "clerk.create_organization_role", "outputSchema": { "$defs": { "CreateClerkOrganizationRoleResponseOrganizationRole": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization role id.", "title": "Id" }, "is_creator_eligible": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this role may be assigned as organization creator.", "title": "Is Creator Eligible" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role key used in memberships.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role display name.", "title": "Name" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permissions assigned to this role.", "title": "Permissions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was last updated.", "title": "Updated At" } }, "title": "CreateClerkOrganizationRoleResponseOrganizationRole", "type": "object" }, "CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "CreateClerkOrganizationRoleResponseOrganizationRolePermissionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_role": { "anyOf": [ { "$ref": "#/$defs/CreateClerkOrganizationRoleResponseOrganizationRole" }, { "type": "null" } ], "default": null, "description": "Newly created organization role summary." } }, "title": "CreateClerkOrganizationRoleResponse", "type": "object" } }, { "description": "Create a phone number for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created phone number summary.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "phone_number": { "description": "Phone number in E.164 format (e.g. +15551234567).", "title": "Phone Number", "type": "string" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this should be the user's primary phone number.", "title": "Primary" }, "reserved_for_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to reserve this number for multi-factor authentication.", "title": "Reserved For Second Factor" }, "user_id": { "description": "Clerk user id (user_...) to retrieve or modify.", "title": "User Id", "type": "string" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number should be marked verified. Defaults to false.", "title": "Verified" } }, "required": [ "user_id", "phone_number" ], "title": "create_clerk_phone_numberArguments", "type": "object" }, "name": "clerk.create_phone_number", "outputSchema": { "$defs": { "CreateClerkPhoneNumberResponsePhoneNumber": { "additionalProperties": true, "properties": { "default_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's default second factor.", "title": "Default Second Factor" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk phone number id.", "title": "Id" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number in E.164 format.", "title": "Phone Number" }, "reserved_for_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is reserved for multi-factor authentication.", "title": "Reserved For Second Factor" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is verified.", "title": "Verified" } }, "title": "CreateClerkPhoneNumberResponsePhoneNumber", "type": "object" } }, "additionalProperties": true, "properties": { "phone_number": { "anyOf": [ { "$ref": "#/$defs/CreateClerkPhoneNumberResponsePhoneNumber" }, { "type": "null" } ], "default": null, "description": "Created Clerk phone number object from the Backend API." } }, "title": "CreateClerkPhoneNumberResponse", "type": "object" } }, { "description": "Add an allowed redirect URL to a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created redirect URL.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "url": { "description": "Redirect URL to allow for sign-in and sign-up flows.", "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "create_clerk_redirect_urlArguments", "type": "object" }, "name": "clerk.create_redirect_url", "outputSchema": { "$defs": { "CreateClerkRedirectUrlResponseRedirectUrl": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk redirect URL id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the redirect URL.", "title": "Object" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URL value.", "title": "Url" } }, "title": "CreateClerkRedirectUrlResponseRedirectUrl", "type": "object" } }, "additionalProperties": true, "properties": { "redirect_url": { "anyOf": [ { "$ref": "#/$defs/CreateClerkRedirectUrlResponseRedirectUrl" }, { "type": "null" } ], "default": null, "description": "Created Clerk redirect URL from the Backend API." } }, "title": "CreateClerkRedirectUrlResponse", "type": "object" } }, { "description": "Create a new session for a Clerk user in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created session object with id, user_id, status, last_active_at, expire_at, client_id, created_at, and updated_at.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to create a session for.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "create_clerk_sessionArguments", "type": "object" }, "name": "clerk.create_session", "outputSchema": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk client id associated with this session.", "title": "Client Id" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was created.", "title": "Created At" }, "expire_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when this session expires.", "title": "Expire At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk session id (sess_...).", "title": "Id" }, "last_active_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds of the last activity on this session.", "title": "Last Active At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current status of the session.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this session.", "title": "User Id" } }, "title": "CreateClerkSessionResponse", "type": "object" } }, { "description": "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.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a jwt field containing the signed token.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "session_id": { "description": "Clerk session id (sess_...) to retrieve or modify.", "title": "Session Id", "type": "string" }, "template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional JWT template name. When set, the session token is created from that template.", "title": "Template Name" } }, "required": [ "session_id" ], "title": "create_clerk_session_tokenArguments", "type": "object" }, "name": "clerk.create_session_token", "outputSchema": { "additionalProperties": true, "properties": { "jwt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed JWT for the session. Treat as a secret — do not log.", "title": "Jwt" } }, "title": "CreateClerkSessionTokenResponse", "type": "object" } }, { "description": "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).\n\n**Sensitive** — the returned token is a high-privilege secret that grants sign-in access; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "expires_in_seconds": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (minimum 1). Defaults to 2592000 (30 days).", "title": "Expires In Seconds" }, "user_id": { "description": "Clerk user id (user_...) to retrieve or modify.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "create_clerk_sign_in_tokenArguments", "type": "object" }, "name": "clerk.create_sign_in_token", "outputSchema": { "$defs": { "CreateClerkSignInTokenResponseSignInToken": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sign-in token id.", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token status (pending, accepted, or revoked).", "title": "Status" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sign-in token secret. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional sign-in URL that includes the token.", "title": "Url" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) the token is for.", "title": "User Id" } }, "title": "CreateClerkSignInTokenResponseSignInToken", "type": "object" } }, "additionalProperties": true, "properties": { "sign_in_token": { "anyOf": [ { "$ref": "#/$defs/CreateClerkSignInTokenResponseSignInToken" }, { "type": "null" } ], "default": null, "description": "Created Clerk sign-in token object from the Backend API." } }, "title": "CreateClerkSignInTokenResponse", "type": "object" } }, { "description": "Create a Svix app and associate it with a connected Clerk application for webhook delivery.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a temporary svix_url from Clerk.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "create_clerk_svix_appArguments", "type": "object" }, "name": "clerk.create_svix_app", "outputSchema": { "$defs": { "CreateClerkSvixAppResponseSvix": { "additionalProperties": true, "properties": { "svix_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Temporary Svix URL. Treat as sensitive — do not log.", "title": "Svix Url" } }, "title": "CreateClerkSvixAppResponseSvix", "type": "object" } }, "additionalProperties": true, "properties": { "svix": { "anyOf": [ { "$ref": "#/$defs/CreateClerkSvixAppResponseSvix" }, { "type": "null" } ], "default": null, "description": "Svix app response from the Clerk Backend API." } }, "title": "CreateClerkSvixAppResponse", "type": "object" } }, { "description": "Generate a temporary URL for accessing the Svix management dashboard for a connected Clerk application.\n\n**Sensitive** — the returned URL grants access to webhook configuration; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns svix_url.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "create_clerk_svix_dashboard_urlArguments", "type": "object" }, "name": "clerk.create_svix_dashboard_url", "outputSchema": { "$defs": { "CreateClerkSvixDashboardUrlResponseSvix": { "additionalProperties": true, "properties": { "svix_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Temporary Svix URL. Treat as sensitive — do not log.", "title": "Svix Url" } }, "title": "CreateClerkSvixDashboardUrlResponseSvix", "type": "object" } }, "additionalProperties": true, "properties": { "svix": { "anyOf": [ { "$ref": "#/$defs/CreateClerkSvixDashboardUrlResponseSvix" }, { "type": "null" } ], "default": null, "description": "Temporary Svix dashboard URL from the Clerk Backend API." } }, "title": "CreateClerkSvixDashboardUrlResponse", "type": "object" } }, { "description": "Create a user in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "email_address": { "description": "Primary email address for the new Clerk user.", "title": "Email Address", "type": "string" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional first name.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional last name.", "title": "Last Name" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional password. Omit to create a user without a password.", "title": "Password" } }, "required": [ "email_address" ], "title": "create_clerk_userArguments", "type": "object" }, "name": "clerk.create_user", "outputSchema": { "$defs": { "CreateClerkUserResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "email_addresses": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkUserResponseUserEmailAddressesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email addresses associated with the user.", "title": "Email Addresses" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "CreateClerkUserResponseUser", "type": "object" }, "CreateClerkUserResponseUserEmailAddressesItem": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address value.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address identifier.", "title": "Id" } }, "title": "CreateClerkUserResponseUserEmailAddressesItem", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/CreateClerkUserResponseUser" }, { "type": "null" } ], "default": null, "description": "Created Clerk user object from the Backend API." } }, "title": "CreateClerkUserResponse", "type": "object" } }, { "description": "Add one or more email addresses to the waitlist in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the created or existing waitlist entries.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "waitlist_entries": { "description": "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).", "items": { "additionalProperties": true, "type": "object" }, "title": "Waitlist Entries", "type": "array" } }, "required": [ "waitlist_entries" ], "title": "create_clerk_waitlist_entriesArguments", "type": "object" }, "name": "clerk.create_waitlist_entries", "outputSchema": { "$defs": { "CreateClerkWaitlistEntriesResponseWaitlistEntriesItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address on the waitlist.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist entry id (wle_...).", "title": "Id" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the entry is locked during batch processing.", "title": "Is Locked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist status: \"pending\", \"invited\", \"rejected\", or \"completed\".", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "CreateClerkWaitlistEntriesResponseWaitlistEntriesItem", "type": "object" } }, "additionalProperties": true, "properties": { "waitlist_entries": { "anyOf": [ { "items": { "$ref": "#/$defs/CreateClerkWaitlistEntriesResponseWaitlistEntriesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Created or existing Clerk waitlist entry summaries.", "title": "Waitlist Entries" } }, "title": "CreateClerkWaitlistEntriesResponse", "type": "object" } }, { "description": "Remove an allowlist identifier by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a deleted confirmation.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "identifier_id": { "description": "Allowlist or blocklist identifier id (alid_... or blid_...) to delete.", "title": "Identifier Id", "type": "string" } }, "required": [ "identifier_id" ], "title": "delete_clerk_allowlist_identifierArguments", "type": "object" }, "name": "clerk.delete_allowlist_identifier", "outputSchema": { "$defs": { "DeleteClerkAllowlistIdentifierResponseDeletedIdentifier": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the identifier was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted identifier id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the deleted resource.", "title": "Object" } }, "title": "DeleteClerkAllowlistIdentifierResponseDeletedIdentifier", "type": "object" } }, "additionalProperties": true, "properties": { "deleted_identifier": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkAllowlistIdentifierResponseDeletedIdentifier" }, { "type": "null" } ], "default": null, "description": "Clerk deleted-object payload confirming removal." } }, "title": "DeleteClerkAllowlistIdentifierResponse", "type": "object" } }, { "description": "Permanently delete an API key from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted API key id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "api_key_id": { "description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke.", "title": "Api Key Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "required": [ "api_key_id" ], "title": "delete_clerk_api_keyArguments", "type": "object" }, "name": "clerk.delete_api_key", "outputSchema": { "$defs": { "DeleteClerkApiKeyResponseApiKey": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Always true when deletion succeeded.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted API key id.", "title": "Id" } }, "title": "DeleteClerkApiKeyResponseApiKey", "type": "object" } }, "additionalProperties": true, "properties": { "api_key": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkApiKeyResponseApiKey" }, { "type": "null" } ], "default": null, "description": "Deletion confirmation with API key id and deleted flag." } }, "title": "DeleteClerkApiKeyResponse", "type": "object" } }, { "description": "Remove a blocklist identifier by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a deleted confirmation.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "identifier_id": { "description": "Allowlist or blocklist identifier id (alid_... or blid_...) to delete.", "title": "Identifier Id", "type": "string" } }, "required": [ "identifier_id" ], "title": "delete_clerk_blocklist_identifierArguments", "type": "object" }, "name": "clerk.delete_blocklist_identifier", "outputSchema": { "$defs": { "DeleteClerkBlocklistIdentifierResponseDeletedIdentifier": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the identifier was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted identifier id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the deleted resource.", "title": "Object" } }, "title": "DeleteClerkBlocklistIdentifierResponseDeletedIdentifier", "type": "object" } }, "additionalProperties": true, "properties": { "deleted_identifier": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkBlocklistIdentifierResponseDeletedIdentifier" }, { "type": "null" } ], "default": null, "description": "Clerk deleted-object payload confirming removal." } }, "title": "DeleteClerkBlocklistIdentifierResponse", "type": "object" } }, { "description": "Remove a custom domain from a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted domain id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "domain_id": { "description": "Clerk organization domain id (dmn_...) to update, delete, or verify.", "title": "Domain Id", "type": "string" } }, "required": [ "domain_id" ], "title": "delete_clerk_domainArguments", "type": "object" }, "name": "clerk.delete_domain", "outputSchema": { "$defs": { "DeleteClerkDomainResponseDomain": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the resource was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted resource id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the deleted resource.", "title": "Object" } }, "title": "DeleteClerkDomainResponseDomain", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkDomainResponseDomain" }, { "type": "null" } ], "default": null, "description": "Clerk deleted-object payload confirming domain removal." } }, "title": "DeleteClerkDomainResponse", "type": "object" } }, { "description": "Delete a Clerk email address by its id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted email address summary when Clerk provides it.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "email_address_id": { "description": "Clerk email address id (idn_...) to retrieve or modify.", "title": "Email Address Id", "type": "string" } }, "required": [ "email_address_id" ], "title": "delete_clerk_email_addressArguments", "type": "object" }, "name": "clerk.delete_email_address", "outputSchema": { "$defs": { "DeleteClerkEmailAddressResponseEmailAddress": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address value.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk email address id (idn_...).", "title": "Id" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's primary email address.", "title": "Primary" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this email address.", "title": "User Id" }, "verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verification status (e.g. verified, unverified, failed).", "title": "Verification Status" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the email address is verified.", "title": "Verified" } }, "title": "DeleteClerkEmailAddressResponseEmailAddress", "type": "object" } }, "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkEmailAddressResponseEmailAddress" }, { "type": "null" } ], "default": null, "description": "Deleted Clerk email address summary, when returned by Clerk." } }, "title": "DeleteClerkEmailAddressResponse", "type": "object" } }, { "description": "Delete an enterprise SSO connection from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted enterprise connection object from Clerk.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "connection_id": { "description": "Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.", "title": "Connection Id", "type": "string" } }, "required": [ "connection_id" ], "title": "delete_clerk_enterprise_connectionArguments", "type": "object" }, "name": "clerk.delete_enterprise_connection", "outputSchema": { "$defs": { "DeleteClerkEnterpriseConnectionResponseEnterpriseConnection": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is supported.", "title": "Allow Organization Account Linking" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was created.", "title": "Created At" }, "custom_attributes": { "anyOf": [ { "items": { "$ref": "#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection was deleted.", "title": "Deleted" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether users may add additional identifications with this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email domains that may use this connection.", "title": "Domains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection id.", "title": "Id" }, "logo_public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public logo URL for the connection when available.", "title": "Logo Public Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the connection.", "title": "Name" }, "oauth_config": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig" }, { "type": "null" } ], "default": null, "description": "OIDC configuration when the connection uses OAuth." }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Linked Clerk organization id (org_...) when the connection is org-scoped.", "title": "Organization Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider" }, "saml_connection": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection" }, { "type": "null" } ], "default": null, "description": "SAML configuration when the connection uses SAML." }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether user attributes sync on each sign-in.", "title": "Sync User Attributes" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was last updated.", "title": "Updated At" } }, "title": "DeleteClerkEnterpriseConnectionResponseEnterpriseConnection", "type": "object" }, "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem": { "additionalProperties": true, "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metadata key used to store the attribute on the user.", "title": "Key" }, "multi_valued": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the attribute supports multiple values.", "title": "Multi Valued" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the custom attribute.", "title": "Name" }, "scim_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "GJSON path to extract the value from SCIM resources.", "title": "Scim Path" }, "sso_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Path to extract the value from SSO claims.", "title": "Sso Path" } }, "title": "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem", "type": "object" }, "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id.", "title": "Client Id" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OIDC discovery URL.", "title": "Discovery Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth config id when the connection uses OIDC.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom OIDC provider display name.", "title": "Name" }, "provider_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider key (for example oidc_custom).", "title": "Provider Key" }, "requires_pkce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for this OAuth client.", "title": "Requires Pkce" } }, "title": "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig", "type": "object" }, "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection": { "additionalProperties": true, "properties": { "acs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Assertion Consumer Service URL.", "title": "Acs Url" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SAML connection is active.", "title": "Active" }, "allow_idp_initiated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether IdP-initiated SSO is allowed.", "title": "Allow Idp Initiated" }, "allow_subdomains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subdomains may use this connection.", "title": "Allow Subdomains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection id when the connection uses SAML.", "title": "Id" }, "idp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider entity id.", "title": "Idp Entity Id" }, "idp_sso_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider Single Sign-On URL.", "title": "Idp Sso Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection display name.", "title": "Name" }, "sp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Service Provider entity id (Clerk).", "title": "Sp Entity Id" } }, "title": "DeleteClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection", "type": "object" } }, "additionalProperties": true, "properties": { "enterprise_connection": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkEnterpriseConnectionResponseEnterpriseConnection" }, { "type": "null" } ], "default": null, "description": "Deleted enterprise connection object returned by Clerk." } }, "title": "DeleteClerkEnterpriseConnectionResponse", "type": "object" } }, { "description": "Permanently delete a JWT template from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThis action is irreversible. Returns the deleted template id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "template_id": { "description": "Clerk JWT template id (jtmp_...) to retrieve, update, or delete.", "title": "Template Id", "type": "string" } }, "required": [ "template_id" ], "title": "delete_clerk_jwt_templateArguments", "type": "object" }, "name": "clerk.delete_jwt_template", "outputSchema": { "$defs": { "DeleteClerkJwtTemplateResponseJwtTemplate": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Always true when deletion succeeded.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted JWT template id.", "title": "Id" } }, "title": "DeleteClerkJwtTemplateResponseJwtTemplate", "type": "object" } }, "additionalProperties": true, "properties": { "jwt_template": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkJwtTemplateResponseJwtTemplate" }, { "type": "null" } ], "default": null, "description": "Deletion confirmation with template id and deleted flag." } }, "title": "DeleteClerkJwtTemplateResponse", "type": "object" } }, { "description": "Delete a machine by id from a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a deletion confirmation.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" } }, "required": [ "machine_id" ], "title": "delete_clerk_machineArguments", "type": "object" }, "name": "clerk.delete_machine", "outputSchema": { "$defs": { "DeleteClerkMachineResponseDeletedMachine": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the machine was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted machine id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type.", "title": "Object" } }, "title": "DeleteClerkMachineResponseDeletedMachine", "type": "object" } }, "additionalProperties": true, "properties": { "deleted_machine": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkMachineResponseDeletedMachine" }, { "type": "null" } ], "default": null, "description": "Deleted machine confirmation from the Backend API." } }, "title": "DeleteClerkMachineResponse", "type": "object" } }, { "description": "Delete a machine scope, removing access from one machine to another.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a deletion confirmation.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" }, "scope_id": { "description": "Target machine id (mch_...) for the scope to remove.", "title": "Scope Id", "type": "string" } }, "required": [ "machine_id", "scope_id" ], "title": "delete_clerk_machine_scopeArguments", "type": "object" }, "name": "clerk.delete_machine_scope", "outputSchema": { "$defs": { "DeleteClerkMachineScopeResponseDeletedMachineScope": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the scope was created.", "title": "Created At" }, "from_machine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id that was granted access.", "title": "From Machine Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type (machine_scope).", "title": "Object" }, "to_machine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id that can be accessed.", "title": "To Machine Id" } }, "title": "DeleteClerkMachineScopeResponseDeletedMachineScope", "type": "object" } }, "additionalProperties": true, "properties": { "deleted_machine_scope": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkMachineScopeResponseDeletedMachineScope" }, { "type": "null" } ], "default": null, "description": "Deleted machine scope confirmation from the Backend API." } }, "title": "DeleteClerkMachineScopeResponse", "type": "object" } }, { "description": "Permanently delete an OAuth application from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted OAuth application object from Clerk.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "oauth_application_id": { "description": "Clerk OAuth application id (oa_...) to retrieve, update, or delete.", "title": "Oauth Application Id", "type": "string" } }, "required": [ "oauth_application_id" ], "title": "delete_clerk_oauth_applicationArguments", "type": "object" }, "name": "clerk.delete_oauth_application", "outputSchema": { "$defs": { "DeleteClerkOauthApplicationResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "DeleteClerkOauthApplicationResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOauthApplicationResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "Deleted Clerk OAuth application object from the Backend API." } }, "title": "DeleteClerkOauthApplicationResponse", "type": "object" } }, { "description": "Permanently delete an organization from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThis action is irreversible. Returns the deleted organization id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id" ], "title": "delete_clerk_organizationArguments", "type": "object" }, "name": "clerk.delete_organization", "outputSchema": { "$defs": { "DeleteClerkOrganizationResponseOrganization": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Always true when deletion succeeded.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted organization id.", "title": "Id" } }, "title": "DeleteClerkOrganizationResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "organization": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOrganizationResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Deletion confirmation with organization id and deleted flag." } }, "title": "DeleteClerkOrganizationResponse", "type": "object" } }, { "description": "Remove an organization domain from a Clerk organization.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted domain id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "domain_id": { "description": "Clerk organization domain id (dmn_...) to update, delete, or verify.", "title": "Domain Id", "type": "string" } }, "required": [ "domain_id" ], "title": "delete_clerk_organization_domainArguments", "type": "object" }, "name": "clerk.delete_organization_domain", "outputSchema": { "$defs": { "DeleteClerkOrganizationDomainResponseDeletedDomain": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Always true when deletion succeeded.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted organization domain id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted object type (deleted).", "title": "Object" } }, "title": "DeleteClerkOrganizationDomainResponseDeletedDomain", "type": "object" } }, "additionalProperties": true, "properties": { "deleted_domain": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOrganizationDomainResponseDeletedDomain" }, { "type": "null" } ], "default": null, "description": "Deletion confirmation with domain id and deleted flag." } }, "title": "DeleteClerkOrganizationDomainResponse", "type": "object" } }, { "description": "Remove a user from a Clerk organization.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThis action cannot be undone.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) to remove the member from.", "title": "Organization Id", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) of the member to remove.", "title": "User Id", "type": "string" } }, "required": [ "organization_id", "user_id" ], "title": "delete_clerk_organization_membershipArguments", "type": "object" }, "name": "clerk.delete_organization_membership", "outputSchema": { "$defs": { "DeleteClerkOrganizationMembershipResponseMembership": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization membership id (orgmem_...).", "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role of the member in the organization (e.g. org:admin, org:member).", "title": "Role" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the member.", "title": "User Id" } }, "title": "DeleteClerkOrganizationMembershipResponseMembership", "type": "object" } }, "additionalProperties": true, "properties": { "membership": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOrganizationMembershipResponseMembership" }, { "type": "null" } ], "default": null, "description": "Deleted organization membership object, when returned." } }, "title": "DeleteClerkOrganizationMembershipResponse", "type": "object" } }, { "description": "Delete an organization permission from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the Clerk deletion payload.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "permission_id": { "description": "Clerk organization permission id to update or delete.", "title": "Permission Id", "type": "string" } }, "required": [ "permission_id" ], "title": "delete_clerk_organization_permissionArguments", "type": "object" }, "name": "clerk.delete_organization_permission", "outputSchema": { "$defs": { "DeleteClerkOrganizationPermissionResponseOrganizationPermission": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the permission was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted permission id.", "title": "Id" } }, "title": "DeleteClerkOrganizationPermissionResponseOrganizationPermission", "type": "object" } }, "additionalProperties": true, "properties": { "organization_permission": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOrganizationPermissionResponseOrganizationPermission" }, { "type": "null" } ], "default": null, "description": "Clerk deletion payload for the organization permission." } }, "title": "DeleteClerkOrganizationPermissionResponse", "type": "object" } }, { "description": "Delete an organization role from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the Clerk deletion payload.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "role_id": { "description": "Clerk organization role id to retrieve, update, or delete.", "title": "Role Id", "type": "string" } }, "required": [ "role_id" ], "title": "delete_clerk_organization_roleArguments", "type": "object" }, "name": "clerk.delete_organization_role", "outputSchema": { "$defs": { "DeleteClerkOrganizationRoleResponseOrganizationRole": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the role was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted role id.", "title": "Id" } }, "title": "DeleteClerkOrganizationRoleResponseOrganizationRole", "type": "object" } }, "additionalProperties": true, "properties": { "organization_role": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkOrganizationRoleResponseOrganizationRole" }, { "type": "null" } ], "default": null, "description": "Clerk deletion payload for the organization role." } }, "title": "DeleteClerkOrganizationRoleResponse", "type": "object" } }, { "description": "Delete a Clerk phone number by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThis action cannot be undone. Returns a deleted confirmation.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "phone_number_id": { "description": "Clerk phone number id (idn_... or phn_...) to retrieve or modify.", "title": "Phone Number Id", "type": "string" } }, "required": [ "phone_number_id" ], "title": "delete_clerk_phone_numberArguments", "type": "object" }, "name": "clerk.delete_phone_number", "outputSchema": { "$defs": { "DeleteClerkPhoneNumberResponseDeleted": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the object was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted phone number id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type that was deleted.", "title": "Object" } }, "title": "DeleteClerkPhoneNumberResponseDeleted", "type": "object" } }, "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkPhoneNumberResponseDeleted" }, { "type": "null" } ], "default": null, "description": "Deleted object confirmation from the Clerk Backend API." } }, "title": "DeleteClerkPhoneNumberResponse", "type": "object" } }, { "description": "Remove an allowed redirect URL from a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted redirect URL id and a deleted flag.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "redirect_url_id": { "description": "Clerk redirect URL id to retrieve or delete.", "title": "Redirect Url Id", "type": "string" } }, "required": [ "redirect_url_id" ], "title": "delete_clerk_redirect_urlArguments", "type": "object" }, "name": "clerk.delete_redirect_url", "outputSchema": { "$defs": { "DeleteClerkRedirectUrlResponseRedirectUrl": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the resource was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted resource id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the deleted resource.", "title": "Object" } }, "title": "DeleteClerkRedirectUrlResponseRedirectUrl", "type": "object" } }, "additionalProperties": true, "properties": { "redirect_url": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkRedirectUrlResponseRedirectUrl" }, { "type": "null" } ], "default": null, "description": "Clerk deleted-object payload confirming redirect URL removal." } }, "title": "DeleteClerkRedirectUrlResponse", "type": "object" } }, { "description": "Delete the Svix app associated with a connected Clerk application and disassociate webhook delivery.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns a deleted confirmation.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "delete_clerk_svix_appArguments", "type": "object" }, "name": "clerk.delete_svix_app", "outputSchema": { "$defs": { "DeleteClerkSvixAppResponseSvix": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when the Svix app was deleted.", "title": "Deleted" } }, "title": "DeleteClerkSvixAppResponseSvix", "type": "object" } }, "additionalProperties": true, "properties": { "svix": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkSvixAppResponseSvix" }, { "type": "null" } ], "default": null, "description": "Deletion confirmation for the Svix app." } }, "title": "DeleteClerkSvixAppResponse", "type": "object" } }, { "description": "Permanently delete a Clerk user by user id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThis action cannot be undone.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to delete.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "delete_clerk_userArguments", "type": "object" }, "name": "clerk.delete_user", "outputSchema": { "$defs": { "DeleteClerkUserResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DeleteClerkUserResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserResponseUser" }, { "type": "null" } ], "default": null, "description": "Deleted Clerk user object from the Backend API, when returned." } }, "title": "DeleteClerkUserResponse", "type": "object" } }, { "description": "Delete all MFA backup codes for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user object.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "delete_clerk_user_backup_codesArguments", "type": "object" }, "name": "clerk.delete_user_backup_codes", "outputSchema": { "$defs": { "DeleteClerkUserBackupCodesResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DeleteClerkUserBackupCodesResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserBackupCodesResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after backup codes were removed." } }, "title": "DeleteClerkUserBackupCodesResponse", "type": "object" } }, { "description": "Delete (unlink) an external OAuth or social account from a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the deleted external account.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "external_account_id": { "description": "External account id (for example ea_...) to unlink.", "title": "External Account Id", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" } }, "required": [ "user_id", "external_account_id" ], "title": "delete_clerk_user_external_accountArguments", "type": "object" }, "name": "clerk.delete_user_external_account", "outputSchema": { "$defs": { "DeleteClerkUserExternalAccountResponseExternalAccount": { "additionalProperties": true, "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "External account id (ea_...).", "title": "Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider id (for example oauth_google).", "title": "Provider" } }, "title": "DeleteClerkUserExternalAccountResponseExternalAccount", "type": "object" } }, "additionalProperties": true, "properties": { "external_account": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserExternalAccountResponseExternalAccount" }, { "type": "null" } ], "default": null, "description": "Deleted external account object from the Clerk Backend API." } }, "title": "DeleteClerkUserExternalAccountResponse", "type": "object" } }, { "description": "Delete a passkey for a Clerk user by passkey id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user object.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "passkey_id": { "description": "Passkey identification id to delete.", "title": "Passkey Id", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" } }, "required": [ "user_id", "passkey_id" ], "title": "delete_clerk_user_passkeyArguments", "type": "object" }, "name": "clerk.delete_user_passkey", "outputSchema": { "$defs": { "DeleteClerkUserPasskeyResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DeleteClerkUserPasskeyResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserPasskeyResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after the passkey was removed." } }, "title": "DeleteClerkUserPasskeyResponse", "type": "object" } }, { "description": "Delete all TOTP authenticators for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user object.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "delete_clerk_user_totpArguments", "type": "object" }, "name": "clerk.delete_user_totp", "outputSchema": { "$defs": { "DeleteClerkUserTotpResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DeleteClerkUserTotpResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserTotpResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after TOTP was removed." } }, "title": "DeleteClerkUserTotpResponse", "type": "object" } }, { "description": "Delete a Web3 wallet for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user object.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" }, "web3_wallet_id": { "description": "Web3 wallet identification id to delete.", "title": "Web3 Wallet Id", "type": "string" } }, "required": [ "user_id", "web3_wallet_id" ], "title": "delete_clerk_user_web3_walletArguments", "type": "object" }, "name": "clerk.delete_user_web3_wallet", "outputSchema": { "$defs": { "DeleteClerkUserWeb3WalletResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DeleteClerkUserWeb3WalletResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkUserWeb3WalletResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after the Web3 wallet was removed." } }, "title": "DeleteClerkUserWeb3WalletResponse", "type": "object" } }, { "description": "Delete a pending waitlist entry from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the Clerk deleted-object payload.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "waitlist_entry_id": { "description": "Clerk waitlist entry id (wle_...) to operate on.", "title": "Waitlist Entry Id", "type": "string" } }, "required": [ "waitlist_entry_id" ], "title": "delete_clerk_waitlist_entryArguments", "type": "object" }, "name": "clerk.delete_waitlist_entry", "outputSchema": { "$defs": { "DeleteClerkWaitlistEntryResponseDeleted": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the identifier was deleted.", "title": "Deleted" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted identifier id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the deleted resource.", "title": "Object" } }, "title": "DeleteClerkWaitlistEntryResponseDeleted", "type": "object" } }, "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "$ref": "#/$defs/DeleteClerkWaitlistEntryResponseDeleted" }, { "type": "null" } ], "default": null, "description": "Clerk deleted-object payload." } }, "title": "DeleteClerkWaitlistEntryResponse", "type": "object" } }, { "description": "Disable all MFA methods (SMS, TOTP, and similar) for a Clerk user at once.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user object.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to operate on.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "disable_clerk_user_mfaArguments", "type": "object" }, "name": "clerk.disable_user_mfa", "outputSchema": { "$defs": { "DisableClerkUserMfaResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "DisableClerkUserMfaResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/DisableClerkUserMfaResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after MFA was disabled." } }, "title": "DisableClerkUserMfaResponse", "type": "object" } }, { "description": "Retrieve API key metadata by id from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the API key summary without the secret.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "api_key_id": { "description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke.", "title": "Api Key Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "required": [ "api_key_id" ], "title": "get_clerk_api_keyArguments", "type": "object" }, "name": "clerk.get_api_key", "outputSchema": { "$defs": { "GetClerkApiKeyResponseApiKey": { "additionalProperties": true, "properties": { "claims": { "anyOf": [ { "$ref": "#/$defs/GetClerkApiKeyResponseApiKeyClaims" }, { "type": "null" } ], "default": null, "description": "Custom claims embedded in tokens minted from this API key." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was created.", "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id that created the API key, when set.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key expires, if set.", "title": "Expiration" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk API key id (ak_...).", "title": "Id" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable API key name.", "title": "Name" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason recorded when the API key was revoked.", "title": "Revocation Reason" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the API key has been revoked.", "title": "Revoked" }, "scopes": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkApiKeyResponseApiKeyScopesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes granted to this API key.", "title": "Scopes" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was last updated.", "title": "Updated At" } }, "title": "GetClerkApiKeyResponseApiKey", "type": "object" }, "GetClerkApiKeyResponseApiKeyClaims": { "additionalProperties": true, "properties": { "claim_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key in the custom claims object.", "title": "Claim Key" } }, "title": "GetClerkApiKeyResponseApiKeyClaims", "type": "object" }, "GetClerkApiKeyResponseApiKeyScopesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A single scope string.", "title": "Item" } }, "title": "GetClerkApiKeyResponseApiKeyScopesItem", "type": "object" } }, "additionalProperties": true, "properties": { "api_key": { "anyOf": [ { "$ref": "#/$defs/GetClerkApiKeyResponseApiKey" }, { "type": "null" } ], "default": null, "description": "Clerk API key metadata from the Backend API." } }, "title": "GetClerkApiKeyResponse", "type": "object" } }, { "description": "Reveal the secret for an API key in a connected Clerk application.\n\n**Sensitive** — the returned secret is a high-privilege credential; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns secret.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "api_key_id": { "description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke.", "title": "Api Key Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "required": [ "api_key_id" ], "title": "get_clerk_api_key_secretArguments", "type": "object" }, "name": "clerk.get_api_key_secret", "outputSchema": { "additionalProperties": true, "properties": { "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" } }, "title": "GetClerkApiKeySecretResponse", "type": "object" } }, { "description": "List Clerk applications connected to the authenticated Vee3 account.\n\nReturns clerk_instance_id, display name, environment type, and whether each connection is the default. Use clerk_instance_id on future Clerk calls, or omit it to use the default account.\n\nIf accounts is empty, the user must connect a Clerk application at https://vee3.io/dashboard/connections before Clerk capabilities work. Agents cannot complete the connection flow; ask the user to connect, then call this tool again.\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "get_clerk_connected_accountsArguments", "type": "object" }, "name": "clerk.get_connected_accounts", "outputSchema": { "$defs": { "GetClerkConnectedAccountsResponseAccountsItem": { "additionalProperties": true, "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) to pass as clerk_instance_id on Clerk calls.", "title": "Clerk Instance Id" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Connected Clerk application label shown in the dashboard.", "title": "Display Name" }, "environment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk environment for the connection: development or production.", "title": "Environment Type" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this account is used when clerk_instance_id is omitted on Clerk calls.", "title": "Is Default" } }, "title": "GetClerkConnectedAccountsResponseAccountsItem", "type": "object" } }, "additionalProperties": true, "properties": { "accounts": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkConnectedAccountsResponseAccountsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Active connected Clerk applications for the authenticated Vee3 account.", "title": "Accounts" } }, "title": "GetClerkConnectedAccountsResponse", "type": "object" } }, { "description": "Return the Publishable Key and Secret Key for a connected development Clerk instance so the agent can configure a local app env (NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY).\n\n**Sensitive** — the returned Secret Key is a high-privilege credential; do not log or expose it.\n\nDevelopment only. Production connections are refused.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nIf the connection was created before Publishable Keys were stored, ask the user to reconnect the Clerk application at https://vee3.io/dashboard/connections.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_development_api_keysArguments", "type": "object" }, "name": "clerk.get_development_api_keys", "outputSchema": { "additionalProperties": true, "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) for the connected development app.", "title": "Clerk Instance Id" }, "environment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Always \"development\" when this capability succeeds.", "title": "Environment Type" }, "publishable_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk Publishable Key (pk_test_...). Safe for frontend env vars; do not treat as a secret equivalent to the Secret Key.", "title": "Publishable Key" }, "secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk Secret Key (sk_test_...). Treat as high-privilege — do not log.", "title": "Secret Key" } }, "title": "GetClerkDevelopmentApiKeysResponse", "type": "object" } }, { "description": "Retrieve a Clerk email address by its id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the email address summary.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "email_address_id": { "description": "Clerk email address id (idn_...) to retrieve or modify.", "title": "Email Address Id", "type": "string" } }, "required": [ "email_address_id" ], "title": "get_clerk_email_addressArguments", "type": "object" }, "name": "clerk.get_email_address", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address value.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk email address id (idn_...).", "title": "Id" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's primary email address.", "title": "Primary" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this email address.", "title": "User Id" }, "verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verification status (e.g. verified, unverified, failed).", "title": "Verification Status" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the email address is verified.", "title": "Verified" } }, "title": "GetClerkEmailAddressResponse", "type": "object" } }, { "description": "Retrieve a single enterprise SSO connection from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the enterprise_connection summary including SAML or OIDC configuration when present.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "connection_id": { "description": "Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.", "title": "Connection Id", "type": "string" } }, "required": [ "connection_id" ], "title": "get_clerk_enterprise_connectionArguments", "type": "object" }, "name": "clerk.get_enterprise_connection", "outputSchema": { "$defs": { "GetClerkEnterpriseConnectionResponseEnterpriseConnection": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is supported.", "title": "Allow Organization Account Linking" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was created.", "title": "Created At" }, "custom_attributes": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether users may add additional identifications with this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email domains that may use this connection.", "title": "Domains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection id.", "title": "Id" }, "logo_public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public logo URL for the connection when available.", "title": "Logo Public Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the connection.", "title": "Name" }, "oauth_config": { "anyOf": [ { "$ref": "#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig" }, { "type": "null" } ], "default": null, "description": "OIDC configuration when the connection uses OAuth." }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Linked Clerk organization id (org_...) when the connection is org-scoped.", "title": "Organization Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider" }, "saml_connection": { "anyOf": [ { "$ref": "#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection" }, { "type": "null" } ], "default": null, "description": "SAML configuration when the connection uses SAML." }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether user attributes sync on each sign-in.", "title": "Sync User Attributes" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was last updated.", "title": "Updated At" } }, "title": "GetClerkEnterpriseConnectionResponseEnterpriseConnection", "type": "object" }, "GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem": { "additionalProperties": true, "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metadata key used to store the attribute on the user.", "title": "Key" }, "multi_valued": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the attribute supports multiple values.", "title": "Multi Valued" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the custom attribute.", "title": "Name" }, "scim_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "GJSON path to extract the value from SCIM resources.", "title": "Scim Path" }, "sso_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Path to extract the value from SSO claims.", "title": "Sso Path" } }, "title": "GetClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem", "type": "object" }, "GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id.", "title": "Client Id" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OIDC discovery URL.", "title": "Discovery Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth config id when the connection uses OIDC.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom OIDC provider display name.", "title": "Name" }, "provider_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider key (for example oidc_custom).", "title": "Provider Key" }, "requires_pkce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for this OAuth client.", "title": "Requires Pkce" } }, "title": "GetClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig", "type": "object" }, "GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection": { "additionalProperties": true, "properties": { "acs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Assertion Consumer Service URL.", "title": "Acs Url" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SAML connection is active.", "title": "Active" }, "allow_idp_initiated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether IdP-initiated SSO is allowed.", "title": "Allow Idp Initiated" }, "allow_subdomains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subdomains may use this connection.", "title": "Allow Subdomains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection id when the connection uses SAML.", "title": "Id" }, "idp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider entity id.", "title": "Idp Entity Id" }, "idp_sso_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider Single Sign-On URL.", "title": "Idp Sso Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection display name.", "title": "Name" }, "sp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Service Provider entity id (Clerk).", "title": "Sp Entity Id" } }, "title": "GetClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection", "type": "object" } }, "additionalProperties": true, "properties": { "enterprise_connection": { "anyOf": [ { "$ref": "#/$defs/GetClerkEnterpriseConnectionResponseEnterpriseConnection" }, { "type": "null" } ], "default": null, "description": "Enterprise SSO connection details." } }, "title": "GetClerkEnterpriseConnectionResponse", "type": "object" } }, { "description": "Retrieve the connected Clerk application instance id and environment type.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the Clerk instance id (ins_...) and environment_type (development or production). App display names are not available from the Backend API.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_instanceArguments", "type": "object" }, "name": "clerk.get_instance", "outputSchema": { "$defs": { "GetClerkInstanceResponseInstance": { "additionalProperties": true, "properties": { "environment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk environment: development or production.", "title": "Environment Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...).", "title": "Id" } }, "title": "GetClerkInstanceResponseInstance", "type": "object" } }, "additionalProperties": true, "properties": { "instance": { "anyOf": [ { "$ref": "#/$defs/GetClerkInstanceResponseInstance" }, { "type": "null" } ], "default": null, "description": "Connected Clerk instance metadata." } }, "title": "GetClerkInstanceResponse", "type": "object" } }, { "description": "Retrieve SMS communication settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns communication settings.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_instance_communication_settingsArguments", "type": "object" }, "name": "clerk.get_instance_communication_settings", "outputSchema": { "$defs": { "GetClerkInstanceCommunicationSettingsResponseCommunicationSettings": { "additionalProperties": true, "properties": { "blocked_country_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "ISO country codes blocked from receiving SMS messages.", "title": "Blocked Country Codes" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for communication settings.", "title": "Object" } }, "title": "GetClerkInstanceCommunicationSettingsResponseCommunicationSettings", "type": "object" } }, "additionalProperties": true, "properties": { "communication_settings": { "anyOf": [ { "$ref": "#/$defs/GetClerkInstanceCommunicationSettingsResponseCommunicationSettings" }, { "type": "null" } ], "default": null, "description": "Clerk instance communication settings from the Backend API." } }, "title": "GetClerkInstanceCommunicationSettingsResponse", "type": "object" } }, { "description": "Retrieve OAuth settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns OAuth settings.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_instance_oauth_settingsArguments", "type": "object" }, "name": "clerk.get_instance_oauth_settings", "outputSchema": { "$defs": { "GetClerkInstanceOauthSettingsResponseOauthSettings": { "additionalProperties": true, "properties": { "dynamic_oauth_client_registration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether dynamic OAuth client registration is enabled.", "title": "Dynamic Oauth Client Registration" }, "oauth_jwt_access_tokens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether OAuth access tokens are issued as JWTs.", "title": "Oauth Jwt Access Tokens" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for OAuth settings.", "title": "Object" } }, "title": "GetClerkInstanceOauthSettingsResponseOauthSettings", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_settings": { "anyOf": [ { "$ref": "#/$defs/GetClerkInstanceOauthSettingsResponseOauthSettings" }, { "type": "null" } ], "default": null, "description": "Clerk instance OAuth settings from the Backend API." } }, "title": "GetClerkInstanceOauthSettingsResponse", "type": "object" } }, { "description": "Retrieve organization feature settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns organization feature settings.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_instance_organization_settingsArguments", "type": "object" }, "name": "clerk.get_instance_organization_settings", "outputSchema": { "$defs": { "GetClerkInstanceOrganizationSettingsResponseOrganizationSettings": { "additionalProperties": true, "properties": { "admin_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization admins can delete their organization.", "title": "Admin Delete Enabled" }, "creator_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role assigned to the organization creator.", "title": "Creator Role" }, "domains_default_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role for members who join via a verified organization domain.", "title": "Domains Default Role" }, "domains_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization domains are enabled.", "title": "Domains Enabled" }, "domains_enrollment_modes": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed organization domain enrollment modes.", "title": "Domains Enrollment Modes" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organizations are enabled for the instance.", "title": "Enabled" }, "initial_role_set_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Initial role set key applied to new organizations.", "title": "Initial Role Set Key" }, "max_allowed_domains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum verified domains allowed per organization.", "title": "Max Allowed Domains" }, "max_allowed_memberships": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum organization memberships allowed per user.", "title": "Max Allowed Memberships" }, "max_allowed_roles": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum custom roles allowed per organization.", "title": "Max Allowed Roles" }, "max_role_sets_allowed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum role sets allowed per organization.", "title": "Max Role Sets Allowed" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for organization settings.", "title": "Object" }, "slug_disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization slugs are disabled.", "title": "Slug Disabled" } }, "title": "GetClerkInstanceOrganizationSettingsResponseOrganizationSettings", "type": "object" }, "GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "An enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Item" } }, "title": "GetClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_settings": { "anyOf": [ { "$ref": "#/$defs/GetClerkInstanceOrganizationSettingsResponseOrganizationSettings" }, { "type": "null" } ], "default": null, "description": "Clerk instance organization settings from the Backend API." } }, "title": "GetClerkInstanceOrganizationSettingsResponse", "type": "object" } }, { "description": "Retrieve core settings for a connected Clerk application instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns core instance settings.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_instance_settingsArguments", "type": "object" }, "name": "clerk.get_instance_settings", "outputSchema": { "$defs": { "GetClerkInstanceSettingsResponseInstanceSettings": { "additionalProperties": true, "properties": { "allowed_origins": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed browser origins for the instance.", "title": "Allowed Origins" }, "clerk_js_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinned Clerk.js version for the instance, when set.", "title": "Clerk Js Version" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin URL for local testing.", "title": "Development Origin" }, "environment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Instance environment type (development or production).", "title": "Environment Type" }, "hibp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Have I Been Pwned password checking is enabled.", "title": "Hibp" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...).", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the instance.", "title": "Object" }, "preferred_sign_in_strategy_when_password_required": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preferred sign-in strategy when a password is required: \"password\" or \"otp\".", "title": "Preferred Sign In Strategy When Password Required" }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Support email address shown to end users.", "title": "Support Email" }, "test_mode": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the instance is in test mode.", "title": "Test Mode" }, "url_based_session_syncing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether URL-based session syncing is enabled.", "title": "Url Based Session Syncing" } }, "title": "GetClerkInstanceSettingsResponseInstanceSettings", "type": "object" } }, "additionalProperties": true, "properties": { "instance_settings": { "anyOf": [ { "$ref": "#/$defs/GetClerkInstanceSettingsResponseInstanceSettings" }, { "type": "null" } ], "default": null, "description": "Core Clerk instance settings from the Backend API." } }, "title": "GetClerkInstanceSettingsResponse", "type": "object" } }, { "description": "Retrieve the JSON Web Key Set (JWKS) for verifying Clerk session tokens.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns public signing keys for verifying Clerk JWTs.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "get_clerk_jwksArguments", "type": "object" }, "name": "clerk.get_jwks", "outputSchema": { "$defs": { "GetClerkJwksResponseJwks": { "additionalProperties": true, "properties": { "keys": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkJwksResponseJwksKeysItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Public signing keys for verifying Clerk JWTs.", "title": "Keys" } }, "title": "GetClerkJwksResponseJwks", "type": "object" }, "GetClerkJwksResponseJwksKeysItem": { "additionalProperties": true, "properties": { "alg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signing algorithm for the key.", "title": "Alg" }, "kid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Key id used to match JWT headers to a public key.", "title": "Kid" }, "kty": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Key type, for example \"RSA\" or \"EC\".", "title": "Kty" }, "use": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Key usage, typically \"sig\" for signing.", "title": "Use" } }, "title": "GetClerkJwksResponseJwksKeysItem", "type": "object" } }, "additionalProperties": true, "properties": { "jwks": { "anyOf": [ { "$ref": "#/$defs/GetClerkJwksResponseJwks" }, { "type": "null" } ], "default": null, "description": "Clerk JWKS payload from the Backend API." } }, "title": "GetClerkJwksResponse", "type": "object" } }, { "description": "Retrieve a single JWT template from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns id, name, claims, lifetime, allowed_clock_skew, created_at, updated_at, signing_algorithm, and custom_signing_key.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "template_id": { "description": "Clerk JWT template id (jtmp_...) to retrieve, update, or delete.", "title": "Template Id", "type": "string" } }, "required": [ "template_id" ], "title": "get_clerk_jwt_templateArguments", "type": "object" }, "name": "clerk.get_jwt_template", "outputSchema": { "$defs": { "GetClerkJwtTemplateResponseJwtTemplate": { "additionalProperties": true, "properties": { "allowed_clock_skew": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Allowed clock skew in seconds for the nbf claim.", "title": "Allowed Clock Skew" }, "claims": { "anyOf": [ { "$ref": "#/$defs/GetClerkJwtTemplateResponseJwtTemplateClaims" }, { "type": "null" } ], "default": null, "description": "JWT claims template as a JSON object (may include Clerk shortcodes)." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was created.", "title": "Created At" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this template uses a custom signing key and algorithm.", "title": "Custom Signing Key" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk JWT template id (jtmp_...).", "title": "Id" }, "lifetime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (exp claim offset from issuance time).", "title": "Lifetime" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique template name used when minting tokens from this template.", "title": "Name" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing algorithm when custom_signing_key is enabled.", "title": "Signing Algorithm" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was last updated.", "title": "Updated At" } }, "title": "GetClerkJwtTemplateResponseJwtTemplate", "type": "object" }, "GetClerkJwtTemplateResponseJwtTemplateClaims": { "additionalProperties": true, "properties": { "aud": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Audience claim when set in the template.", "title": "Aud" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role claim when set in the template.", "title": "Role" } }, "title": "GetClerkJwtTemplateResponseJwtTemplateClaims", "type": "object" } }, "additionalProperties": true, "properties": { "jwt_template": { "anyOf": [ { "$ref": "#/$defs/GetClerkJwtTemplateResponseJwtTemplate" }, { "type": "null" } ], "default": null, "description": "Clerk JWT template details." } }, "title": "GetClerkJwtTemplateResponse", "type": "object" } }, { "description": "Retrieve a machine by id from a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns machine metadata including scoped_machines.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" } }, "required": [ "machine_id" ], "title": "get_clerk_machineArguments", "type": "object" }, "name": "clerk.get_machine", "outputSchema": { "$defs": { "GetClerkMachineResponseMachine": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was created.", "title": "Created At" }, "default_token_ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Default token lifetime in seconds for tokens created by this machine.", "title": "Default Token Ttl" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns the machine.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine display name.", "title": "Name" }, "secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key returned on create. Treat as high-privilege — do not log.", "title": "Secret Key" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was last updated.", "title": "Updated At" } }, "title": "GetClerkMachineResponseMachine", "type": "object" } }, "additionalProperties": true, "properties": { "machine": { "anyOf": [ { "$ref": "#/$defs/GetClerkMachineResponseMachine" }, { "type": "null" } ], "default": null, "description": "Machine object from the Backend API." } }, "title": "GetClerkMachineResponse", "type": "object" } }, { "description": "Retrieve the secret key for a machine in a connected Clerk instance.\n\n**Sensitive** — the returned secret grants machine authentication; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the machine secret key.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" } }, "required": [ "machine_id" ], "title": "get_clerk_machine_secret_keyArguments", "type": "object" }, "name": "clerk.get_machine_secret_key", "outputSchema": { "$defs": { "GetClerkMachineSecretKeyResponseMachineSecretKey": { "additionalProperties": true, "properties": { "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type (machine_secret_key).", "title": "Object" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key. Treat as high-privilege — do not log.", "title": "Secret" } }, "title": "GetClerkMachineSecretKeyResponseMachineSecretKey", "type": "object" } }, "additionalProperties": true, "properties": { "machine_secret_key": { "anyOf": [ { "$ref": "#/$defs/GetClerkMachineSecretKeyResponseMachineSecretKey" }, { "type": "null" } ], "default": null, "description": "Machine secret key payload from the Backend API." } }, "title": "GetClerkMachineSecretKeyResponse", "type": "object" } }, { "description": "Retrieve a single OAuth application by id from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the OAuth application summary.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "oauth_application_id": { "description": "Clerk OAuth application id (oa_...) to retrieve, update, or delete.", "title": "Oauth Application Id", "type": "string" } }, "required": [ "oauth_application_id" ], "title": "get_clerk_oauth_applicationArguments", "type": "object" }, "name": "clerk.get_oauth_application", "outputSchema": { "$defs": { "GetClerkOauthApplicationResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "GetClerkOauthApplicationResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/GetClerkOauthApplicationResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "Clerk OAuth application summary." } }, "title": "GetClerkOauthApplicationResponse", "type": "object" } }, { "description": "Retrieve a single organization from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns organization id, name, slug, members_count, and created_at.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id" ], "title": "get_clerk_organizationArguments", "type": "object" }, "name": "clerk.get_organization", "outputSchema": { "$defs": { "GetClerkOrganizationResponseOrganization": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the organization was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Id" }, "members_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current number of members in the organization.", "title": "Members Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization display name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL-friendly organization slug, if set.", "title": "Slug" } }, "title": "GetClerkOrganizationResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "organization": { "anyOf": [ { "$ref": "#/$defs/GetClerkOrganizationResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Clerk organization details." } }, "title": "GetClerkOrganizationResponse", "type": "object" } }, { "description": "Retrieve a single Clerk organization invitation by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the invitation summary including status.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "invitation_id": { "description": "Clerk organization invitation id (orginv_...).", "title": "Invitation Id", "type": "string" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id", "invitation_id" ], "title": "get_clerk_organization_invitationArguments", "type": "object" }, "name": "clerk.get_organization_invitation", "outputSchema": { "$defs": { "GetClerkOrganizationInvitationResponseInvitation": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization invitation id (inv_...).", "title": "Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this invitation.", "title": "Organization Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role assigned to the invitee (e.g. org:admin, org:member).", "title": "Role" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: pending, accepted, or revoked.", "title": "Status" } }, "title": "GetClerkOrganizationInvitationResponseInvitation", "type": "object" } }, "additionalProperties": true, "properties": { "invitation": { "anyOf": [ { "$ref": "#/$defs/GetClerkOrganizationInvitationResponseInvitation" }, { "type": "null" } ], "default": null, "description": "Requested organization invitation summary." } }, "title": "GetClerkOrganizationInvitationResponse", "type": "object" } }, { "description": "Retrieve an organization role by id from a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the role summary including assigned permissions.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "role_id": { "description": "Clerk organization role id to retrieve, update, or delete.", "title": "Role Id", "type": "string" } }, "required": [ "role_id" ], "title": "get_clerk_organization_roleArguments", "type": "object" }, "name": "clerk.get_organization_role", "outputSchema": { "$defs": { "GetClerkOrganizationRoleResponseOrganizationRole": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization role id.", "title": "Id" }, "is_creator_eligible": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this role may be assigned as organization creator.", "title": "Is Creator Eligible" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role key used in memberships.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role display name.", "title": "Name" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/$defs/GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permissions assigned to this role.", "title": "Permissions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was last updated.", "title": "Updated At" } }, "title": "GetClerkOrganizationRoleResponseOrganizationRole", "type": "object" }, "GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "GetClerkOrganizationRoleResponseOrganizationRolePermissionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_role": { "anyOf": [ { "$ref": "#/$defs/GetClerkOrganizationRoleResponseOrganizationRole" }, { "type": "null" } ], "default": null, "description": "Organization role summary." } }, "title": "GetClerkOrganizationRoleResponse", "type": "object" } }, { "description": "Retrieve a Clerk phone number by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the phone number summary.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "phone_number_id": { "description": "Clerk phone number id (idn_... or phn_...) to retrieve or modify.", "title": "Phone Number Id", "type": "string" } }, "required": [ "phone_number_id" ], "title": "get_clerk_phone_numberArguments", "type": "object" }, "name": "clerk.get_phone_number", "outputSchema": { "additionalProperties": true, "properties": { "default_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's default second factor.", "title": "Default Second Factor" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk phone number id.", "title": "Id" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number in E.164 format.", "title": "Phone Number" }, "reserved_for_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is reserved for multi-factor authentication.", "title": "Reserved For Second Factor" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is verified.", "title": "Verified" } }, "title": "GetClerkPhoneNumberResponse", "type": "object" } }, { "description": "Retrieve an allowed redirect URL by id from a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the redirect URL.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "redirect_url_id": { "description": "Clerk redirect URL id to retrieve or delete.", "title": "Redirect Url Id", "type": "string" } }, "required": [ "redirect_url_id" ], "title": "get_clerk_redirect_urlArguments", "type": "object" }, "name": "clerk.get_redirect_url", "outputSchema": { "$defs": { "GetClerkRedirectUrlResponseRedirectUrl": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk redirect URL id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the redirect URL.", "title": "Object" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URL value.", "title": "Url" } }, "title": "GetClerkRedirectUrlResponseRedirectUrl", "type": "object" } }, "additionalProperties": true, "properties": { "redirect_url": { "anyOf": [ { "$ref": "#/$defs/GetClerkRedirectUrlResponseRedirectUrl" }, { "type": "null" } ], "default": null, "description": "Clerk redirect URL from the Backend API." } }, "title": "GetClerkRedirectUrlResponse", "type": "object" } }, { "description": "Retrieve a single session from a connected Clerk application by its session id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns session id, user_id, status, last_active_at, expire_at, client_id, created_at, and updated_at.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "session_id": { "description": "Clerk session id (sess_...) to retrieve or modify.", "title": "Session Id", "type": "string" } }, "required": [ "session_id" ], "title": "get_clerk_sessionArguments", "type": "object" }, "name": "clerk.get_session", "outputSchema": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk client id associated with this session.", "title": "Client Id" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was created.", "title": "Created At" }, "expire_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when this session expires.", "title": "Expire At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk session id (sess_...).", "title": "Id" }, "last_active_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds of the last activity on this session.", "title": "Last Active At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current status of the session.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this session.", "title": "User Id" } }, "title": "GetClerkSessionResponse", "type": "object" } }, { "description": "Retrieve an in-progress sign-up from a connected Clerk application by sign-up id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns status, contact fields, missing and unverified fields, and completion timestamps.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "sign_up_id": { "description": "Clerk sign-up id (su_...) to retrieve.", "title": "Sign Up Id", "type": "string" } }, "required": [ "sign_up_id" ], "title": "get_clerk_sign_upArguments", "type": "object" }, "name": "clerk.get_sign_up", "outputSchema": { "additionalProperties": true, "properties": { "abandon_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the sign-up will be abandoned.", "title": "Abandon At" }, "created_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk session id created when the sign-up completed.", "title": "Created Session Id" }, "created_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id created when the sign-up completed.", "title": "Created User Id" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address associated with the in-progress sign-up.", "title": "Email Address" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "First name collected during sign-up.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk sign-up id (su_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Last name collected during sign-up.", "title": "Last Name" }, "missing_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Fields still required before the sign-up can complete.", "title": "Missing Fields" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number associated with the in-progress sign-up.", "title": "Phone Number" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sign-up status: \"missing_requirements\", \"complete\", or \"abandoned\".", "title": "Status" }, "unverified_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Fields that still need verification.", "title": "Unverified Fields" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Username associated with the in-progress sign-up.", "title": "Username" } }, "title": "GetClerkSignUpResponse", "type": "object" } }, { "description": "Retrieve one Clerk user by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns id, name, primary email, and created_at.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_id": { "description": "Clerk user id (user_...) to retrieve.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "get_clerk_userArguments", "type": "object" }, "name": "clerk.get_user", "outputSchema": { "$defs": { "GetClerkUserResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "GetClerkUserResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/GetClerkUserResponseUser" }, { "type": "null" } ], "default": null, "description": "Requested Clerk user summary." } }, "title": "GetClerkUserResponse", "type": "object" } }, { "description": "Send an invite to the email address on a waitlist entry.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "ignore_existing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, create an invitation even if one already exists for this email.", "title": "Ignore Existing" }, "waitlist_entry_id": { "description": "Clerk waitlist entry id (wle_...) to operate on.", "title": "Waitlist Entry Id", "type": "string" } }, "required": [ "waitlist_entry_id" ], "title": "invite_clerk_waitlist_entryArguments", "type": "object" }, "name": "clerk.invite_waitlist_entry", "outputSchema": { "$defs": { "InviteClerkWaitlistEntryResponseWaitlistEntry": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address on the waitlist.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist entry id (wle_...).", "title": "Id" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the entry is locked during batch processing.", "title": "Is Locked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist status: \"pending\", \"invited\", \"rejected\", or \"completed\".", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "InviteClerkWaitlistEntryResponseWaitlistEntry", "type": "object" } }, "additionalProperties": true, "properties": { "waitlist_entry": { "anyOf": [ { "$ref": "#/$defs/InviteClerkWaitlistEntryResponseWaitlistEntry" }, { "type": "null" } ], "default": null, "description": "Updated Clerk waitlist entry after inviting." } }, "title": "InviteClerkWaitlistEntryResponse", "type": "object" } }, { "description": "List allowlisted identifiers in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns allowlist identifiers and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of identifiers to return (1–500).", "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of identifiers to skip before returning results.", "title": "Offset", "type": "integer" } }, "title": "list_clerk_allowlist_identifiersArguments", "type": "object" }, "name": "clerk.list_allowlist_identifiers", "outputSchema": { "$defs": { "ListClerkAllowlistIdentifiersResponseIdentifiersItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowlist identifier id (alid_...).", "title": "Id" }, "identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowlisted email, phone, domain pattern, or Web3 wallet address.", "title": "Identifier" }, "identifier_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of identifier: \"email_address\", \"phone_number\", or \"web3_wallet\".", "title": "Identifier Type" }, "invitation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk invitation id (inv_...) when the entry was created from an invitation.", "title": "Invitation Id" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "ListClerkAllowlistIdentifiersResponseIdentifiersItem", "type": "object" } }, "additionalProperties": true, "properties": { "identifiers": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkAllowlistIdentifiersResponseIdentifiersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowlist identifiers returned for the requested page.", "title": "Identifiers" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of allowlist identifiers for the instance.", "title": "Total Count" } }, "title": "ListClerkAllowlistIdentifiersResponse", "type": "object" } }, { "description": "List API keys in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns api_keys and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "include_invalid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, include revoked or expired API keys.", "title": "Include Invalid" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by API key type (typically \"api_key\").", "title": "Key Type" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of API keys to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of API keys to skip before returning results.", "title": "Offset" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search query to filter API keys by name.", "title": "Query" }, "subject": { "description": "Subject to list API keys for (user_... or org_...).", "title": "Subject", "type": "string" } }, "required": [ "subject" ], "title": "list_clerk_api_keysArguments", "type": "object" }, "name": "clerk.list_api_keys", "outputSchema": { "$defs": { "ListClerkApiKeysResponseApiKeysItem": { "additionalProperties": true, "properties": { "claims": { "anyOf": [ { "$ref": "#/$defs/ListClerkApiKeysResponseApiKeysItemClaims" }, { "type": "null" } ], "default": null, "description": "Custom claims embedded in tokens minted from this API key." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was created.", "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id that created the API key, when set.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key expires, if set.", "title": "Expiration" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk API key id (ak_...).", "title": "Id" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable API key name.", "title": "Name" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason recorded when the API key was revoked.", "title": "Revocation Reason" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the API key has been revoked.", "title": "Revoked" }, "scopes": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkApiKeysResponseApiKeysItemScopesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes granted to this API key.", "title": "Scopes" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was last updated.", "title": "Updated At" } }, "title": "ListClerkApiKeysResponseApiKeysItem", "type": "object" }, "ListClerkApiKeysResponseApiKeysItemClaims": { "additionalProperties": true, "properties": { "claim_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key in the custom claims object.", "title": "Claim Key" } }, "title": "ListClerkApiKeysResponseApiKeysItemClaims", "type": "object" }, "ListClerkApiKeysResponseApiKeysItemScopesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A single scope string.", "title": "Item" } }, "title": "ListClerkApiKeysResponseApiKeysItemScopesItem", "type": "object" } }, "additionalProperties": true, "properties": { "api_keys": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkApiKeysResponseApiKeysItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "API keys matching the request.", "title": "Api Keys" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of API keys matching the filters.", "title": "Total Count" } }, "title": "ListClerkApiKeysResponse", "type": "object" } }, { "description": "List blocklisted identifiers in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns blocklist identifiers and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of identifiers to return (1–500).", "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of identifiers to skip before returning results.", "title": "Offset", "type": "integer" } }, "title": "list_clerk_blocklist_identifiersArguments", "type": "object" }, "name": "clerk.list_blocklist_identifiers", "outputSchema": { "$defs": { "ListClerkBlocklistIdentifiersResponseIdentifiersItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Blocklist identifier id (blid_...).", "title": "Id" }, "identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Blocklisted email, domain, phone, or Web3 wallet address.", "title": "Identifier" }, "identifier_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of identifier: \"email_address\", \"phone_number\", or \"web3_wallet\".", "title": "Identifier Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "ListClerkBlocklistIdentifiersResponseIdentifiersItem", "type": "object" } }, "additionalProperties": true, "properties": { "identifiers": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkBlocklistIdentifiersResponseIdentifiersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Blocklist identifiers returned for the requested page.", "title": "Identifiers" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of blocklist identifiers for the instance.", "title": "Total Count" } }, "title": "ListClerkBlocklistIdentifiersResponse", "type": "object" } }, { "description": "List custom domains configured for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns custom domain summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "list_clerk_domainsArguments", "type": "object" }, "name": "clerk.list_domains", "outputSchema": { "$defs": { "ListClerkDomainsResponseDomainsItem": { "additionalProperties": true, "properties": { "accounts_portal_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Accounts portal URL for the domain.", "title": "Accounts Portal Url" }, "cname_targets": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkDomainsResponseDomainsItemCnameTargetsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "CNAME records required to verify the domain.", "title": "Cname Targets" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin associated with the domain.", "title": "Development Origin" }, "frontend_api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Frontend API URL for the domain.", "title": "Frontend Api Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk domain id.", "title": "Id" }, "is_satellite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a satellite domain.", "title": "Is Satellite" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain hostname.", "title": "Name" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the domain.", "title": "Object" }, "proxy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Proxy URL when using a satellite domain behind a reverse proxy.", "title": "Proxy Url" } }, "title": "ListClerkDomainsResponseDomainsItem", "type": "object" }, "ListClerkDomainsResponseDomainsItemCnameTargetsItem": { "additionalProperties": true, "properties": { "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS host label for the CNAME record.", "title": "Host" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this CNAME record is required for domain verification.", "title": "Required" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS target value for the CNAME record.", "title": "Value" } }, "title": "ListClerkDomainsResponseDomainsItemCnameTargetsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domains": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkDomainsResponseDomainsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom domains configured for the connected Clerk instance.", "title": "Domains" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of domains.", "title": "Total Count" } }, "title": "ListClerkDomainsResponse", "type": "object" } }, { "description": "List SAML or OIDC debug test runs for an enterprise SSO connection.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns test_runs summaries plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "connection_id": { "description": "Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.", "title": "Connection Id", "type": "string" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of results to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of results to skip before returning.", "title": "Offset" }, "status": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Filter by test run status: \"pending\", \"success\", or \"failed\".", "title": "Status" } }, "required": [ "connection_id" ], "title": "list_clerk_enterprise_connection_test_runsArguments", "type": "object" }, "name": "clerk.list_enterprise_connection_test_runs", "outputSchema": { "$defs": { "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem": { "additionalProperties": true, "properties": { "connection_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Connection type tested: \"saml\" or \"oauth\".", "title": "Connection Type" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the test run was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection test run id.", "title": "Id" }, "logs": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Log entries captured during the test run.", "title": "Logs" }, "parsed_user_info": { "anyOf": [ { "$ref": "#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo" }, { "type": "null" } ], "default": null, "description": "User attributes parsed from the IdP response." }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Test run status: \"pending\", \"success\", or \"failed\".", "title": "Status" } }, "title": "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem", "type": "object" }, "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem": { "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional machine-readable log code.", "title": "Code" }, "level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Log level (for example info, warn, or error).", "title": "Level" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Log message text.", "title": "Message" }, "short_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional short log summary.", "title": "Short Message" } }, "title": "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemLogsItem", "type": "object" }, "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address parsed from the IdP response.", "title": "Email Address" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "First name parsed from the IdP response.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Last name parsed from the IdP response.", "title": "Last Name" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id parsed from the IdP response.", "title": "User Id" } }, "title": "ListClerkEnterpriseConnectionTestRunsResponseTestRunsItemParsedUserInfo", "type": "object" } }, "additionalProperties": true, "properties": { "test_runs": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkEnterpriseConnectionTestRunsResponseTestRunsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Enterprise connection SSO test runs.", "title": "Test Runs" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of test runs matching the query.", "title": "Total Count" } }, "title": "ListClerkEnterpriseConnectionTestRunsResponse", "type": "object" } }, { "description": "List enterprise SSO (SAML/OIDC) connections in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns enterprise_connections summaries plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Filter by active status. Omit to return all connections.", "title": "Active" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of results to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of results to skip before returning.", "title": "Offset" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter connections linked to this Clerk organization id (org_...).", "title": "Organization Id" } }, "title": "list_clerk_enterprise_connectionsArguments", "type": "object" }, "name": "clerk.list_enterprise_connections", "outputSchema": { "$defs": { "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is supported.", "title": "Allow Organization Account Linking" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was created.", "title": "Created At" }, "custom_attributes": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether users may add additional identifications with this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email domains that may use this connection.", "title": "Domains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection id.", "title": "Id" }, "logo_public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public logo URL for the connection when available.", "title": "Logo Public Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the connection.", "title": "Name" }, "oauth_config": { "anyOf": [ { "$ref": "#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig" }, { "type": "null" } ], "default": null, "description": "OIDC configuration when the connection uses OAuth." }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Linked Clerk organization id (org_...) when the connection is org-scoped.", "title": "Organization Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider" }, "saml_connection": { "anyOf": [ { "$ref": "#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection" }, { "type": "null" } ], "default": null, "description": "SAML configuration when the connection uses SAML." }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether user attributes sync on each sign-in.", "title": "Sync User Attributes" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was last updated.", "title": "Updated At" } }, "title": "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem", "type": "object" }, "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem": { "additionalProperties": true, "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metadata key used to store the attribute on the user.", "title": "Key" }, "multi_valued": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the attribute supports multiple values.", "title": "Multi Valued" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the custom attribute.", "title": "Name" }, "scim_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "GJSON path to extract the value from SCIM resources.", "title": "Scim Path" }, "sso_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Path to extract the value from SSO claims.", "title": "Sso Path" } }, "title": "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemCustomAttributesItem", "type": "object" }, "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id.", "title": "Client Id" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OIDC discovery URL.", "title": "Discovery Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth config id when the connection uses OIDC.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom OIDC provider display name.", "title": "Name" }, "provider_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider key (for example oidc_custom).", "title": "Provider Key" }, "requires_pkce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for this OAuth client.", "title": "Requires Pkce" } }, "title": "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemOauthConfig", "type": "object" }, "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection": { "additionalProperties": true, "properties": { "acs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Assertion Consumer Service URL.", "title": "Acs Url" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SAML connection is active.", "title": "Active" }, "allow_idp_initiated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether IdP-initiated SSO is allowed.", "title": "Allow Idp Initiated" }, "allow_subdomains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subdomains may use this connection.", "title": "Allow Subdomains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection id when the connection uses SAML.", "title": "Id" }, "idp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider entity id.", "title": "Idp Entity Id" }, "idp_sso_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider Single Sign-On URL.", "title": "Idp Sso Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection display name.", "title": "Name" }, "sp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Service Provider entity id (Clerk).", "title": "Sp Entity Id" } }, "title": "ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItemSamlConnection", "type": "object" } }, "additionalProperties": true, "properties": { "enterprise_connections": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkEnterpriseConnectionsResponseEnterpriseConnectionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Enterprise SSO connections in the connected Clerk application.", "title": "Enterprise Connections" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of enterprise connections matching the query.", "title": "Total Count" } }, "title": "ListClerkEnterpriseConnectionsResponse", "type": "object" } }, { "description": "List application invitations in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns invitation id, email_address, status, created_at, and revoked for each invitation, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of invitations to return (1–500).", "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of invitations to skip before returning results.", "title": "Offset", "type": "integer" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional status filter: \"pending\", \"accepted\", \"revoked\", or \"expired\".", "title": "Status" } }, "title": "list_clerk_invitationsArguments", "type": "object" }, "name": "clerk.list_invitations", "outputSchema": { "$defs": { "ListClerkInvitationsResponseInvitationsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the invitation was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk invitation id (inv_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the invitation has been revoked.", "title": "Revoked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: \"pending\", \"accepted\", \"revoked\", or \"expired\".", "title": "Status" } }, "title": "ListClerkInvitationsResponseInvitationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "invitations": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkInvitationsResponseInvitationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Invitations returned for the requested page.", "title": "Invitations" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of invitations returned on this page.", "title": "Total Count" } }, "title": "ListClerkInvitationsResponse", "type": "object" } }, { "description": "List JWT templates in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns each template's id, name, claims, lifetime, allowed_clock_skew, created_at, updated_at, signing_algorithm, and custom_signing_key, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "list_clerk_jwt_templatesArguments", "type": "object" }, "name": "clerk.list_jwt_templates", "outputSchema": { "$defs": { "ListClerkJwtTemplatesResponseJwtTemplatesItem": { "additionalProperties": true, "properties": { "allowed_clock_skew": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Allowed clock skew in seconds for the nbf claim.", "title": "Allowed Clock Skew" }, "claims": { "anyOf": [ { "$ref": "#/$defs/ListClerkJwtTemplatesResponseJwtTemplatesItemClaims" }, { "type": "null" } ], "default": null, "description": "JWT claims template as a JSON object (may include Clerk shortcodes)." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was created.", "title": "Created At" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this template uses a custom signing key and algorithm.", "title": "Custom Signing Key" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk JWT template id (jtmp_...).", "title": "Id" }, "lifetime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (exp claim offset from issuance time).", "title": "Lifetime" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique template name used when minting tokens from this template.", "title": "Name" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing algorithm when custom_signing_key is enabled.", "title": "Signing Algorithm" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was last updated.", "title": "Updated At" } }, "title": "ListClerkJwtTemplatesResponseJwtTemplatesItem", "type": "object" }, "ListClerkJwtTemplatesResponseJwtTemplatesItemClaims": { "additionalProperties": true, "properties": { "aud": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Audience claim when set in the template.", "title": "Aud" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role claim when set in the template.", "title": "Role" } }, "title": "ListClerkJwtTemplatesResponseJwtTemplatesItemClaims", "type": "object" } }, "additionalProperties": true, "properties": { "jwt_templates": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkJwtTemplatesResponseJwtTemplatesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "JWT templates in the connected Clerk application.", "title": "Jwt Templates" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of JWT templates.", "title": "Total Count" } }, "title": "ListClerkJwtTemplatesResponse", "type": "object" } }, { "description": "List M2M tokens for a machine in a connected Clerk instance.\n\n**Sensitive** — returns token metadata for active machine credentials.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns M2M token summaries plus total_count. JWT-format tokens are not listed.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Include expired tokens (default false).", "title": "Expired" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of results to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of results to skip before returning.", "title": "Offset" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Include revoked tokens (default false).", "title": "Revoked" }, "subject": { "description": "Machine id (mch_...) whose tokens to list.", "title": "Subject", "type": "string" } }, "required": [ "subject" ], "title": "list_clerk_m2m_tokensArguments", "type": "object" }, "name": "clerk.list_m2m_tokens", "outputSchema": { "$defs": { "ListClerkM2mTokensResponseM2mTokensItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token expires.", "title": "Expiration" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has expired.", "title": "Expired" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token id (mt_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has been revoked.", "title": "Revoked" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...) that created or owns the token.", "title": "Subject" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token secret when returned on creation. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" } }, "title": "ListClerkM2mTokensResponseM2mTokensItem", "type": "object" } }, "additionalProperties": true, "properties": { "m2m_tokens": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkM2mTokensResponseM2mTokensItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "M2M tokens for the requested page.", "title": "M2M Tokens" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of matching M2M tokens.", "title": "Total Count" } }, "title": "ListClerkM2mTokensResponse", "type": "object" } }, { "description": "List machines in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns machine summaries plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of results to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of results to skip before returning.", "title": "Offset" }, "order_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sort by name or created_at; prefix with - for descending (default -created_at).", "title": "Order By" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by machine id (exact) or name (partial match).", "title": "Query" } }, "title": "list_clerk_machinesArguments", "type": "object" }, "name": "clerk.list_machines", "outputSchema": { "$defs": { "ListClerkMachinesResponseMachinesItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was created.", "title": "Created At" }, "default_token_ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Default token lifetime in seconds for tokens created by this machine.", "title": "Default Token Ttl" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns the machine.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine display name.", "title": "Name" }, "secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key returned on create. Treat as high-privilege — do not log.", "title": "Secret Key" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was last updated.", "title": "Updated At" } }, "title": "ListClerkMachinesResponseMachinesItem", "type": "object" } }, "additionalProperties": true, "properties": { "machines": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkMachinesResponseMachinesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Machines for the requested page.", "title": "Machines" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of machines in the instance.", "title": "Total Count" } }, "title": "ListClerkMachinesResponse", "type": "object" } }, { "description": "List OAuth applications registered in a connected Clerk application when Clerk acts as an OAuth identity provider.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns each application's id, name, client_id, redirect_uris, scopes, public flag, and related endpoint URLs, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "list_clerk_oauth_applicationsArguments", "type": "object" }, "name": "clerk.list_oauth_applications", "outputSchema": { "$defs": { "ListClerkOauthApplicationsResponseOauthApplicationsItem": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "ListClerkOauthApplicationsResponseOauthApplicationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_applications": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOauthApplicationsResponseOauthApplicationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "OAuth applications in the connected Clerk application.", "title": "Oauth Applications" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of OAuth applications.", "title": "Total Count" } }, "title": "ListClerkOauthApplicationsResponse", "type": "object" } }, { "description": "List organization domains across a Clerk instance. Optionally filter to one organization via organization_id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns domain summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "limit": { "default": 10, "description": "Maximum number of results to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of results to skip before returning.", "minimum": 0, "title": "Offset", "type": "integer" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter domains to a specific Clerk organization id (org_...).", "title": "Organization Id" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search domains by name or organization id. Values starting with org_ match organization id exactly; otherwise performs a case-insensitive partial match on the domain name.", "title": "Query" }, "verified": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by verification status: \"true\" or \"false\".", "title": "Verified" } }, "title": "list_clerk_organization_domainsArguments", "type": "object" }, "name": "clerk.list_organization_domains", "outputSchema": { "$defs": { "ListClerkOrganizationDomainsResponseDomainsItem": { "additionalProperties": true, "properties": { "affiliation_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation email address for the domain, when set.", "title": "Affiliation Email Address" }, "affiliation_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation verification status (unverified, verified, failed, or expired).", "title": "Affiliation Verification Status" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was created.", "title": "Created At" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization domain id (dmn_...).", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain name (for example example.com).", "title": "Name" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this domain.", "title": "Organization Id" }, "ownership_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS ownership verification status (unverified, verified, failed, or expired).", "title": "Ownership Verification Status" }, "total_pending_invitations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending invitations associated with this domain.", "title": "Total Pending Invitations" }, "total_pending_suggestions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending membership suggestions associated with this domain.", "title": "Total Pending Suggestions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was last updated.", "title": "Updated At" } }, "title": "ListClerkOrganizationDomainsResponseDomainsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domains": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationDomainsResponseDomainsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Organization domains returned for the requested page.", "title": "Domains" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of domains matching the filter.", "title": "Total Count" } }, "title": "ListClerkOrganizationDomainsResponse", "type": "object" } }, { "description": "List organization invitations across a Clerk instance. Optionally filter to one organization via organization_id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns invitation summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of results to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of results to skip before returning.", "minimum": 0, "title": "Offset", "type": "integer" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter invitations to a specific Clerk organization id (org_...).", "title": "Organization Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by invitation status: pending, accepted, revoked, or expired.", "title": "Status" } }, "title": "list_clerk_organization_invitationsArguments", "type": "object" }, "name": "clerk.list_organization_invitations", "outputSchema": { "$defs": { "ListClerkOrganizationInvitationsResponseInvitationsItem": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization invitation id (inv_...).", "title": "Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this invitation.", "title": "Organization Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role assigned to the invitee (e.g. org:admin, org:member).", "title": "Role" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: pending, accepted, or revoked.", "title": "Status" } }, "title": "ListClerkOrganizationInvitationsResponseInvitationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "invitations": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationInvitationsResponseInvitationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Invitations returned for the requested page.", "title": "Invitations" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of invitations matching the filter.", "title": "Total Count" } }, "title": "ListClerkOrganizationInvitationsResponse", "type": "object" } }, { "description": "List members of a Clerk organization.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns membership id, user_id, role, and created_at for each member, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of organization memberships to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of organization memberships to skip before returning results.", "title": "Offset" }, "organization_id": { "description": "Clerk organization id (org_...) whose members to list.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id" ], "title": "list_clerk_organization_membershipsArguments", "type": "object" }, "name": "clerk.list_organization_memberships", "outputSchema": { "$defs": { "ListClerkOrganizationMembershipsResponseMembershipsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization membership id (orgmem_...).", "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role of the member in the organization (e.g. org:admin, org:member).", "title": "Role" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the member.", "title": "User Id" } }, "title": "ListClerkOrganizationMembershipsResponseMembershipsItem", "type": "object" } }, "additionalProperties": true, "properties": { "memberships": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationMembershipsResponseMembershipsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Memberships returned for the requested page.", "title": "Memberships" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of members in the organization.", "title": "Total Count" } }, "title": "ListClerkOrganizationMembershipsResponse", "type": "object" } }, { "description": "List organization permissions in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns permission summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of results to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of results to skip before returning.", "minimum": 0, "title": "Offset", "type": "integer" }, "order_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.", "title": "Order By" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search by name or key.", "title": "Query" } }, "title": "list_clerk_organization_permissionsArguments", "type": "object" }, "name": "clerk.list_organization_permissions", "outputSchema": { "$defs": { "ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_permissions": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationPermissionsResponseOrganizationPermissionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Organization permissions in the connected Clerk application.", "title": "Organization Permissions" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of organization permissions.", "title": "Total Count" } }, "title": "ListClerkOrganizationPermissionsResponse", "type": "object" } }, { "description": "List organization roles in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns role summaries with nested permissions and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of results to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of results to skip before returning.", "minimum": 0, "title": "Offset", "type": "integer" }, "order_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.", "title": "Order By" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search by name or key.", "title": "Query" } }, "title": "list_clerk_organization_rolesArguments", "type": "object" }, "name": "clerk.list_organization_roles", "outputSchema": { "$defs": { "ListClerkOrganizationRolesResponseOrganizationRolesItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization role id.", "title": "Id" }, "is_creator_eligible": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this role may be assigned as organization creator.", "title": "Is Creator Eligible" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role key used in memberships.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role display name.", "title": "Name" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permissions assigned to this role.", "title": "Permissions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was last updated.", "title": "Updated At" } }, "title": "ListClerkOrganizationRolesResponseOrganizationRolesItem", "type": "object" }, "ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "ListClerkOrganizationRolesResponseOrganizationRolesItemPermissionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_roles": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationRolesResponseOrganizationRolesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Organization roles in the connected Clerk application.", "title": "Organization Roles" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of organization roles.", "title": "Total Count" } }, "title": "ListClerkOrganizationRolesResponse", "type": "object" } }, { "description": "List organizations in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns organization id, name, slug, members_count, and created_at for each organization, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of organizations to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of organizations to skip before returning results.", "minimum": 0, "title": "Offset", "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional search string to filter organizations by name or slug.", "title": "Query" } }, "title": "list_clerk_organizationsArguments", "type": "object" }, "name": "clerk.list_organizations", "outputSchema": { "$defs": { "ListClerkOrganizationsResponseOrganizationsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the organization was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Id" }, "members_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current number of members in the organization.", "title": "Members Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization display name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL-friendly organization slug, if set.", "title": "Slug" } }, "title": "ListClerkOrganizationsResponseOrganizationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organizations": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkOrganizationsResponseOrganizationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Organizations returned for the requested page.", "title": "Organizations" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of organizations in the Clerk application.", "title": "Total Count" } }, "title": "ListClerkOrganizationsResponse", "type": "object" } }, { "description": "List allowed redirect URLs for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns redirect URL summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of redirect URLs to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of redirect URLs to skip before returning results.", "minimum": 0, "title": "Offset", "type": "integer" } }, "title": "list_clerk_redirect_urlsArguments", "type": "object" }, "name": "clerk.list_redirect_urls", "outputSchema": { "$defs": { "ListClerkRedirectUrlsResponseRedirectUrlsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk redirect URL id.", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the redirect URL.", "title": "Object" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the redirect URL was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URL value.", "title": "Url" } }, "title": "ListClerkRedirectUrlsResponseRedirectUrlsItem", "type": "object" } }, "additionalProperties": true, "properties": { "redirect_urls": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkRedirectUrlsResponseRedirectUrlsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URLs returned for the requested page.", "title": "Redirect Urls" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of redirect URLs.", "title": "Total Count" } }, "title": "ListClerkRedirectUrlsResponse", "type": "object" } }, { "description": "List sessions in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns session id, user_id, status, last_active_at, and expire_at for each session.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter sessions to those belonging to this Clerk client id (client_...).", "title": "Client Id" }, "limit": { "default": 10, "description": "Maximum number of sessions to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of sessions to skip before returning results.", "minimum": 0, "title": "Offset", "type": "integer" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter sessions by status. Accepted values: abandoned, active, ended, expired, removed, replaced, revoked.", "title": "Status" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter sessions to those belonging to this Clerk user id (user_...). Clerk requires user_id or client_id when listing sessions; pass user_id here.", "title": "User Id" } }, "title": "list_clerk_sessionsArguments", "type": "object" }, "name": "clerk.list_sessions", "outputSchema": { "$defs": { "ListClerkSessionsResponseSessionsItem": { "additionalProperties": true, "properties": { "expire_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when this session expires.", "title": "Expire At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk session id (sess_...).", "title": "Id" }, "last_active_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds of the last activity on this session.", "title": "Last Active At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current status of the session.", "title": "Status" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this session.", "title": "User Id" } }, "title": "ListClerkSessionsResponseSessionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "sessions": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkSessionsResponseSessionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Sessions returned for the requested page.", "title": "Sessions" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of sessions returned.", "title": "Total Count" } }, "title": "ListClerkSessionsResponse", "type": "object" } }, { "description": "List all organizations a specific Clerk user belongs to.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns membership id, organization_id, role, and timestamps.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "anyOf": [ { "maximum": 500, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of organization memberships to return (1–500).", "title": "Limit" }, "offset": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of organization memberships to skip before returning results.", "title": "Offset" }, "user_id": { "description": "Clerk user id (user_...) whose memberships to list.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "list_clerk_user_organization_membershipsArguments", "type": "object" }, "name": "clerk.list_user_organization_memberships", "outputSchema": { "$defs": { "ListClerkUserOrganizationMembershipsResponseMembershipsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization membership id.", "title": "Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Organization Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Member role within the organization (e.g. org:admin, org:member).", "title": "Role" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was last updated.", "title": "Updated At" } }, "title": "ListClerkUserOrganizationMembershipsResponseMembershipsItem", "type": "object" } }, "additionalProperties": true, "properties": { "memberships": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkUserOrganizationMembershipsResponseMembershipsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Organization memberships for the user.", "title": "Memberships" }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of organization memberships for the user.", "title": "Total Count" } }, "title": "ListClerkUserOrganizationMembershipsResponse", "type": "object" } }, { "description": "List users in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns user id, name, primary email, and created_at for each user, plus total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of users to return (1–500).", "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of users to skip before returning results.", "minimum": 0, "title": "Offset", "type": "integer" } }, "title": "list_clerk_usersArguments", "type": "object" }, "name": "clerk.list_users", "outputSchema": { "$defs": { "ListClerkUsersResponseUsersItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "ListClerkUsersResponseUsersItem", "type": "object" } }, "additionalProperties": true, "properties": { "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of users in the Clerk application.", "title": "Total Count" }, "users": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkUsersResponseUsersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Users returned for the requested page.", "title": "Users" } }, "title": "ListClerkUsersResponse", "type": "object" } }, { "description": "List waitlist entries in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns waitlist entry summaries and total_count.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "limit": { "default": 10, "description": "Maximum number of waitlist entries to return (1–500).", "title": "Limit", "type": "integer" }, "offset": { "default": 0, "description": "Number of waitlist entries to skip before returning results.", "title": "Offset", "type": "integer" }, "order_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at.", "title": "Order By" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by email address or waitlist entry id.", "title": "Query" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional status filter: \"pending\", \"invited\", \"rejected\", or \"completed\".", "title": "Status" } }, "title": "list_clerk_waitlist_entriesArguments", "type": "object" }, "name": "clerk.list_waitlist_entries", "outputSchema": { "$defs": { "ListClerkWaitlistEntriesResponseWaitlistEntriesItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address on the waitlist.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist entry id (wle_...).", "title": "Id" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the entry is locked during batch processing.", "title": "Is Locked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist status: \"pending\", \"invited\", \"rejected\", or \"completed\".", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "ListClerkWaitlistEntriesResponseWaitlistEntriesItem", "type": "object" } }, "additionalProperties": true, "properties": { "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of waitlist entries on this page.", "title": "Total Count" }, "waitlist_entries": { "anyOf": [ { "items": { "$ref": "#/$defs/ListClerkWaitlistEntriesResponseWaitlistEntriesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Waitlist entries returned for the requested page.", "title": "Waitlist Entries" } }, "title": "ListClerkWaitlistEntriesResponse", "type": "object" } }, { "description": "Reject a waitlist entry in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated waitlist entry.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "waitlist_entry_id": { "description": "Clerk waitlist entry id (wle_...) to operate on.", "title": "Waitlist Entry Id", "type": "string" } }, "required": [ "waitlist_entry_id" ], "title": "reject_clerk_waitlist_entryArguments", "type": "object" }, "name": "clerk.reject_waitlist_entry", "outputSchema": { "$defs": { "RejectClerkWaitlistEntryResponseWaitlistEntry": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address on the waitlist.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist entry id (wle_...).", "title": "Id" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the entry is locked during batch processing.", "title": "Is Locked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Waitlist status: \"pending\", \"invited\", \"rejected\", or \"completed\".", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the entry was last updated.", "title": "Updated At" } }, "title": "RejectClerkWaitlistEntryResponseWaitlistEntry", "type": "object" } }, "additionalProperties": true, "properties": { "waitlist_entry": { "anyOf": [ { "$ref": "#/$defs/RejectClerkWaitlistEntryResponseWaitlistEntry" }, { "type": "null" } ], "default": null, "description": "Updated Clerk waitlist entry after rejection." } }, "title": "RejectClerkWaitlistEntryResponse", "type": "object" } }, { "description": "Replace the entire contents of one metadata namespace for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nThe metadata body fully replaces the chosen namespace. Returns the updated user summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "metadata": { "additionalProperties": true, "description": "New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys.", "title": "Metadata", "type": "object" }, "metadata_type": { "description": "Metadata namespace to replace.", "title": "Metadata Type", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) whose metadata to replace.", "title": "User Id", "type": "string" } }, "required": [ "user_id", "metadata_type", "metadata" ], "title": "replace_clerk_user_metadataArguments", "type": "object" }, "name": "clerk.replace_user_metadata", "outputSchema": { "$defs": { "ReplaceClerkUserMetadataResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "ReplaceClerkUserMetadataResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/ReplaceClerkUserMetadataResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after the metadata replacement." } }, "title": "ReplaceClerkUserMetadataResponse", "type": "object" } }, { "description": "Revoke an actor token in a connected Clerk application so it can no longer be used for impersonation.\n\n**Sensitive** — invalidates a high-privilege token.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked actor token object.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "actor_token_id": { "description": "Clerk actor token id to revoke.", "title": "Actor Token Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "required": [ "actor_token_id" ], "title": "revoke_clerk_actor_tokenArguments", "type": "object" }, "name": "clerk.revoke_actor_token", "outputSchema": { "$defs": { "RevokeClerkActorTokenResponseActorToken": { "additionalProperties": true, "properties": { "actor": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkActorTokenResponseActorTokenActor" }, { "type": "null" } ], "default": null, "description": "Actor payload; includes sub with the impersonating user id." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Actor token id.", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token status (pending, accepted, or revoked).", "title": "Status" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Actor token secret. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional sign-in URL that includes the actor token.", "title": "Url" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) being impersonated.", "title": "User Id" } }, "title": "RevokeClerkActorTokenResponseActorToken", "type": "object" }, "RevokeClerkActorTokenResponseActorTokenActor": { "additionalProperties": true, "properties": { "sub": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the impersonating actor.", "title": "Sub" } }, "title": "RevokeClerkActorTokenResponseActorTokenActor", "type": "object" } }, "additionalProperties": true, "properties": { "actor_token": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkActorTokenResponseActorToken" }, { "type": "null" } ], "default": null, "description": "Revoked Clerk actor token object from the Backend API." } }, "title": "RevokeClerkActorTokenResponse", "type": "object" } }, { "description": "Revoke an admin portal link token by id in a connected Clerk instance.\n\n**Sensitive** — invalidates a single-use deep-link token.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked admin portal link token.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "admin_portal_link_token_id": { "description": "Admin portal link token id (aplt_...) to revoke.", "title": "Admin Portal Link Token Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional reason recorded when revoking the link token.", "title": "Revocation Reason" } }, "required": [ "admin_portal_link_token_id" ], "title": "revoke_clerk_admin_portal_link_tokenArguments", "type": "object" }, "name": "clerk.revoke_admin_portal_link_token", "outputSchema": { "$defs": { "RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken": { "additionalProperties": true, "properties": { "admin_portal_link_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Origin admin portal link id (apl_...).", "title": "Admin Portal Link Id" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the link token was created.", "title": "Created At" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the link token expires.", "title": "Expiration" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the link token has expired.", "title": "Expired" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Admin portal link token id (aplt_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...).", "title": "Instance Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the link token has been revoked.", "title": "Revoked" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.", "title": "Token" } }, "title": "RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken", "type": "object" } }, "additionalProperties": true, "properties": { "admin_portal_link_token": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkAdminPortalLinkTokenResponseAdminPortalLinkToken" }, { "type": "null" } ], "default": null, "description": "Revoked admin portal link token from the Backend API." } }, "title": "RevokeClerkAdminPortalLinkTokenResponse", "type": "object" } }, { "description": "Revoke an API key in a connected Clerk application so it can no longer be used.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked API key summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "api_key_id": { "description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke.", "title": "Api Key Id", "type": "string" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional reason recorded when revoking the API key.", "title": "Revocation Reason" } }, "required": [ "api_key_id" ], "title": "revoke_clerk_api_keyArguments", "type": "object" }, "name": "clerk.revoke_api_key", "outputSchema": { "$defs": { "RevokeClerkApiKeyResponseApiKey": { "additionalProperties": true, "properties": { "claims": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkApiKeyResponseApiKeyClaims" }, { "type": "null" } ], "default": null, "description": "Custom claims embedded in tokens minted from this API key." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was created.", "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id that created the API key, when set.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key expires, if set.", "title": "Expiration" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk API key id (ak_...).", "title": "Id" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable API key name.", "title": "Name" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason recorded when the API key was revoked.", "title": "Revocation Reason" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the API key has been revoked.", "title": "Revoked" }, "scopes": { "anyOf": [ { "items": { "$ref": "#/$defs/RevokeClerkApiKeyResponseApiKeyScopesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes granted to this API key.", "title": "Scopes" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was last updated.", "title": "Updated At" } }, "title": "RevokeClerkApiKeyResponseApiKey", "type": "object" }, "RevokeClerkApiKeyResponseApiKeyClaims": { "additionalProperties": true, "properties": { "claim_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key in the custom claims object.", "title": "Claim Key" } }, "title": "RevokeClerkApiKeyResponseApiKeyClaims", "type": "object" }, "RevokeClerkApiKeyResponseApiKeyScopesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A single scope string.", "title": "Item" } }, "title": "RevokeClerkApiKeyResponseApiKeyScopesItem", "type": "object" } }, "additionalProperties": true, "properties": { "api_key": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkApiKeyResponseApiKey" }, { "type": "null" } ], "default": null, "description": "Revoked Clerk API key from the Backend API." } }, "title": "RevokeClerkApiKeyResponse", "type": "object" } }, { "description": "Revoke a pending application invitation by invitation id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nOnly pending invitations can be revoked.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "invitation_id": { "description": "Clerk application invitation id (inv_...) to revoke.", "title": "Invitation Id", "type": "string" } }, "required": [ "invitation_id" ], "title": "revoke_clerk_invitationArguments", "type": "object" }, "name": "clerk.revoke_invitation", "outputSchema": { "$defs": { "RevokeClerkInvitationResponseInvitation": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the invitation was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk invitation id (inv_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the invitation has been revoked.", "title": "Revoked" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: \"pending\", \"accepted\", \"revoked\", or \"expired\".", "title": "Status" } }, "title": "RevokeClerkInvitationResponseInvitation", "type": "object" } }, "additionalProperties": true, "properties": { "invitation": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkInvitationResponseInvitation" }, { "type": "null" } ], "default": null, "description": "Revoked Clerk invitation object from the Backend API." } }, "title": "RevokeClerkInvitationResponse", "type": "object" } }, { "description": "Revoke an M2M token by id in a connected Clerk instance.\n\n**Sensitive** — invalidates a machine authentication token.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked M2M token.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "m2m_token_id": { "description": "Clerk M2M token id (mt_...) to revoke.", "title": "M2M Token Id", "type": "string" } }, "required": [ "m2m_token_id" ], "title": "revoke_clerk_m2m_tokenArguments", "type": "object" }, "name": "clerk.revoke_m2m_token", "outputSchema": { "$defs": { "RevokeClerkM2mTokenResponseM2mToken": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token expires.", "title": "Expiration" }, "expired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has expired.", "title": "Expired" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token id (mt_...).", "title": "Id" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the token has been revoked.", "title": "Revoked" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...) that created or owns the token.", "title": "Subject" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "M2M token secret when returned on creation. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" } }, "title": "RevokeClerkM2mTokenResponseM2mToken", "type": "object" } }, "additionalProperties": true, "properties": { "m2m_token": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkM2mTokenResponseM2mToken" }, { "type": "null" } ], "default": null, "description": "Revoked M2M token from the Backend API." } }, "title": "RevokeClerkM2mTokenResponse", "type": "object" } }, { "description": "Revoke a pending Clerk organization invitation.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nOnly pending invitations can be revoked. Returns the updated invitation summary with status revoked.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "invitation_id": { "description": "Clerk organization invitation id (orginv_...).", "title": "Invitation Id", "type": "string" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" } }, "required": [ "organization_id", "invitation_id" ], "title": "revoke_clerk_organization_invitationArguments", "type": "object" }, "name": "clerk.revoke_organization_invitation", "outputSchema": { "$defs": { "RevokeClerkOrganizationInvitationResponseInvitation": { "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address the invitation was sent to.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization invitation id (inv_...).", "title": "Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this invitation.", "title": "Organization Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role assigned to the invitee (e.g. org:admin, org:member).", "title": "Role" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Invitation status: pending, accepted, or revoked.", "title": "Status" } }, "title": "RevokeClerkOrganizationInvitationResponseInvitation", "type": "object" } }, "additionalProperties": true, "properties": { "invitation": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkOrganizationInvitationResponseInvitation" }, { "type": "null" } ], "default": null, "description": "Revoked organization invitation summary." } }, "title": "RevokeClerkOrganizationInvitationResponse", "type": "object" } }, { "description": "Revoke a session in a connected Clerk application, immediately ending it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked session object with status set to revoked.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "session_id": { "description": "Clerk session id (sess_...) to retrieve or modify.", "title": "Session Id", "type": "string" } }, "required": [ "session_id" ], "title": "revoke_clerk_sessionArguments", "type": "object" }, "name": "clerk.revoke_session", "outputSchema": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk client id associated with this session.", "title": "Client Id" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was created.", "title": "Created At" }, "expire_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when this session expires.", "title": "Expire At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk session id (sess_...).", "title": "Id" }, "last_active_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds of the last activity on this session.", "title": "Last Active At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current status of the session.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the session was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this session.", "title": "User Id" } }, "title": "RevokeClerkSessionResponse", "type": "object" } }, { "description": "Revoke a sign-in token in a connected Clerk application so it can no longer be used.\n\n**Sensitive** — invalidates a high-privilege token.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the revoked sign-in token object.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "sign_in_token_id": { "description": "Clerk sign-in token id to revoke.", "title": "Sign In Token Id", "type": "string" } }, "required": [ "sign_in_token_id" ], "title": "revoke_clerk_sign_in_tokenArguments", "type": "object" }, "name": "clerk.revoke_sign_in_token", "outputSchema": { "$defs": { "RevokeClerkSignInTokenResponseSignInToken": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sign-in token id.", "title": "Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token status (pending, accepted, or revoked).", "title": "Status" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sign-in token secret. Treat as high-privilege — do not log.", "title": "Token" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the token was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional sign-in URL that includes the token.", "title": "Url" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) the token is for.", "title": "User Id" } }, "title": "RevokeClerkSignInTokenResponseSignInToken", "type": "object" } }, "additionalProperties": true, "properties": { "sign_in_token": { "anyOf": [ { "$ref": "#/$defs/RevokeClerkSignInTokenResponseSignInToken" }, { "type": "null" } ], "default": null, "description": "Revoked Clerk sign-in token object from the Backend API." } }, "title": "RevokeClerkSignInTokenResponse", "type": "object" } }, { "description": "Rotate the secret key for a machine in a connected Clerk instance.\n\n**Sensitive** — the response includes the new secret key; do not log or expose it.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the new secret key.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" }, "previous_token_ttl": { "description": "Seconds the previous secret key remains valid after rotation (0–28800).", "maximum": 28800, "minimum": 0, "title": "Previous Token Ttl", "type": "integer" } }, "required": [ "machine_id", "previous_token_ttl" ], "title": "rotate_clerk_machine_secret_keyArguments", "type": "object" }, "name": "clerk.rotate_machine_secret_key", "outputSchema": { "$defs": { "RotateClerkMachineSecretKeyResponseMachineSecretKey": { "additionalProperties": true, "properties": { "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Object type (machine_secret_key).", "title": "Object" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key. Treat as high-privilege — do not log.", "title": "Secret" } }, "title": "RotateClerkMachineSecretKeyResponseMachineSecretKey", "type": "object" } }, "additionalProperties": true, "properties": { "machine_secret_key": { "anyOf": [ { "$ref": "#/$defs/RotateClerkMachineSecretKeyResponseMachineSecretKey" }, { "type": "null" } ], "default": null, "description": "Rotated machine secret key payload from the Backend API." } }, "title": "RotateClerkMachineSecretKeyResponse", "type": "object" } }, { "description": "Rotate the client secret for a confidential OAuth application in a connected Clerk application.\n\n**Sensitive** — the response includes a new client_secret. Update authorized OAuth clients immediately and do not log the secret.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated OAuth application summary with the new client_secret.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "oauth_application_id": { "description": "Clerk OAuth application id (oa_...) to retrieve, update, or delete.", "title": "Oauth Application Id", "type": "string" } }, "required": [ "oauth_application_id" ], "title": "rotate_clerk_oauth_application_secretArguments", "type": "object" }, "name": "clerk.rotate_oauth_application_secret", "outputSchema": { "$defs": { "RotateClerkOauthApplicationSecretResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "RotateClerkOauthApplicationSecretResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/RotateClerkOauthApplicationSecretResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "OAuth application summary with the new client_secret." } }, "title": "RotateClerkOauthApplicationSecretResponse", "type": "object" } }, { "description": "Remove bans from one or more Clerk users, restoring their ability to sign in.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user summaries and total count.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "user_ids": { "description": "List of one or more Clerk user ids (user_...) to unban.", "items": { "type": "string" }, "title": "User Ids", "type": "array" } }, "required": [ "user_ids" ], "title": "unban_clerk_usersArguments", "type": "object" }, "name": "clerk.unban_users", "outputSchema": { "$defs": { "UnbanClerkUsersResponseUsersItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "UnbanClerkUsersResponseUsersItem", "type": "object" } }, "additionalProperties": true, "properties": { "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of users that were unbanned.", "title": "Total Count" }, "users": { "anyOf": [ { "items": { "$ref": "#/$defs/UnbanClerkUsersResponseUsersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Updated user summaries for all unbanned users.", "title": "Users" } }, "title": "UnbanClerkUsersResponse", "type": "object" } }, { "description": "Update an API key in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated API key summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "api_key_id": { "description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke.", "title": "Api Key Id", "type": "string" }, "claims": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Updated custom claims for tokens minted from this API key.", "title": "Claims" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated description for the API key.", "title": "Description" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Updated permission scopes for the API key.", "title": "Scopes" }, "seconds_until_expiration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Updated seconds until expiration from now.", "title": "Seconds Until Expiration" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated subject (user_... or org_...).", "title": "Subject" } }, "required": [ "api_key_id" ], "title": "update_clerk_api_keyArguments", "type": "object" }, "name": "clerk.update_api_key", "outputSchema": { "$defs": { "UpdateClerkApiKeyResponseApiKey": { "additionalProperties": true, "properties": { "claims": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkApiKeyResponseApiKeyClaims" }, { "type": "null" } ], "default": null, "description": "Custom claims embedded in tokens minted from this API key." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was created.", "title": "Created At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id that created the API key, when set.", "title": "Created By" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional description for the API key.", "title": "Description" }, "expiration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key expires, if set.", "title": "Expiration" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk API key id (ak_...).", "title": "Id" }, "key_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key type (typically \"api_key\").", "title": "Key Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable API key name.", "title": "Name" }, "revocation_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason recorded when the API key was revoked.", "title": "Revocation Reason" }, "revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the API key has been revoked.", "title": "Revoked" }, "scopes": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateClerkApiKeyResponseApiKeyScopesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission scopes granted to this API key.", "title": "Scopes" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "API key secret value. Treat as high-privilege — do not log.", "title": "Secret" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subject the API key is scoped to (user_... or org_...).", "title": "Subject" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the API key was last updated.", "title": "Updated At" } }, "title": "UpdateClerkApiKeyResponseApiKey", "type": "object" }, "UpdateClerkApiKeyResponseApiKeyClaims": { "additionalProperties": true, "properties": { "claim_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A key in the custom claims object.", "title": "Claim Key" } }, "title": "UpdateClerkApiKeyResponseApiKeyClaims", "type": "object" }, "UpdateClerkApiKeyResponseApiKeyScopesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A single scope string.", "title": "Item" } }, "title": "UpdateClerkApiKeyResponseApiKeyScopesItem", "type": "object" } }, "additionalProperties": true, "properties": { "api_key": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkApiKeyResponseApiKey" }, { "type": "null" } ], "default": null, "description": "Updated Clerk API key from the Backend API." } }, "title": "UpdateClerkApiKeyResponse", "type": "object" } }, { "description": "Update a custom domain on a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated domain.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "domain_id": { "description": "Clerk organization domain id (dmn_...) to update, delete, or verify.", "title": "Domain Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated domain hostname.", "title": "Name" }, "proxy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated proxy URL for a satellite domain.", "title": "Proxy Url" } }, "required": [ "domain_id" ], "title": "update_clerk_domainArguments", "type": "object" }, "name": "clerk.update_domain", "outputSchema": { "$defs": { "UpdateClerkDomainResponseDomain": { "additionalProperties": true, "properties": { "accounts_portal_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Accounts portal URL for the domain.", "title": "Accounts Portal Url" }, "cname_targets": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateClerkDomainResponseDomainCnameTargetsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "CNAME records required to verify the domain.", "title": "Cname Targets" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin associated with the domain.", "title": "Development Origin" }, "frontend_api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Frontend API URL for the domain.", "title": "Frontend Api Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk domain id.", "title": "Id" }, "is_satellite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a satellite domain.", "title": "Is Satellite" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain hostname.", "title": "Name" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the domain.", "title": "Object" }, "proxy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Proxy URL when using a satellite domain behind a reverse proxy.", "title": "Proxy Url" } }, "title": "UpdateClerkDomainResponseDomain", "type": "object" }, "UpdateClerkDomainResponseDomainCnameTargetsItem": { "additionalProperties": true, "properties": { "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS host label for the CNAME record.", "title": "Host" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this CNAME record is required for domain verification.", "title": "Required" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS target value for the CNAME record.", "title": "Value" } }, "title": "UpdateClerkDomainResponseDomainCnameTargetsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkDomainResponseDomain" }, { "type": "null" } ], "default": null, "description": "Updated Clerk domain from the Backend API." } }, "title": "UpdateClerkDomainResponse", "type": "object" } }, { "description": "Update a Clerk email address by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated email address summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "email_address_id": { "description": "Clerk email address id (idn_...) to retrieve or modify.", "title": "Email Address Id", "type": "string" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, set this email as the user's primary email address.", "title": "Primary" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, mark the email address as verified.", "title": "Verified" } }, "required": [ "email_address_id" ], "title": "update_clerk_email_addressArguments", "type": "object" }, "name": "clerk.update_email_address", "outputSchema": { "$defs": { "UpdateClerkEmailAddressResponseEmailAddress": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was created.", "title": "Created At" }, "email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address value.", "title": "Email Address" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk email address id (idn_...).", "title": "Id" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's primary email address.", "title": "Primary" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the email address was last updated.", "title": "Updated At" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) that owns this email address.", "title": "User Id" }, "verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verification status (e.g. verified, unverified, failed).", "title": "Verification Status" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the email address is verified.", "title": "Verified" } }, "title": "UpdateClerkEmailAddressResponseEmailAddress", "type": "object" } }, "additionalProperties": true, "properties": { "email_address": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkEmailAddressResponseEmailAddress" }, { "type": "null" } ], "default": null, "description": "Updated Clerk email address summary." } }, "title": "UpdateClerkEmailAddressResponse", "type": "object" } }, { "description": "Update an enterprise SSO connection in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated enterprise_connection summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is allowed.", "title": "Allow Organization Account Linking" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "connection_id": { "description": "Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.", "title": "Connection Id", "type": "string" }, "custom_attributes": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Updated custom attribute mappings.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to block additional identifications for this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Updated domain list (replaces existing domains when provided).", "title": "Domains" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated display name for the connection.", "title": "Name" }, "oidc": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Updated OIDC client configuration.", "title": "Oidc" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) to link to this connection.", "title": "Organization Id" }, "saml": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Updated SAML IdP configuration.", "title": "Saml" }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to sync user attributes on each sign-in.", "title": "Sync User Attributes" } }, "required": [ "connection_id" ], "title": "update_clerk_enterprise_connectionArguments", "type": "object" }, "name": "clerk.update_enterprise_connection", "outputSchema": { "$defs": { "UpdateClerkEnterpriseConnectionResponseEnterpriseConnection": { "additionalProperties": true, "properties": { "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the connection is active.", "title": "Active" }, "allow_organization_account_linking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether account linking via organization membership is supported.", "title": "Allow Organization Account Linking" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was created.", "title": "Created At" }, "custom_attributes": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Custom attribute mappings from the IdP to user metadata.", "title": "Custom Attributes" }, "disable_additional_identifications": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether users may add additional identifications with this connection.", "title": "Disable Additional Identifications" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Email domains that may use this connection.", "title": "Domains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enterprise connection id.", "title": "Id" }, "logo_public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public logo URL for the connection when available.", "title": "Logo Public Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the connection.", "title": "Name" }, "oauth_config": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig" }, { "type": "null" } ], "default": null, "description": "OIDC configuration when the connection uses OAuth." }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Linked Clerk organization id (org_...) when the connection is org-scoped.", "title": "Organization Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity provider key (for example saml_custom or oidc_custom).", "title": "Provider" }, "saml_connection": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection" }, { "type": "null" } ], "default": null, "description": "SAML configuration when the connection uses SAML." }, "sync_user_attributes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether user attributes sync on each sign-in.", "title": "Sync User Attributes" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the connection was last updated.", "title": "Updated At" } }, "title": "UpdateClerkEnterpriseConnectionResponseEnterpriseConnection", "type": "object" }, "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem": { "additionalProperties": true, "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Metadata key used to store the attribute on the user.", "title": "Key" }, "multi_valued": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the attribute supports multiple values.", "title": "Multi Valued" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the custom attribute.", "title": "Name" }, "scim_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "GJSON path to extract the value from SCIM resources.", "title": "Scim Path" }, "sso_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Path to extract the value from SSO claims.", "title": "Sso Path" } }, "title": "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionCustomAttributesItem", "type": "object" }, "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig": { "additionalProperties": true, "properties": { "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id.", "title": "Client Id" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OIDC discovery URL.", "title": "Discovery Url" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth config id when the connection uses OIDC.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom OIDC provider display name.", "title": "Name" }, "provider_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth provider key (for example oidc_custom).", "title": "Provider Key" }, "requires_pkce": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for this OAuth client.", "title": "Requires Pkce" } }, "title": "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionOauthConfig", "type": "object" }, "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection": { "additionalProperties": true, "properties": { "acs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Assertion Consumer Service URL.", "title": "Acs Url" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SAML connection is active.", "title": "Active" }, "allow_idp_initiated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether IdP-initiated SSO is allowed.", "title": "Allow Idp Initiated" }, "allow_subdomains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subdomains may use this connection.", "title": "Allow Subdomains" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection id when the connection uses SAML.", "title": "Id" }, "idp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider entity id.", "title": "Idp Entity Id" }, "idp_sso_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identity Provider Single Sign-On URL.", "title": "Idp Sso Url" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "SAML connection display name.", "title": "Name" }, "sp_entity_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Service Provider entity id (Clerk).", "title": "Sp Entity Id" } }, "title": "UpdateClerkEnterpriseConnectionResponseEnterpriseConnectionSamlConnection", "type": "object" } }, "additionalProperties": true, "properties": { "enterprise_connection": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkEnterpriseConnectionResponseEnterpriseConnection" }, { "type": "null" } ], "default": null, "description": "Updated enterprise SSO connection." } }, "title": "UpdateClerkEnterpriseConnectionResponse", "type": "object" } }, { "description": "Update SMS communication settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated communication settings.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "blocked_country_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "ISO country codes to block from receiving SMS messages (up to 250).", "title": "Blocked Country Codes" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "update_clerk_instance_communication_settingsArguments", "type": "object" }, "name": "clerk.update_instance_communication_settings", "outputSchema": { "$defs": { "UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings": { "additionalProperties": true, "properties": { "blocked_country_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "ISO country codes blocked from receiving SMS messages.", "title": "Blocked Country Codes" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for communication settings.", "title": "Object" } }, "title": "UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings", "type": "object" } }, "additionalProperties": true, "properties": { "communication_settings": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkInstanceCommunicationSettingsResponseCommunicationSettings" }, { "type": "null" } ], "default": null, "description": "Updated Clerk instance communication settings from the Backend API." } }, "title": "UpdateClerkInstanceCommunicationSettingsResponse", "type": "object" } }, { "description": "Update OAuth settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated OAuth settings.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "dynamic_oauth_client_registration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether dynamic OAuth client registration should be enabled.", "title": "Dynamic Oauth Client Registration" }, "oauth_jwt_access_tokens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether OAuth access tokens should be issued as JWTs.", "title": "Oauth Jwt Access Tokens" } }, "title": "update_clerk_instance_oauth_settingsArguments", "type": "object" }, "name": "clerk.update_instance_oauth_settings", "outputSchema": { "$defs": { "UpdateClerkInstanceOauthSettingsResponseOauthSettings": { "additionalProperties": true, "properties": { "dynamic_oauth_client_registration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether dynamic OAuth client registration is enabled.", "title": "Dynamic Oauth Client Registration" }, "oauth_jwt_access_tokens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether OAuth access tokens are issued as JWTs.", "title": "Oauth Jwt Access Tokens" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for OAuth settings.", "title": "Object" } }, "title": "UpdateClerkInstanceOauthSettingsResponseOauthSettings", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_settings": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkInstanceOauthSettingsResponseOauthSettings" }, { "type": "null" } ], "default": null, "description": "Updated Clerk instance OAuth settings from the Backend API." } }, "title": "UpdateClerkInstanceOauthSettingsResponse", "type": "object" } }, { "description": "Update organization feature settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated organization settings.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "admin_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization admins can delete their organization.", "title": "Admin Delete Enabled" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "creator_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role assigned to the organization creator.", "title": "Creator Role" }, "domains_default_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role for members who join via a verified organization domain.", "title": "Domains Default Role" }, "domains_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization domains should be enabled.", "title": "Domains Enabled" }, "domains_enrollment_modes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed organization domain enrollment modes: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Domains Enrollment Modes" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organizations should be enabled for the instance.", "title": "Enabled" }, "initial_role_set_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Initial role set key applied to new organizations.", "title": "Initial Role Set Key" }, "max_allowed_memberships": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum organization memberships allowed per user.", "title": "Max Allowed Memberships" } }, "title": "update_clerk_instance_organization_settingsArguments", "type": "object" }, "name": "clerk.update_instance_organization_settings", "outputSchema": { "$defs": { "UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings": { "additionalProperties": true, "properties": { "admin_delete_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization admins can delete their organization.", "title": "Admin Delete Enabled" }, "creator_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role assigned to the organization creator.", "title": "Creator Role" }, "domains_default_role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Default role for members who join via a verified organization domain.", "title": "Domains Default Role" }, "domains_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization domains are enabled.", "title": "Domains Enabled" }, "domains_enrollment_modes": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed organization domain enrollment modes.", "title": "Domains Enrollment Modes" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organizations are enabled for the instance.", "title": "Enabled" }, "initial_role_set_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Initial role set key applied to new organizations.", "title": "Initial Role Set Key" }, "max_allowed_domains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum verified domains allowed per organization.", "title": "Max Allowed Domains" }, "max_allowed_memberships": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum organization memberships allowed per user.", "title": "Max Allowed Memberships" }, "max_allowed_roles": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum custom roles allowed per organization.", "title": "Max Allowed Roles" }, "max_role_sets_allowed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum role sets allowed per organization.", "title": "Max Role Sets Allowed" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for organization settings.", "title": "Object" }, "slug_disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether organization slugs are disabled.", "title": "Slug Disabled" } }, "title": "UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings", "type": "object" }, "UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem": { "additionalProperties": true, "properties": { "item": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "An enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Item" } }, "title": "UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettingsDomainsEnrollmentModesItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_settings": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkInstanceOrganizationSettingsResponseOrganizationSettings" }, { "type": "null" } ], "default": null, "description": "Updated Clerk instance organization settings from the Backend API." } }, "title": "UpdateClerkInstanceOrganizationSettingsResponse", "type": "object" } }, { "description": "Update sign-up and sign-in restriction settings for a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated instance restrictions.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "allowlist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the allowlist restriction should be enabled.", "title": "Allowlist" }, "allowlist_blocklist_disabled_on_sign_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether allowlist and blocklist checks should be skipped during sign-in.", "title": "Allowlist Blocklist Disabled On Sign In" }, "block_disposable_email_domains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether disposable email domains should be blocked.", "title": "Block Disposable Email Domains" }, "block_email_subaddresses": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subaddresses (plus-addressing) should be blocked.", "title": "Block Email Subaddresses" }, "blocklist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the blocklist restriction should be enabled.", "title": "Blocklist" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" } }, "title": "update_clerk_instance_restrictionsArguments", "type": "object" }, "name": "clerk.update_instance_restrictions", "outputSchema": { "$defs": { "UpdateClerkInstanceRestrictionsResponseRestrictions": { "additionalProperties": true, "properties": { "allowlist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the allowlist restriction is enabled.", "title": "Allowlist" }, "allowlist_blocklist_disabled_on_sign_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether allowlist and blocklist checks are skipped during sign-in.", "title": "Allowlist Blocklist Disabled On Sign In" }, "block_disposable_email_domains": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether disposable email domains are blocked.", "title": "Block Disposable Email Domains" }, "block_email_subaddresses": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether email subaddresses (plus-addressing) are blocked.", "title": "Block Email Subaddresses" }, "blocklist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the blocklist restriction is enabled.", "title": "Blocklist" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for instance restrictions.", "title": "Object" } }, "title": "UpdateClerkInstanceRestrictionsResponseRestrictions", "type": "object" } }, "additionalProperties": true, "properties": { "restrictions": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkInstanceRestrictionsResponseRestrictions" }, { "type": "null" } ], "default": null, "description": "Updated Clerk instance restrictions from the Backend API." } }, "title": "UpdateClerkInstanceRestrictionsResponse", "type": "object" } }, { "description": "Update core settings for a connected Clerk application instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated instance settings.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "allowed_origins": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed browser origins for the instance.", "title": "Allowed Origins" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "clerk_js_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinned Clerk.js version for the instance.", "title": "Clerk Js Version" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin URL for local testing.", "title": "Development Origin" }, "hibp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Have I Been Pwned password checking should be enabled.", "title": "Hibp" }, "preferred_sign_in_strategy_when_password_required": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preferred sign-in strategy when a password is required: \"password\" or \"otp\".", "title": "Preferred Sign In Strategy When Password Required" }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Support email address shown to end users.", "title": "Support Email" }, "test_mode": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the instance should run in test mode.", "title": "Test Mode" }, "url_based_session_syncing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether URL-based session syncing should be enabled.", "title": "Url Based Session Syncing" } }, "title": "update_clerk_instance_settingsArguments", "type": "object" }, "name": "clerk.update_instance_settings", "outputSchema": { "$defs": { "UpdateClerkInstanceSettingsResponseInstanceSettings": { "additionalProperties": true, "properties": { "allowed_origins": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed browser origins for the instance.", "title": "Allowed Origins" }, "clerk_js_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinned Clerk.js version for the instance, when set.", "title": "Clerk Js Version" }, "development_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Development origin URL for local testing.", "title": "Development Origin" }, "environment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Instance environment type (development or production).", "title": "Environment Type" }, "hibp": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Have I Been Pwned password checking is enabled.", "title": "Hibp" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...).", "title": "Id" }, "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk object type for the instance.", "title": "Object" }, "preferred_sign_in_strategy_when_password_required": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preferred sign-in strategy when a password is required: \"password\" or \"otp\".", "title": "Preferred Sign In Strategy When Password Required" }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Support email address shown to end users.", "title": "Support Email" }, "test_mode": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the instance is in test mode.", "title": "Test Mode" }, "url_based_session_syncing": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether URL-based session syncing is enabled.", "title": "Url Based Session Syncing" } }, "title": "UpdateClerkInstanceSettingsResponseInstanceSettings", "type": "object" } }, "additionalProperties": true, "properties": { "instance_settings": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkInstanceSettingsResponseInstanceSettings" }, { "type": "null" } ], "default": null, "description": "Updated Clerk instance settings from the Backend API." } }, "title": "UpdateClerkInstanceSettingsResponse", "type": "object" } }, { "description": "Update an existing JWT template in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated template summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "allowed_clock_skew": { "anyOf": [ { "maximum": 300, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Optional new allowed clock skew in seconds (0–300).", "title": "Allowed Clock Skew" }, "claims": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional new JWT claims template as a JSON object.", "title": "Claims" }, "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Optional flag to enable or disable a custom signing key.", "title": "Custom Signing Key" }, "lifetime": { "anyOf": [ { "maximum": 315360000, "minimum": 30, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Optional new token lifetime in seconds (30–315360000).", "title": "Lifetime" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional new unique template name.", "title": "Name" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional custom signing algorithm.", "title": "Signing Algorithm" }, "signing_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional custom signing private key.", "title": "Signing Key" }, "template_id": { "description": "Clerk JWT template id (jtmp_...) to retrieve, update, or delete.", "title": "Template Id", "type": "string" } }, "required": [ "template_id" ], "title": "update_clerk_jwt_templateArguments", "type": "object" }, "name": "clerk.update_jwt_template", "outputSchema": { "$defs": { "UpdateClerkJwtTemplateResponseJwtTemplate": { "additionalProperties": true, "properties": { "allowed_clock_skew": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Allowed clock skew in seconds for the nbf claim.", "title": "Allowed Clock Skew" }, "claims": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkJwtTemplateResponseJwtTemplateClaims" }, { "type": "null" } ], "default": null, "description": "JWT claims template as a JSON object (may include Clerk shortcodes)." }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was created.", "title": "Created At" }, "custom_signing_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this template uses a custom signing key and algorithm.", "title": "Custom Signing Key" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk JWT template id (jtmp_...).", "title": "Id" }, "lifetime": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token lifetime in seconds (exp claim offset from issuance time).", "title": "Lifetime" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique template name used when minting tokens from this template.", "title": "Name" }, "signing_algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom signing algorithm when custom_signing_key is enabled.", "title": "Signing Algorithm" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the template was last updated.", "title": "Updated At" } }, "title": "UpdateClerkJwtTemplateResponseJwtTemplate", "type": "object" }, "UpdateClerkJwtTemplateResponseJwtTemplateClaims": { "additionalProperties": true, "properties": { "aud": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Audience claim when set in the template.", "title": "Aud" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role claim when set in the template.", "title": "Role" } }, "title": "UpdateClerkJwtTemplateResponseJwtTemplateClaims", "type": "object" } }, "additionalProperties": true, "properties": { "jwt_template": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkJwtTemplateResponseJwtTemplate" }, { "type": "null" } ], "default": null, "description": "Updated Clerk JWT template summary." } }, "title": "UpdateClerkJwtTemplateResponse", "type": "object" } }, { "description": "Update a machine in a connected Clerk instance.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated machine.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "default_token_ttl": { "anyOf": [ { "maximum": 315360000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Updated default M2M token lifetime in seconds.", "title": "Default Token Ttl" }, "machine_id": { "description": "Clerk machine id (mch_...) to retrieve or modify.", "title": "Machine Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated machine display name.", "title": "Name" } }, "required": [ "machine_id" ], "title": "update_clerk_machineArguments", "type": "object" }, "name": "clerk.update_machine", "outputSchema": { "$defs": { "UpdateClerkMachineResponseMachine": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was created.", "title": "Created At" }, "default_token_ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Default token lifetime in seconds for tokens created by this machine.", "title": "Default Token Ttl" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine id (mch_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns the machine.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine display name.", "title": "Name" }, "secret_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine secret key returned on create. Treat as high-privilege — do not log.", "title": "Secret Key" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the machine was last updated.", "title": "Updated At" } }, "title": "UpdateClerkMachineResponseMachine", "type": "object" } }, "additionalProperties": true, "properties": { "machine": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkMachineResponseMachine" }, { "type": "null" } ], "default": null, "description": "Updated machine object from the Backend API." } }, "title": "UpdateClerkMachineResponse", "type": "object" } }, { "description": "Update an OAuth application in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated OAuth application summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to show the OAuth consent screen during authorization.", "title": "Consent Screen Enabled" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "New display name for the OAuth application.", "title": "Name" }, "oauth_application_id": { "description": "Clerk OAuth application id (oa_...) to retrieve, update, or delete.", "title": "Oauth Application Id", "type": "string" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (no client secret; PKCE-capable).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Replacement list of allowed redirect URIs.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes (e.g. profile email public_metadata).", "title": "Scopes" } }, "required": [ "oauth_application_id" ], "title": "update_clerk_oauth_applicationArguments", "type": "object" }, "name": "clerk.update_oauth_application", "outputSchema": { "$defs": { "UpdateClerkOauthApplicationResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "UpdateClerkOauthApplicationResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOauthApplicationResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "Updated Clerk OAuth application summary." } }, "title": "UpdateClerkOauthApplicationResponse", "type": "object" } }, { "description": "Update fields for a Clerk organization.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated organization summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "max_allowed_memberships": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Optional new maximum number of memberships allowed.", "title": "Max Allowed Memberships" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional new display name for the organization.", "title": "Name" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" }, "private_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional private metadata to merge into the organization.", "title": "Private Metadata" }, "public_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Optional public metadata to merge into the organization.", "title": "Public Metadata" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional new URL-friendly slug.", "title": "Slug" } }, "required": [ "organization_id" ], "title": "update_clerk_organizationArguments", "type": "object" }, "name": "clerk.update_organization", "outputSchema": { "$defs": { "UpdateClerkOrganizationResponseOrganization": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the organization was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Id" }, "members_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current number of members in the organization.", "title": "Members Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization display name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL-friendly organization slug, if set.", "title": "Slug" } }, "title": "UpdateClerkOrganizationResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "organization": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Updated Clerk organization summary." } }, "title": "UpdateClerkOrganizationResponse", "type": "object" } }, { "description": "Update enrollment mode or verification status for an organization domain.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated domain summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "domain_id": { "description": "Clerk organization domain id (dmn_...) to update, delete, or verify.", "title": "Domain Id", "type": "string" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain is verified.", "title": "Verified" } }, "required": [ "domain_id" ], "title": "update_clerk_organization_domainArguments", "type": "object" }, "name": "clerk.update_organization_domain", "outputSchema": { "$defs": { "UpdateClerkOrganizationDomainResponseDomain": { "additionalProperties": true, "properties": { "affiliation_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation email address for the domain, when set.", "title": "Affiliation Email Address" }, "affiliation_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation verification status (unverified, verified, failed, or expired).", "title": "Affiliation Verification Status" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was created.", "title": "Created At" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization domain id (dmn_...).", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain name (for example example.com).", "title": "Name" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this domain.", "title": "Organization Id" }, "ownership_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS ownership verification status (unverified, verified, failed, or expired).", "title": "Ownership Verification Status" }, "total_pending_invitations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending invitations associated with this domain.", "title": "Total Pending Invitations" }, "total_pending_suggestions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending membership suggestions associated with this domain.", "title": "Total Pending Suggestions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was last updated.", "title": "Updated At" } }, "title": "UpdateClerkOrganizationDomainResponseDomain", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationDomainResponseDomain" }, { "type": "null" } ], "default": null, "description": "Updated organization domain summary." } }, "title": "UpdateClerkOrganizationDomainResponse", "type": "object" } }, { "description": "Change the role of a Clerk organization member.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated membership.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) containing the member.", "title": "Organization Id", "type": "string" }, "role": { "description": "New role for the member (e.g. org:member, org:admin).", "title": "Role", "type": "string" }, "user_id": { "description": "Clerk user id (user_...) of the member to update.", "title": "User Id", "type": "string" } }, "required": [ "organization_id", "user_id", "role" ], "title": "update_clerk_organization_membershipArguments", "type": "object" }, "name": "clerk.update_organization_membership", "outputSchema": { "$defs": { "UpdateClerkOrganizationMembershipResponseMembership": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization membership id (orgmem_...).", "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role of the member in the organization (e.g. org:admin, org:member).", "title": "Role" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the member.", "title": "User Id" } }, "title": "UpdateClerkOrganizationMembershipResponseMembership", "type": "object" } }, "additionalProperties": true, "properties": { "membership": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationMembershipResponseMembership" }, { "type": "null" } ], "default": null, "description": "Updated organization membership." } }, "title": "UpdateClerkOrganizationMembershipResponse", "type": "object" } }, { "description": "Merge public or private metadata on a Clerk organization membership.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated membership.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) containing the membership.", "title": "Organization Id", "type": "string" }, "private_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Private metadata to merge into the membership.", "title": "Private Metadata" }, "public_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Public metadata to merge into the membership.", "title": "Public Metadata" }, "user_id": { "description": "Clerk user id (user_...) of the member.", "title": "User Id", "type": "string" } }, "required": [ "organization_id", "user_id" ], "title": "update_clerk_organization_membership_metadataArguments", "type": "object" }, "name": "clerk.update_organization_membership_metadata", "outputSchema": { "$defs": { "UpdateClerkOrganizationMembershipMetadataResponseMembership": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the membership was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization membership id (orgmem_...).", "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role of the member in the organization (e.g. org:admin, org:member).", "title": "Role" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) of the member.", "title": "User Id" } }, "title": "UpdateClerkOrganizationMembershipMetadataResponseMembership", "type": "object" } }, "additionalProperties": true, "properties": { "membership": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationMembershipMetadataResponseMembership" }, { "type": "null" } ], "default": null, "description": "Updated organization membership." } }, "title": "UpdateClerkOrganizationMembershipMetadataResponse", "type": "object" } }, { "description": "Merge metadata into a Clerk organization (deep merge — existing keys are preserved unless overwritten).\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated organization summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "organization_id": { "description": "Clerk organization id (org_...) to operate on.", "title": "Organization Id", "type": "string" }, "private_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Private metadata to merge into the organization.", "title": "Private Metadata" }, "public_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Public metadata to merge into the organization.", "title": "Public Metadata" } }, "required": [ "organization_id" ], "title": "update_clerk_organization_metadataArguments", "type": "object" }, "name": "clerk.update_organization_metadata", "outputSchema": { "$defs": { "UpdateClerkOrganizationMetadataResponseOrganization": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the organization was created.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...).", "title": "Id" }, "members_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current number of members in the organization.", "title": "Members Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Organization display name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL-friendly organization slug, if set.", "title": "Slug" } }, "title": "UpdateClerkOrganizationMetadataResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "organization": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationMetadataResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Updated Clerk organization summary." } }, "title": "UpdateClerkOrganizationMetadataResponse", "type": "object" } }, { "description": "Update an organization permission in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated permission summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated permission description.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated permission display name.", "title": "Name" }, "permission_id": { "description": "Clerk organization permission id to update or delete.", "title": "Permission Id", "type": "string" } }, "required": [ "permission_id" ], "title": "update_clerk_organization_permissionArguments", "type": "object" }, "name": "clerk.update_organization_permission", "outputSchema": { "$defs": { "UpdateClerkOrganizationPermissionResponseOrganizationPermission": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "UpdateClerkOrganizationPermissionResponseOrganizationPermission", "type": "object" } }, "additionalProperties": true, "properties": { "organization_permission": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationPermissionResponseOrganizationPermission" }, { "type": "null" } ], "default": null, "description": "Updated organization permission summary." } }, "title": "UpdateClerkOrganizationPermissionResponse", "type": "object" } }, { "description": "Update an organization role in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated role summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated role description.", "title": "Description" }, "is_creator_eligible": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this role may be assigned as organization creator.", "title": "Is Creator Eligible" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated role display name.", "title": "Name" }, "permissions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permission keys to assign to the role.", "title": "Permissions" }, "role_id": { "description": "Clerk organization role id to retrieve, update, or delete.", "title": "Role Id", "type": "string" } }, "required": [ "role_id" ], "title": "update_clerk_organization_roleArguments", "type": "object" }, "name": "clerk.update_organization_role", "outputSchema": { "$defs": { "UpdateClerkOrganizationRoleResponseOrganizationRole": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization role id.", "title": "Id" }, "is_creator_eligible": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this role may be assigned as organization creator.", "title": "Is Creator Eligible" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role key used in memberships.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Role display name.", "title": "Name" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/$defs/UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Permissions assigned to this role.", "title": "Permissions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the role was last updated.", "title": "Updated At" } }, "title": "UpdateClerkOrganizationRoleResponseOrganizationRole", "type": "object" }, "UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was created.", "title": "Created At" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission description.", "title": "Description" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization permission id.", "title": "Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission key used in role assignments.", "title": "Key" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission display name.", "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Permission type (system or custom).", "title": "Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the permission was last updated.", "title": "Updated At" } }, "title": "UpdateClerkOrganizationRoleResponseOrganizationRolePermissionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "organization_role": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkOrganizationRoleResponseOrganizationRole" }, { "type": "null" } ], "default": null, "description": "Updated organization role summary." } }, "title": "UpdateClerkOrganizationRoleResponse", "type": "object" } }, { "description": "Update a Clerk phone number by id.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated phone number summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "phone_number_id": { "description": "Clerk phone number id (idn_... or phn_...) to retrieve or modify.", "title": "Phone Number Id", "type": "string" }, "primary": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this should be the user's primary phone number.", "title": "Primary" }, "reserved_for_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to reserve this number for multi-factor authentication.", "title": "Reserved For Second Factor" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number should be marked verified.", "title": "Verified" } }, "required": [ "phone_number_id" ], "title": "update_clerk_phone_numberArguments", "type": "object" }, "name": "clerk.update_phone_number", "outputSchema": { "$defs": { "UpdateClerkPhoneNumberResponsePhoneNumber": { "additionalProperties": true, "properties": { "default_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is the user's default second factor.", "title": "Default Second Factor" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk phone number id.", "title": "Id" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number in E.164 format.", "title": "Phone Number" }, "reserved_for_second_factor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is reserved for multi-factor authentication.", "title": "Reserved For Second Factor" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the phone number is verified.", "title": "Verified" } }, "title": "UpdateClerkPhoneNumberResponsePhoneNumber", "type": "object" } }, "additionalProperties": true, "properties": { "phone_number": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkPhoneNumberResponsePhoneNumber" }, { "type": "null" } ], "default": null, "description": "Updated Clerk phone number object from the Backend API." } }, "title": "UpdateClerkPhoneNumberResponse", "type": "object" } }, { "description": "Update profile fields for a Clerk user.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional external id for the user.", "title": "External Id" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional first name.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional last name.", "title": "Last Name" }, "user_id": { "description": "Clerk user id (user_...) to update.", "title": "User Id", "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional username.", "title": "Username" } }, "required": [ "user_id" ], "title": "update_clerk_userArguments", "type": "object" }, "name": "clerk.update_user", "outputSchema": { "$defs": { "UpdateClerkUserResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "UpdateClerkUserResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkUserResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user summary." } }, "title": "UpdateClerkUserResponse", "type": "object" } }, { "description": "Merge metadata fields for a Clerk user. Only the provided metadata keys are updated.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated user summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "private_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Private metadata fields to merge. Existing keys not listed are preserved.", "title": "Private Metadata" }, "public_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Public metadata fields to merge. Existing keys not listed are preserved.", "title": "Public Metadata" }, "unsafe_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Unsafe metadata fields to merge. Existing keys not listed are preserved.", "title": "Unsafe Metadata" }, "user_id": { "description": "Clerk user id (user_...) whose metadata to update.", "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "update_clerk_user_metadataArguments", "type": "object" }, "name": "clerk.update_user_metadata", "outputSchema": { "$defs": { "UpdateClerkUserMetadataResponseUser": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the user was created.", "title": "Created At" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User first name, if set.", "title": "First Name" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...).", "title": "Id" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User last name, if set.", "title": "Last Name" }, "primary_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary email address for the user, if available.", "title": "Primary Email Address" } }, "title": "UpdateClerkUserMetadataResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "user": { "anyOf": [ { "$ref": "#/$defs/UpdateClerkUserMetadataResponseUser" }, { "type": "null" } ], "default": null, "description": "Updated Clerk user object after the metadata merge." } }, "title": "UpdateClerkUserMetadataResponse", "type": "object" } }, { "description": "Upload or replace the logo image for an OAuth application in a connected Clerk application.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nReturns the updated OAuth application summary.\n\nCost = 8 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "file_name": { "description": "Stored file name from files.list_uploaded_files. Upload with files.upload_file first.", "title": "File Name", "type": "string" }, "oauth_application_id": { "description": "Clerk OAuth application id (oa_...) to retrieve, update, or delete.", "title": "Oauth Application Id", "type": "string" }, "uploader_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk user id (user_...) credited with the image upload.", "title": "Uploader User Id" } }, "required": [ "oauth_application_id", "file_name" ], "title": "upload_clerk_oauth_application_logoArguments", "type": "object" }, "name": "clerk.upload_oauth_application_logo", "outputSchema": { "$defs": { "UploadClerkOauthApplicationLogoResponseOauthApplication": { "additionalProperties": true, "properties": { "authorize_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authorization endpoint URL for this OAuth application.", "title": "Authorize Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client id issued to authorized clients.", "title": "Client Id" }, "client_image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the OAuth application logo when set.", "title": "Client Image Url" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.", "title": "Client Secret" }, "client_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Homepage URI for the OAuth client.", "title": "Client Uri" }, "consent_screen_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the consent screen is shown during authorization.", "title": "Consent Screen Enabled" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was created.", "title": "Created At" }, "discovery_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OpenID Connect discovery document URL.", "title": "Discovery Url" }, "dynamically_registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the OAuth application was registered dynamically.", "title": "Dynamically Registered" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application id (oa_...).", "title": "Id" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) that owns this OAuth application.", "title": "Instance Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "OAuth application display name.", "title": "Name" }, "pkce_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether PKCE is required for the authorization flow.", "title": "Pkce Required" }, "public": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a public OAuth client (PKCE-capable, no client secret).", "title": "Public" }, "redirect_uris": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed redirect URIs for the OAuth authorization flow.", "title": "Redirect Uris" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Space-delimited scopes granted by this OAuth application.", "title": "Scopes" }, "token_fetch_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Token endpoint URL for exchanging authorization codes.", "title": "Token Fetch Url" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the OAuth application was last updated.", "title": "Updated At" } }, "title": "UploadClerkOauthApplicationLogoResponseOauthApplication", "type": "object" } }, "additionalProperties": true, "properties": { "oauth_application": { "anyOf": [ { "$ref": "#/$defs/UploadClerkOauthApplicationLogoResponseOauthApplication" }, { "type": "null" } ], "default": null, "description": "OAuth application summary with updated client_image_url." } }, "title": "UploadClerkOauthApplicationLogoResponse", "type": "object" } }, { "description": "Mark an organization domain's DNS ownership as verified via manual override.\n\nCall clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.\n\nIdempotent when ownership is already verified. Returns the updated domain summary.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "clerk_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.", "title": "Clerk Instance Id" }, "domain_id": { "description": "Clerk organization domain id (dmn_...) to update, delete, or verify.", "title": "Domain Id", "type": "string" } }, "required": [ "domain_id" ], "title": "verify_clerk_organization_domain_ownershipArguments", "type": "object" }, "name": "clerk.verify_organization_domain_ownership", "outputSchema": { "$defs": { "VerifyClerkOrganizationDomainOwnershipResponseDomain": { "additionalProperties": true, "properties": { "affiliation_email_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation email address for the domain, when set.", "title": "Affiliation Email Address" }, "affiliation_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliation verification status (unverified, verified, failed, or expired).", "title": "Affiliation Verification Status" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was created.", "title": "Created At" }, "enrollment_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.", "title": "Enrollment Mode" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization domain id (dmn_...).", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain name (for example example.com).", "title": "Name" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Clerk organization id (org_...) that owns this domain.", "title": "Organization Id" }, "ownership_verification_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS ownership verification status (unverified, verified, failed, or expired).", "title": "Ownership Verification Status" }, "total_pending_invitations": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending invitations associated with this domain.", "title": "Total Pending Invitations" }, "total_pending_suggestions": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pending membership suggestions associated with this domain.", "title": "Total Pending Suggestions" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Unix timestamp in milliseconds when the domain was last updated.", "title": "Updated At" } }, "title": "VerifyClerkOrganizationDomainOwnershipResponseDomain", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/VerifyClerkOrganizationDomainOwnershipResponseDomain" }, { "type": "null" } ], "default": null, "description": "Organization domain summary after ownership verification." } }, "title": "VerifyClerkOrganizationDomainOwnershipResponse", "type": "object" } }, { "description": "Add one DNS host record to a managed domain without replacing the full zone.\n\nPreserves existing records. The domain must use Namecheap DNS. Call domains.get_dns_hosts afterward if HostIds are needed.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "address": { "description": "Record value (IP, hostname, URL, or TXT content depending on type).", "title": "Address", "type": "string" }, "domain": { "description": "Managed domain name (for example example.com).", "title": "Domain", "type": "string" }, "host_name": { "description": "Host label to create, for example @, www, or mail.", "title": "Host Name", "type": "string" }, "mx_pref": { "anyOf": [ { "maximum": 65535, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "MX preference. Required when record_type is MX or MXE.", "title": "Mx Pref" }, "record_type": { "description": "DNS record type. Supported values: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME.", "title": "Record Type", "type": "string" }, "ttl": { "default": 1800, "description": "TTL in seconds (60 to 60000). Defaults to 1800.", "maximum": 60000, "minimum": 60, "title": "Ttl", "type": "integer" } }, "required": [ "domain", "host_name", "record_type", "address" ], "title": "add_dns_hostArguments", "type": "object" }, "name": "domains.add_dns_host", "outputSchema": { "$defs": { "DomainsAddDnsHostResponseHostsItem": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Record value.", "title": "Address" }, "host_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap host record id.", "title": "Host Id" }, "host_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Host label, for example @ or www.", "title": "Host Name" }, "mx_pref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MX preference when record_type is MX or MXE.", "title": "Mx Pref" }, "record_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record type.", "title": "Record Type" }, "ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "TTL in seconds.", "title": "Ttl" } }, "title": "DomainsAddDnsHostResponseHostsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Managed domain name.", "title": "Domain" }, "hosts": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsAddDnsHostResponseHostsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Full DNS host list after the addition.", "title": "Hosts" }, "is_using_namecheap_dns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain currently uses Namecheap DNS.", "title": "Is Using Namecheap Dns" } }, "title": "DomainsAddDnsHostResponse", "type": "object" } }, { "description": "Check whether domain names can be registered through Vee3 (Namecheap-backed).\n\nReturns a map of each requested domain name to a boolean: true when the domain is available for purchase through Vee3, false when it is not.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "domains": { "description": "Domain names to check (maximum 10).", "items": { "type": "string" }, "maxItems": 10, "minItems": 1, "title": "Domains", "type": "array" } }, "required": [ "domains" ], "title": "check_domain_availabilityArguments", "type": "object" }, "name": "domains.check_availability", "outputSchema": { "additionalProperties": true, "properties": {}, "title": "DomainsAvailabilityResponse", "type": "object" } }, { "description": "Fetch DNS records for a domain.\n\nReturns an array of records. Each record includes name, ttl, type (for example A, AAAA, CNAME, MX, NS, SOA, TXT), and data (record value).\n\nOptionally pass subdomain to include records for a host under the domain (for example blog for blog.example.com).\n\nCost = 2 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to look up (for example example.com).", "maxLength": 253, "title": "Domain", "type": "string" }, "subdomain": { "anyOf": [ { "maxLength": 253, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional subdomain label to include (for example www or blog).", "title": "Subdomain" } }, "required": [ "domain" ], "title": "get_domain_dns_recordsArguments", "type": "object" }, "name": "domains.dns_records", "outputSchema": { "$defs": { "DomainsDnsRecordsResponseRecordsItem": { "additionalProperties": true, "properties": { "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Record value.", "title": "Data" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Record host name.", "title": "Name" }, "ttl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Time to live in seconds.", "title": "Ttl" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record type (A, AAAA, CNAME, MX, NS, SOA, TXT, …).", "title": "Type" } }, "title": "DomainsDnsRecordsResponseRecordsItem", "type": "object" } }, "additionalProperties": true, "properties": { "records": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsDnsRecordsResponseRecordsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "DNS records returned for the domain.", "title": "Records" } }, "title": "DomainsDnsRecordsResponse", "type": "object" } }, { "description": "List DNS host records for one domain this Vee3 account manages.\n\nUse for managed Namecheap DNS only. For public DNS lookup of any domain, use domains.dns_records instead.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "domain": { "description": "Managed domain name (for example example.com).", "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "get_dns_hostsArguments", "type": "object" }, "name": "domains.get_dns_hosts", "outputSchema": { "$defs": { "DomainsGetDnsHostsResponseHostsItem": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Record value.", "title": "Address" }, "host_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap host record id.", "title": "Host Id" }, "host_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Host label, for example @ or www.", "title": "Host Name" }, "mx_pref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MX preference when record_type is MX or MXE.", "title": "Mx Pref" }, "record_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record type.", "title": "Record Type" }, "ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "TTL in seconds.", "title": "Ttl" } }, "title": "DomainsGetDnsHostsResponseHostsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Managed domain name.", "title": "Domain" }, "hosts": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsGetDnsHostsResponseHostsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "DNS host records. Each item includes host_id, host_name, record_type, address, optional mx_pref, and optional ttl.", "title": "Hosts" }, "is_using_namecheap_dns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain currently uses Namecheap DNS.", "title": "Is Using Namecheap Dns" } }, "title": "DomainsGetDnsHostsResponse", "type": "object" } }, { "description": "Get full details for one domain this Vee3 account owns or manages.\n\nReturns registration status, expiration, privacy, DNS provider type, and registration metadata.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "domain": { "description": "Managed domain name to look up (for example example.com).", "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "get_managed_domainArguments", "type": "object" }, "name": "domains.get_managed", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the domain was registered through Vee3.", "title": "Created At" }, "dns_provider_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS provider type configured for the domain.", "title": "Dns Provider Type" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Managed domain name.", "title": "Domain" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain expiration timestamp.", "title": "Expires At" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether registrar transfer lock is enabled.", "title": "Is Locked" }, "is_owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this Vee3 account is the domain owner.", "title": "Is Owner" }, "is_premium": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain was registered as a premium name.", "title": "Is Premium" }, "namecheap_domain_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap domain identifier for the managed domain.", "title": "Namecheap Domain Id" }, "privacy_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether WhoisGuard privacy protection is enabled.", "title": "Privacy Enabled" }, "privacy_expired_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When privacy protection expired, if applicable.", "title": "Privacy Expired At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current domain status in Vee3 inventory.", "title": "Status" }, "token_cost_at_registration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens charged when the domain was registered.", "title": "Token Cost At Registration" }, "years_registered": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Registration term in years at purchase.", "title": "Years Registered" } }, "title": "DomainsGetManagedResponse", "type": "object" } }, { "description": "List domains this Vee3 account owns or manages (registered through Vee3).\n\nReturns domain status, registration dates, lock and privacy settings, and paging metadata.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "limit": { "default": 50, "description": "Maximum number of domains to return.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "page": { "default": 1, "description": "Page number for paginated results.", "minimum": 1, "title": "Page", "type": "integer" } }, "title": "list_managed_domainsArguments", "type": "object" }, "name": "domains.list_managed", "outputSchema": { "$defs": { "DomainsListManagedResponseDomainsItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the domain was registered through Vee3.", "title": "Created At" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Managed domain name.", "title": "Domain" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain expiration timestamp.", "title": "Expires At" }, "is_locked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether registrar transfer lock is enabled.", "title": "Is Locked" }, "privacy_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether WhoisGuard privacy protection is enabled.", "title": "Privacy Enabled" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current domain status in Vee3 inventory.", "title": "Status" }, "years_registered": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Registration term in years at purchase.", "title": "Years Registered" } }, "title": "DomainsListManagedResponseDomainsItem", "type": "object" }, "DomainsListManagedResponsePaging": { "additionalProperties": true, "properties": { "current_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current page number.", "title": "Current Page" }, "page_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of domains returned per page.", "title": "Page Size" }, "total_items": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total managed domains matching the query.", "title": "Total Items" } }, "title": "DomainsListManagedResponsePaging", "type": "object" } }, "additionalProperties": true, "properties": { "domains": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsListManagedResponseDomainsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Managed domains for this Vee3 account.", "title": "Domains" }, "paging": { "anyOf": [ { "$ref": "#/$defs/DomainsListManagedResponsePaging" }, { "type": "null" } ], "default": null, "description": "Pagination metadata for the result set." } }, "title": "DomainsListManagedResponse", "type": "object" } }, { "description": "List or search top-level domains (TLDs) with registry metadata.\n\nFilter by substring search, availability phase, TLD category, and paginate with limit and page. limit defaults to 100 when omitted. Each result includes the TLD suffix, type, availability phase, WHOIS server, domain counts when known, registry organization details, and created/changed timestamps.\n\navailability values: general-availability (open for normal registration) or sunrise (trademark sunrise period before general availability).\n\nCost = 2 tokens.", "inputSchema": { "properties": { "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by registration phase: general-availability (normal public registration) or sunrise (early trademark-holder period).", "title": "Availability" }, "limit": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of TLDs to return. Defaults to 100 when omitted.", "title": "Limit" }, "page": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Page number for paginated results.", "title": "Page" }, "search": { "anyOf": [ { "maxLength": 63, "type": "string" }, { "type": "null" } ], "default": null, "description": "Return TLDs whose suffix contains this substring.", "title": "Search" }, "tld_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by TLD category: country-code, generic, generic-restricted, infrastructure, or sponsored.", "title": "Tld Type" } }, "title": "list_domain_tldsArguments", "type": "object" }, "name": "domains.list_tlds", "outputSchema": { "$defs": { "DomainsTldsResponseTldsItem": { "additionalProperties": true, "properties": { "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registration phase for the TLD. Null on unfiltered list results when the upstream registry has not published phase metadata.", "title": "Availability" }, "changed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD record last changed timestamp.", "title": "Changed" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD delegation created timestamp.", "title": "Created" }, "domains_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Approximate registered domain count when reported by the registry.", "title": "Domains Count" }, "level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "TLD level (1 for standard TLDs).", "title": "Level" }, "organization": { "anyOf": [ { "$ref": "#/$defs/DomainsTldsResponseTldsItemOrganization" }, { "type": "null" } ], "default": null, "description": "Registry operator contact details." }, "tld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD suffix without a leading dot (for example com).", "title": "Tld" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD category (for example country-code or generic). Null when the upstream registry has not classified the TLD.", "title": "Type" }, "whois_server": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authoritative WHOIS server host name.", "title": "Whois Server" } }, "title": "DomainsTldsResponseTldsItem", "type": "object" }, "DomainsTldsResponseTldsItemOrganization": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry operator postal address.", "title": "Address" }, "organisation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry operator name.", "title": "Organisation" } }, "title": "DomainsTldsResponseTldsItemOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "tlds": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsTldsResponseTldsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Matching top-level domain records.", "title": "Tlds" } }, "title": "DomainsTldsResponse", "type": "object" } }, { "description": "Look up a domain and return normalized registration details.\n\nCombines registry and registrar RDAP and WHOIS sources to return the most accurate normalized fields across TLDs: availability, domain status, created/updated/expiry dates, registrar data, contact records, and nameservers.\n\nUse this when you need registrant-oriented summary data rather than raw WHOIS or RDAP payloads.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to look up (for example example.com).", "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "get_domain_lookupArguments", "type": "object" }, "name": "domains.lookup", "outputSchema": { "$defs": { "DomainsLookupResponseContacts": { "additionalProperties": true, "properties": { "admin": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseContactsAdmin" }, { "type": "null" } ], "default": null, "description": "Administrative contact details." }, "billing": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseContactsBilling" }, { "type": "null" } ], "default": null, "description": "Billing contact details." }, "registrant": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseContactsRegistrant" }, { "type": "null" } ], "default": null, "description": "Registrant contact details." }, "tech": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseContactsTech" }, { "type": "null" } ], "default": null, "description": "Technical contact details." } }, "title": "DomainsLookupResponseContacts", "type": "object" }, "DomainsLookupResponseContactsAdmin": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact email address.", "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact name.", "title": "Name" } }, "title": "DomainsLookupResponseContactsAdmin", "type": "object" }, "DomainsLookupResponseContactsBilling": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact email address.", "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact name.", "title": "Name" } }, "title": "DomainsLookupResponseContactsBilling", "type": "object" }, "DomainsLookupResponseContactsRegistrant": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact email address.", "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact name.", "title": "Name" }, "organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact organization.", "title": "Organization" } }, "title": "DomainsLookupResponseContactsRegistrant", "type": "object" }, "DomainsLookupResponseContactsTech": { "additionalProperties": true, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact email address.", "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact name.", "title": "Name" } }, "title": "DomainsLookupResponseContactsTech", "type": "object" }, "DomainsLookupResponseDates": { "additionalProperties": true, "properties": { "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain creation timestamp.", "title": "Created" }, "expiry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Expiration timestamp.", "title": "Expiry" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Last update timestamp.", "title": "Updated" } }, "title": "DomainsLookupResponseDates", "type": "object" }, "DomainsLookupResponseRegistrar": { "additionalProperties": true, "properties": { "ianaId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Registrar IANA identifier.", "title": "Ianaid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registrar name.", "title": "Name" } }, "title": "DomainsLookupResponseRegistrar", "type": "object" } }, "additionalProperties": true, "properties": { "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Availability state (for example registered or available).", "title": "Availability" }, "contacts": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseContacts" }, { "type": "null" } ], "default": null, "description": "Registrant, admin, tech, and billing contact records." }, "dates": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseDates" }, { "type": "null" } ], "default": null, "description": "Registration lifecycle dates." }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Looked-up domain name.", "title": "Domain" }, "keyword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Second-level domain label without the TLD.", "title": "Keyword" }, "nameservers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Authoritative nameserver host names.", "title": "Nameservers" }, "registrar": { "anyOf": [ { "$ref": "#/$defs/DomainsLookupResponseRegistrar" }, { "type": "null" } ], "default": null, "description": "Registrar summary data." }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary data source used for the normalized response.", "title": "Source" }, "status": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Normalized EPP status codes.", "title": "Status" }, "tld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Top-level domain suffix.", "title": "Tld" } }, "title": "DomainsLookupResponse", "type": "object" } }, { "description": "Analyze a domain with comprehensive SEO metrics, backlink data, and social signals.\n\nReturns authority metrics (Moz domain/page authority, Ahrefs domain rating, Majestic trust and citation flow), backlink profile counts (total backlinks, referring domains, EDU/GOV links), traffic and keyword estimates (organic traffic, traffic value, organic keywords, Ahrefs rank), social signals (Facebook shares/comments, Pinterest pins, StumbleUpon), and technical data (IP addresses, subnets, topical trust flow categories).\n\nCost = 40 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to analyze (for example example.com).", "maxLength": 253, "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "get_domain_metricsArguments", "type": "object" }, "name": "domains.metrics", "outputSchema": { "additionalProperties": true, "properties": { "FB_comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total Facebook comments.", "title": "Fb Comments" }, "FB_shares": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total Facebook shares.", "title": "Fb Shares" }, "ahrefsBacklinks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of backlinks from Ahrefs.", "title": "Ahrefsbacklinks" }, "ahrefsDR": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Ahrefs domain rating (0-100).", "title": "Ahrefsdr" }, "ahrefsOrganicKeywords": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of ranking organic keywords.", "title": "Ahrefsorganickeywords" }, "ahrefsRank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Global website ranking from Ahrefs.", "title": "Ahrefsrank" }, "ahrefsRefDomains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of unique referring domains from Ahrefs.", "title": "Ahrefsrefdomains" }, "ahrefsTraffic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Estimated monthly organic traffic.", "title": "Ahrefstraffic" }, "ahrefsTrafficValue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Estimated value of organic traffic.", "title": "Ahrefstrafficvalue" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Analyzed domain name.", "title": "Domain" }, "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the metrics snapshot was last updated.", "title": "Last Updated" }, "majesticCF": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Majestic citation flow score (0-100).", "title": "Majesticcf" }, "majesticLinks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total links from the Majestic database.", "title": "Majesticlinks" }, "majesticTF": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Majestic trust flow score (0-100).", "title": "Majestictf" }, "mozDA": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Moz domain authority score (0-100).", "title": "Mozda" }, "mozPA": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Moz page authority score (0-100).", "title": "Mozpa" }, "pinterest_pins": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total Pinterest saves.", "title": "Pinterest Pins" }, "stumbles": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total StumbleUpon shares.", "title": "Stumbles" } }, "title": "DomainsMetricsResponse", "type": "object" } }, { "description": "Look up raw RDAP (Registration Data Access Protocol) data for a domain.\n\nReturns registrar entities, domain status codes, registration and expiration events, nameservers, DNSSEC delegation data, RDAP conformance labels, and registry notices.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to look up (for example example.com).", "maxLength": 253, "title": "Domain", "type": "string" } }, "required": [ "domain" ], "title": "get_domain_rdapArguments", "type": "object" }, "name": "domains.rdap", "outputSchema": { "$defs": { "DomainsRdapResponseEntitiesItem": { "additionalProperties": true, "properties": { "objectClassName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "RDAP entity object class.", "title": "Objectclassname" } }, "title": "DomainsRdapResponseEntitiesItem", "type": "object" }, "DomainsRdapResponseEventsItem": { "additionalProperties": true, "properties": { "eventAction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Event type (for example registration or expiration).", "title": "Eventaction" }, "eventDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 event timestamp.", "title": "Eventdate" } }, "title": "DomainsRdapResponseEventsItem", "type": "object" }, "DomainsRdapResponseNameserversItem": { "additionalProperties": true, "properties": { "ldhName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Nameserver host name.", "title": "Ldhname" } }, "title": "DomainsRdapResponseNameserversItem", "type": "object" }, "DomainsRdapResponseSecureDNS": { "additionalProperties": true, "properties": { "delegationSigned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain is DNSSEC delegation-signed.", "title": "Delegationsigned" } }, "title": "DomainsRdapResponseSecureDNS", "type": "object" } }, "additionalProperties": true, "properties": { "entities": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsRdapResponseEntitiesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Registrar, registrant, and related RDAP entities.", "title": "Entities" }, "events": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsRdapResponseEventsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Registration, expiration, and last-changed timestamps.", "title": "Events" }, "ldhName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain name in LDH form.", "title": "Ldhname" }, "nameservers": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsRdapResponseNameserversItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Authoritative nameservers for the domain.", "title": "Nameservers" }, "objectClassName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "RDAP object class (for example domain).", "title": "Objectclassname" }, "secureDNS": { "anyOf": [ { "$ref": "#/$defs/DomainsRdapResponseSecureDNS" }, { "type": "null" } ], "default": null, "description": "DNSSEC delegation and DS record data." }, "status": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "EPP status codes for the domain.", "title": "Status" } }, "title": "DomainsRdapResponse", "type": "object" } }, { "description": "Register a domain through Vee3.\n\nThe user or agent passes registrant contact details and expected_token_cost from domains.registration_quote. Use a real registrant email address the domain owner can access; the registrar may send a verification email that must be completed to keep the domain in good standing. Charges the quoted token cost on success.\n\nCost = 200 tokens + domain registration price in tokens.", "inputSchema": { "properties": { "contact": { "additionalProperties": true, "description": "Registrant contact used for Registrant, Admin, Tech, and AuxBilling roles. Object with first_name, last_name, address1, city, state_province, postal_code, country (two-letter code), phone (format +NNN.NNNNNNNNNN), and email_address (a real inbox the registrant can access; the registrar may send a verification email that must be completed). Optional fields: address2 and organization_name.", "title": "Contact", "type": "object" }, "domain": { "description": "Domain name to register (for example example.com).", "title": "Domain", "type": "string" }, "enable_privacy": { "default": true, "description": "Whether to enable free WhoisGuard privacy protection when available.", "title": "Enable Privacy", "type": "boolean" }, "expected_token_cost": { "description": "Token cost from a fresh domains.registration_quote response. Required to prevent surprise charges.", "title": "Expected Token Cost", "type": "integer" }, "years": { "default": 1, "description": "Registration term in years.", "maximum": 10, "minimum": 1, "title": "Years", "type": "integer" } }, "required": [ "domain", "expected_token_cost", "contact" ], "title": "register_domainArguments", "type": "object" }, "name": "domains.register", "outputSchema": { "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registered domain name.", "title": "Domain" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Domain expiration timestamp when known.", "title": "Expires At" }, "namecheap_domain_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap domain identifier for the managed domain.", "title": "Namecheap Domain Id" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap order identifier for the registration purchase.", "title": "Order Id" }, "privacy_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether WhoisGuard privacy protection is enabled.", "title": "Privacy Enabled" }, "registered": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether registration completed successfully.", "title": "Registered" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens charged for this registration (200 service tokens plus the domain price in tokens).", "title": "Token Cost" }, "years": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Registration term in years.", "title": "Years" } }, "title": "DomainsRegisterResponse", "type": "object" } }, { "description": "Quote registration cost in tokens for one domain and year count.\n\nQuoted cost is 200 service tokens plus the domain registration price in tokens. Token conversion depends on the account billing plan. Use before domains.register.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to quote (for example example.com).", "title": "Domain", "type": "string" }, "years": { "default": 1, "description": "Registration term in years.", "maximum": 10, "minimum": 1, "title": "Years", "type": "integer" } }, "required": [ "domain" ], "title": "get_domain_registration_quoteArguments", "type": "object" }, "name": "domains.registration_quote", "outputSchema": { "additionalProperties": true, "properties": { "available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain can be registered through Vee3.", "title": "Available" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted domain name.", "title": "Domain" }, "is_premium": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain is priced as a premium name.", "title": "Is Premium" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token cost to register this domain for the quoted term on the account billing plan (200 service tokens plus the domain price).", "title": "Token Cost" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason the domain cannot be registered, when available is false.", "title": "Unavailable Reason" }, "years": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Registration term in years.", "title": "Years" } }, "title": "DomainsRegistrationQuoteResponse", "type": "object" } }, { "description": "Remove one DNS host record from a managed domain by host_id.\n\nPreserves all other records. Get host_id from domains.get_dns_hosts. The domain must use Namecheap DNS.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "domain": { "description": "Managed domain name (for example example.com).", "title": "Domain", "type": "string" }, "host_id": { "description": "Host record id from domains.get_dns_hosts.", "title": "Host Id", "type": "string" } }, "required": [ "domain", "host_id" ], "title": "remove_dns_hostArguments", "type": "object" }, "name": "domains.remove_dns_host", "outputSchema": { "$defs": { "DomainsRemoveDnsHostResponseHostsItem": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Record value.", "title": "Address" }, "host_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap host record id.", "title": "Host Id" }, "host_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Host label, for example @ or www.", "title": "Host Name" }, "mx_pref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MX preference when record_type is MX or MXE.", "title": "Mx Pref" }, "record_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record type.", "title": "Record Type" }, "ttl": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "TTL in seconds.", "title": "Ttl" } }, "title": "DomainsRemoveDnsHostResponseHostsItem", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Managed domain name.", "title": "Domain" }, "hosts": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsRemoveDnsHostResponseHostsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Full DNS host list after the removal.", "title": "Hosts" }, "is_using_namecheap_dns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain currently uses Namecheap DNS.", "title": "Is Using Namecheap Dns" } }, "title": "DomainsRemoveDnsHostResponse", "type": "object" } }, { "description": "Renew a domain already managed through this Vee3 account.\n\nThe user or agent passes expected_token_cost from domains.renewal_quote. Charges the quoted token cost on success. Premium domains can only be renewed for 1 year at a time.\n\nCost = 100 tokens + domain renewal price in tokens.", "inputSchema": { "properties": { "domain": { "description": "Managed domain name to renew (for example example.com).", "title": "Domain", "type": "string" }, "expected_token_cost": { "description": "Token cost from a fresh domains.renewal_quote response. Required to prevent surprise charges.", "title": "Expected Token Cost", "type": "integer" }, "years": { "default": 1, "description": "Renewal term in years. Premium domains support 1 year only.", "maximum": 10, "minimum": 1, "title": "Years", "type": "integer" } }, "required": [ "domain", "expected_token_cost" ], "title": "renew_domainArguments", "type": "object" }, "name": "domains.renew", "outputSchema": { "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Renewed domain name.", "title": "Domain" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated domain expiration timestamp when known.", "title": "Expires At" }, "namecheap_domain_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap domain identifier for the managed domain.", "title": "Namecheap Domain Id" }, "order_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Namecheap order identifier for the renewal purchase.", "title": "Order Id" }, "renewed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether renewal completed successfully.", "title": "Renewed" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens charged for this renewal (100 service tokens plus the domain renewal price in tokens).", "title": "Token Cost" }, "years": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Renewal term in years.", "title": "Years" } }, "title": "DomainsRenewResponse", "type": "object" } }, { "description": "Quote renewal cost in tokens for one managed domain and year count.\n\nOnly works for domains already managed by this Vee3 account. Quoted cost is 100 service tokens plus the domain renewal price in tokens. Token conversion depends on the account billing plan. Use before domains.renew. Premium domains can only be renewed for 1 year at a time.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "domain": { "description": "Managed domain name to quote for renewal (for example example.com).", "title": "Domain", "type": "string" }, "years": { "default": 1, "description": "Renewal term in years. Premium domains support 1 year only.", "maximum": 10, "minimum": 1, "title": "Years", "type": "integer" } }, "required": [ "domain" ], "title": "get_domain_renewal_quoteArguments", "type": "object" }, "name": "domains.renewal_quote", "outputSchema": { "additionalProperties": true, "properties": { "available": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain can be renewed through Vee3 for the quoted term.", "title": "Available" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted domain name.", "title": "Domain" }, "is_premium": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the domain is priced as a premium name.", "title": "Is Premium" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Token cost to renew this domain for the quoted term on the account billing plan (100 service tokens plus the domain price).", "title": "Token Cost" }, "unavailable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reason the domain cannot be renewed, when available is false.", "title": "Unavailable Reason" }, "years": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Renewal term in years.", "title": "Years" } }, "title": "DomainsRenewalQuoteResponse", "type": "object" } }, { "description": "Look up detailed registry information for a single top-level domain (TLD).\n\nReturns status, TLD type, availability phase, WHOIS and RDAP servers, registry URL, domain counts, delegation dates, registry organization, administrative/technical contacts, and remarks.\n\nPass the TLD suffix without a leading dot (for example io or com).\n\nCost = 1 token.", "inputSchema": { "properties": { "tld": { "description": "TLD suffix to look up without a leading dot (for example io).", "maxLength": 63, "title": "Tld", "type": "string" } }, "required": [ "tld" ], "title": "get_domain_tld_detailsArguments", "type": "object" }, "name": "domains.tld_details", "outputSchema": { "$defs": { "DomainsTldDetailsResponseContactsItem": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact postal address.", "title": "Address" }, "contact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact role (for example administrative or technical).", "title": "Contact" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact name.", "title": "Name" }, "organisation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact organization name.", "title": "Organisation" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact phone number.", "title": "Phone" } }, "title": "DomainsTldDetailsResponseContactsItem", "type": "object" }, "DomainsTldDetailsResponseOrganization": { "additionalProperties": true, "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry operator postal address.", "title": "Address" }, "organisation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry operator name.", "title": "Organisation" } }, "title": "DomainsTldDetailsResponseOrganization", "type": "object" } }, "additionalProperties": true, "properties": { "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registration phase for the TLD.", "title": "Availability" }, "changed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD record last changed timestamp.", "title": "Changed" }, "contacts": { "anyOf": [ { "items": { "$ref": "#/$defs/DomainsTldDetailsResponseContactsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Registry contact records.", "title": "Contacts" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD delegation created timestamp.", "title": "Created" }, "domains_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Approximate registered domain count when reported by the registry.", "title": "Domains Count" }, "level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "TLD level (1 for standard TLDs).", "title": "Level" }, "organization": { "anyOf": [ { "$ref": "#/$defs/DomainsTldDetailsResponseOrganization" }, { "type": "null" } ], "default": null, "description": "Registry operator contact details." }, "rdap_server": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authoritative RDAP server URL.", "title": "Rdap Server" }, "registry_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry web site URL.", "title": "Registry Url" }, "remarks": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Additional registry notes or links.", "title": "Remarks" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Delegation status (for example ACTIVE).", "title": "Status" }, "tld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD suffix without a leading dot.", "title": "Tld" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TLD category (for example country-code or generic).", "title": "Type" }, "whois_server": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Authoritative WHOIS server host name.", "title": "Whois Server" } }, "title": "DomainsTldDetailsResponse", "type": "object" } }, { "description": "Fetch WHOIS registration data for a domain.\n\nReturns a JSON object keyed by WHOIS server host name. Each value contains parsed fields such as Domain Name, registrar details, dates, name servers, domain status, DNSSEC data, and raw text lines.\n\nSet include_registrar to true to query registry and registrar servers (slower, more complete). Default false queries the registry server only.\n\nCost = 4 tokens.", "inputSchema": { "properties": { "domain": { "description": "Domain name to look up (for example example.com).", "title": "Domain", "type": "string" }, "include_registrar": { "default": false, "description": "When true, query registry and registrar WHOIS servers for more complete data. When false (default), query the registry server only.", "title": "Include Registrar", "type": "boolean" } }, "required": [ "domain" ], "title": "get_domain_whoisArguments", "type": "object" }, "name": "domains.whois", "outputSchema": { "additionalProperties": true, "properties": {}, "title": "DomainsWhoisResponse", "type": "object" } }, { "description": "Permanently delete a file from the authenticated account's upload storage.\n\nPass file_name from files.list_uploaded_files. The file is removed from storage and any linked upload session is marked expired.\n\nCost = 0 tokens.", "inputSchema": { "properties": { "file_name": { "description": "Relative file name or path to delete. Use files.list_uploaded_files to see available names.", "maxLength": 255, "title": "File Name", "type": "string" } }, "required": [ "file_name" ], "title": "delete_fileArguments", "type": "object" }, "name": "files.delete_file", "outputSchema": { "additionalProperties": true, "properties": { "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted file name.", "title": "File Name" } }, "title": "DeleteFileResponse", "type": "object" } }, { "description": "Reserve a direct download for a previously uploaded file.\n\nPass the file_name from files.list_uploaded_files (paths such as folder/subfolder/name.ext are supported). Vee3 returns a download_code.\n\nInstall the Vee3 CLI once with `npm install -g @vee3/cli` (requires Node 18+), then run `vee3-get-file {download_code} ./path/to/save` in the terminal. The CLI does not need an API key.\n\nIf installation fails with a TLS or certificate error (common on networks that inspect HTTPS traffic), use Node 22.15 or newer and run with NODE_OPTIONS=--use-system-ca, or configure npm to trust your network's root certificate.\n\nDownload codes can be resolved within 60 minutes of reserve.\n\nCost = 0 tokens.", "inputSchema": { "properties": { "file_name": { "description": "Relative file name or path to download. Use files.list_uploaded_files to see available names.", "maxLength": 255, "title": "File Name", "type": "string" } }, "required": [ "file_name" ], "title": "download_fileArguments", "type": "object" }, "name": "files.download_file", "outputSchema": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type on the stored object when known.", "title": "Content Type" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/get-file CLI.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved download.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stored file name.", "title": "File Name" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Object size in bytes when known.", "title": "Size Bytes" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "DownloadFileResponse", "type": "object" } }, { "description": "Extend retention for a file that was uploaded with files.upload_file and appears in files.list_uploaded_files with retained_until.\n\nAdds additional_retention_days to the current schedule (or from now if retention already expired). Only files with a completed upload session and retention metadata can be extended.\n\nCost = max(1, ceil(size_gibibytes * additional_retention_days * 2)) tokens.", "inputSchema": { "properties": { "additional_retention_days": { "description": "Days to add to the file's retention schedule.", "maximum": 90, "minimum": 1, "title": "Additional Retention Days", "type": "integer" }, "file_name": { "description": "Relative file name or path to extend. Use files.list_uploaded_files and choose a file that includes retained_until.", "maxLength": 255, "title": "File Name", "type": "string" } }, "required": [ "file_name", "additional_retention_days" ], "title": "extend_fileArguments", "type": "object" }, "name": "files.extend_file", "outputSchema": { "additionalProperties": true, "properties": { "additional_retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days added in this request.", "title": "Additional Retention Days" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Extended file name.", "title": "File Name" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the file is now scheduled to be removed.", "title": "Retained Until" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "File size in bytes used for billing.", "title": "Size Bytes" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens billed for this extension.", "title": "Token Cost" } }, "title": "ExtendFileResponse", "type": "object" } }, { "description": "List files currently stored for the authenticated Vee3 account.\n\nReturns file_name (including any folders), content_type, size_bytes, uploaded_at, and retained_until when known. Use file_name to reference a file in other capabilities.\n\nOptional folder limits results to that folder path and its subfolders (for example media/clips).\n\nretained_until is when the file will be removed (based on retention_days at upload).\n\nCost = 0 tokens.", "inputSchema": { "properties": { "folder": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional folder path (for example media/clips). When set, only files under that folder (including nested subfolders) are returned. Do not use '..' or absolute paths.", "title": "Folder" } }, "title": "list_uploaded_filesArguments", "type": "object" }, "name": "files.list_uploaded_files", "outputSchema": { "$defs": { "ListUploadedFilesResponseFilesItem": { "additionalProperties": true, "properties": { "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type of the file.", "title": "Content Type" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stored file name, including folders when used (for example media/clips/launch-video.mp4).", "title": "File Name" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the file is scheduled to be removed. Present when Vee3 matched the file to a completed upload session.", "title": "Retained Until" }, "size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "File size in bytes.", "title": "Size Bytes" }, "upload_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upload session identifier when Vee3 can match this file to a prior files.upload_file reservation.", "title": "Upload Id" }, "uploaded_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the file was uploaded.", "title": "Uploaded At" } }, "title": "ListUploadedFilesResponseFilesItem", "type": "object" } }, "additionalProperties": true, "properties": { "files": { "anyOf": [ { "items": { "$ref": "#/$defs/ListUploadedFilesResponseFilesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files currently stored for the authenticated account, newest first.", "title": "Files" } }, "title": "ListUploadedFilesResponse", "type": "object" } }, { "description": "Move a stored file to a new account-relative path.\n\nPass source_file_name from files.list_uploaded_files and the desired destination_file_name. The file is copied to the new path and the source is removed. Any linked upload session is updated to the new path.\n\nCost = 0 tokens.", "inputSchema": { "properties": { "destination_file_name": { "description": "New relative file name or path. Must not already exist in account storage.", "maxLength": 255, "title": "Destination File Name", "type": "string" }, "source_file_name": { "description": "Current relative file name or path. Use files.list_uploaded_files to see available names.", "maxLength": 255, "title": "Source File Name", "type": "string" } }, "required": [ "source_file_name", "destination_file_name" ], "title": "move_fileArguments", "type": "object" }, "name": "files.move_file", "outputSchema": { "additionalProperties": true, "properties": { "destination_file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "New file name after the move.", "title": "Destination File Name" }, "source_file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Previous file name.", "title": "Source File Name" } }, "title": "MoveFileResponse", "type": "object" } }, { "description": "Reserve a direct upload slot for a local file or folder.\n\nPass the desired file_name. For a single file, this becomes the stored name. For a folder, this becomes the destination folder prefix. To nest further, use a path in file_name (folder/subfolder/.../name). Optionally pass retention_days (default 7, minimum 1). The name may omit an extension. Vee3 returns an upload_code.\n\nInstall the Vee3 CLI once with `npm install -g @vee3/cli` (requires Node 18+), then run `vee3-upload {upload_code} {file_or_folder_path}` in the terminal. The CLI accepts a file or a folder. A folder uploads every nested file in one command and stores each file under the reserved file_name prefix, preserving relative paths. The CLI resolves the code to signed upload URLs, streams the local file or files to Vee3 storage, and prints each stored file_name after the upload finishes. Use those file_name values in files.list_uploaded_files and other capabilities. The CLI does not need an API key. When a stored file already uses the same name, the upload stops, skips that file, or replaces it.\n\nIf installation fails with a TLS or certificate error (common on networks that inspect HTTPS traffic), use Node 22.15 or newer and run with NODE_OPTIONS=--use-system-ca, or configure npm to trust your network's root certificate.\n\nEach file can be up to 2 GB. One folder upload can include up to 500 files. Retention is chosen at reserve time (default 7 days) and applies to every file in the folder. After each upload is detected, Vee3 bills `max(1, ceil(size_gibibytes * retention_days * 2))` tokens per file. Upload codes can be resolved within 60 minutes of reserve.\n\nUse `files.list_uploaded_files` to list stored uploads for follow-up work.\n\nCost = 0 tokens to reserve. After upload completes, billing is max(1, ceil(size_gibibytes * retention_days * 2)) tokens.", "inputSchema": { "properties": { "existing_files": { "anyOf": [ { "enum": [ "stop", "continue", "replace" ], "type": "string" }, { "type": "null" } ], "default": "stop", "description": "What to do when a stored file already uses the same name. 'stop' (default) fails on the first duplicate. 'continue' skips duplicates and keeps uploading remaining files. 'replace' overwrites duplicated stored files.", "title": "Existing Files" }, "file_name": { "description": "Desired file name or path for the uploaded file. Use folder/subfolder/.../file_name to organize files in folders. Extension is optional and is replaced based on detected file type. Do not use '..' or absolute paths.", "maxLength": 255, "title": "File Name", "type": "string" }, "retention_days": { "anyOf": [ { "maximum": 90, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": 7, "description": "How many days to keep the file after upload completes. Default 7. Billing uses size and this retention.", "title": "Retention Days" } }, "required": [ "file_name" ], "title": "upload_fileArguments", "type": "object" }, "name": "files.upload_file", "outputSchema": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for uploading the local file or folder.", "title": "Command" }, "existing_files": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Policy for files that already exist: stop, continue, or replace.", "title": "Existing Files" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the upload code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "max_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum allowed file size in bytes.", "title": "Max Bytes" }, "retention_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days the file will be retained after upload completes.", "title": "Retention Days" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or uploading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" }, "upload_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/upload CLI.", "title": "Upload Code" }, "upload_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved upload.", "title": "Upload Id" } }, "title": "UploadFileResponse", "type": "object" } }, { "description": "List supported language codes for Google Maps place endpoints.\n\nReturns languages as a map of language names to codes (for example English: en). Use these codes with the language parameter on place detail, review, and photo calls.\n\nCost = 1 token.", "inputSchema": { "properties": {}, "title": "get_google_maps_languagesArguments", "type": "object" }, "name": "google-maps.languages", "outputSchema": { "$defs": { "GoogleMapsLanguagesResponseLanguages": { "additionalProperties": true, "properties": {}, "title": "GoogleMapsLanguagesResponseLanguages", "type": "object" } }, "additionalProperties": true, "properties": { "languages": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsLanguagesResponseLanguages" }, { "type": "null" } ], "default": null, "description": "Map of language names to language codes for Google Maps place endpoints (for example English: en)." } }, "title": "GoogleMapsLanguagesResponse", "type": "object" } }, { "description": "Search for places near a latitude and longitude.\n\nRequired: location. Optional: radius (defaults to 1000 meters when sort_by is Relevance), keyword, place_type, open_now, min_price, max_price, language, region, and cursor. When sort_by is Distance, omit radius and provide keyword or place_type. Pass cursor from a previous cursor_next to fetch the next page.\n\nReturns matching places in places. Use place_id with place detail, review, and photo endpoints.\n\ncursor_next and cursor_previous appear only when pagination cursors are available. Additional upstream fields may appear.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursor_next on a previous response.", "title": "Cursor" }, "keyword": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "default": null, "description": "Keyword to match nearby places (for example restaurant).", "title": "Keyword" }, "language": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for results (for example en).", "title": "Language" }, "location": { "description": "Latitude and longitude of the search point (for example 40,-110).", "maxLength": 64, "title": "Location", "type": "string" }, "max_price": { "anyOf": [ { "maximum": 4, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum price level (0–4, inclusive).", "title": "Max Price" }, "min_price": { "anyOf": [ { "maximum": 4, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Minimum price level (0–4, inclusive).", "title": "Min Price" }, "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, return only places open for business at query time.", "title": "Open Now" }, "place_type": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Restrict results to a single Google Maps place type (for example restaurant).", "title": "Place Type" }, "radius": { "anyOf": [ { "maximum": 50000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Search radius in meters (default 1000).", "title": "Radius" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.", "title": "Region" }, "sort_by": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Result ordering: \"Relevance\" (default) or \"Distance\".", "title": "Sort By" } }, "required": [ "location" ], "title": "search_google_maps_nearbyArguments", "type": "object" }, "name": "google-maps.nearby_search", "outputSchema": { "$defs": { "GoogleMapsNearbySearchResponsePlacesItem": { "additionalProperties": true, "properties": { "business_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Operational status when available.", "title": "Business Status" }, "full_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full formatted address when available.", "title": "Full Address" }, "hours": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsNearbySearchResponsePlacesItemHours" }, { "type": "null" } ], "default": null, "description": "Opening hours when available." }, "location": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsNearbySearchResponsePlacesItemLocation" }, { "type": "null" } ], "default": null, "description": "Place coordinates when available." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place display name.", "title": "Name" }, "place_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Google Maps place identifier.", "title": "Place Id" }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average user rating when available.", "title": "Rating" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable open/closed status when available.", "title": "Status" }, "types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Place type labels when available.", "title": "Types" } }, "title": "GoogleMapsNearbySearchResponsePlacesItem", "type": "object" }, "GoogleMapsNearbySearchResponsePlacesItemHours": { "additionalProperties": true, "properties": { "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the place is open now when only open_now is available.", "title": "Open Now" } }, "title": "GoogleMapsNearbySearchResponsePlacesItemHours", "type": "object" }, "GoogleMapsNearbySearchResponsePlacesItemLocation": { "additionalProperties": true, "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place latitude.", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place longitude.", "title": "Longitude" } }, "title": "GoogleMapsNearbySearchResponsePlacesItemLocation", "type": "object" } }, "additionalProperties": true, "properties": { "cursor_next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page when more results are available.", "title": "Cursor Next" }, "cursor_previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the previous page when available.", "title": "Cursor Previous" }, "places": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleMapsNearbySearchResponsePlacesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Nearby places matching the search criteria. Additional upstream fields may appear.", "title": "Places" } }, "title": "GoogleMapsNearbySearchResponse", "type": "object" } }, { "description": "Get detailed information for a Google Maps place.\n\nProvide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional region and language are supported.\n\nReturns a flat place object with fields such as name, full_address, location, hours, status, rating, review_count, website, phone_number, and types when available. Additional upstream fields may appear.\n\nCost = 4 tokens.", "inputSchema": { "properties": { "language": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for results (for example en).", "title": "Language" }, "place_id": { "description": "Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).", "maxLength": 256, "title": "Place Id", "type": "string" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.", "title": "Region" } }, "required": [ "place_id" ], "title": "get_google_maps_place_detailsArguments", "type": "object" }, "name": "google-maps.place_details", "outputSchema": { "$defs": { "GoogleMapsPlaceDetailsResponseHours": { "additionalProperties": true, "properties": { "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the place is open now when only open_now is available.", "title": "Open Now" } }, "title": "GoogleMapsPlaceDetailsResponseHours", "type": "object" }, "GoogleMapsPlaceDetailsResponseLocation": { "additionalProperties": true, "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place latitude.", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place longitude.", "title": "Longitude" } }, "title": "GoogleMapsPlaceDetailsResponseLocation", "type": "object" } }, "additionalProperties": true, "properties": { "full_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full formatted address when available.", "title": "Full Address" }, "hours": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlaceDetailsResponseHours" }, { "type": "null" } ], "default": null, "description": "Opening hours when available." }, "location": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlaceDetailsResponseLocation" }, { "type": "null" } ], "default": null, "description": "Place coordinates when available." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place display name.", "title": "Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place phone number when available.", "title": "Phone Number" }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average user rating when available.", "title": "Rating" }, "review_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of reviews when available.", "title": "Review Count" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable open/closed status when available.", "title": "Status" }, "types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Place type labels when available.", "title": "Types" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place website when available.", "title": "Website" } }, "title": "GoogleMapsPlaceDetailsResponse", "type": "object" } }, { "description": "Get photos for a Google Maps place.\n\nProvide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional cursor, region, and language are supported. Pass cursor from a previous cursor_next to fetch the next page.\n\nReturns place metadata and a photos array. Each photo has photo_url and description when available. cursor_next appears only when a pagination cursor is available. Additional upstream fields may appear.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursor_next on a previous response.", "title": "Cursor" }, "language": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for results (for example en).", "title": "Language" }, "place_id": { "description": "Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).", "maxLength": 256, "title": "Place Id", "type": "string" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.", "title": "Region" } }, "required": [ "place_id" ], "title": "get_google_maps_place_photosArguments", "type": "object" }, "name": "google-maps.place_photos", "outputSchema": { "$defs": { "GoogleMapsPlacePhotosResponsePhotosItem": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Photo description when available.", "title": "Description" }, "photo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Photo URL.", "title": "Photo Url" } }, "title": "GoogleMapsPlacePhotosResponsePhotosItem", "type": "object" }, "GoogleMapsPlacePhotosResponsePlace": { "additionalProperties": true, "properties": { "full_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full formatted address when available.", "title": "Full Address" }, "hours": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlacePhotosResponsePlaceHours" }, { "type": "null" } ], "default": null, "description": "Opening hours when available." }, "location": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlacePhotosResponsePlaceLocation" }, { "type": "null" } ], "default": null, "description": "Place coordinates when available." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place display name.", "title": "Name" }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average user rating when available.", "title": "Rating" }, "review_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of reviews when available.", "title": "Review Count" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable open/closed status when available.", "title": "Status" } }, "title": "GoogleMapsPlacePhotosResponsePlace", "type": "object" }, "GoogleMapsPlacePhotosResponsePlaceHours": { "additionalProperties": true, "properties": { "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the place is open now when only open_now is available.", "title": "Open Now" } }, "title": "GoogleMapsPlacePhotosResponsePlaceHours", "type": "object" }, "GoogleMapsPlacePhotosResponsePlaceLocation": { "additionalProperties": true, "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place latitude.", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place longitude.", "title": "Longitude" } }, "title": "GoogleMapsPlacePhotosResponsePlaceLocation", "type": "object" } }, "additionalProperties": true, "properties": { "cursor_next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page when more results are available.", "title": "Cursor Next" }, "photos": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleMapsPlacePhotosResponsePhotosItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Place photos.", "title": "Photos" }, "place": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlacePhotosResponsePlace" }, { "type": "null" } ], "default": null, "description": "Place metadata for the photo listing." } }, "title": "GoogleMapsPlacePhotosResponse", "type": "object" } }, { "description": "Get reviews for a Google Maps place.\n\nProvide place_id from search results. The identifier also accepts the business identifier form (0x...:0x...). Optional sort_by (Relevant, Lowest, Highest, Newest), cursor, region, and language are supported. Pass cursor from a previous cursor_next to fetch the next page.\n\nReturns place metadata and a reviews array. Each review includes fields such as review_id, review_text, rating, and user_name. cursor_next appears only when a pagination cursor is available. Additional upstream fields may appear.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursor_next on a previous response.", "title": "Cursor" }, "language": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for results (for example en).", "title": "Language" }, "place_id": { "description": "Google Maps place identifier (for example ChIJk_grnPDq9EcRE7gOH9gAPZA). Also accepts the business identifier form (for example 0x47f4eb87e91f866d:0x9629fabb993eb66).", "maxLength": 256, "title": "Place Id", "type": "string" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.", "title": "Region" }, "sort_by": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Review sort order: \"Relevant\" (default), \"Lowest\", \"Highest\", or \"Newest\".", "title": "Sort By" } }, "required": [ "place_id" ], "title": "get_google_maps_place_reviewsArguments", "type": "object" }, "name": "google-maps.place_reviews", "outputSchema": { "$defs": { "GoogleMapsPlaceReviewsResponsePlace": { "additionalProperties": true, "properties": { "full_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full formatted address when available.", "title": "Full Address" }, "hours": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlaceReviewsResponsePlaceHours" }, { "type": "null" } ], "default": null, "description": "Opening hours when available." }, "location": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlaceReviewsResponsePlaceLocation" }, { "type": "null" } ], "default": null, "description": "Place coordinates when available." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place display name.", "title": "Name" }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average user rating when available.", "title": "Rating" }, "review_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of reviews when available.", "title": "Review Count" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable open/closed status when available.", "title": "Status" } }, "title": "GoogleMapsPlaceReviewsResponsePlace", "type": "object" }, "GoogleMapsPlaceReviewsResponsePlaceHours": { "additionalProperties": true, "properties": { "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the place is open now when only open_now is available.", "title": "Open Now" } }, "title": "GoogleMapsPlaceReviewsResponsePlaceHours", "type": "object" }, "GoogleMapsPlaceReviewsResponsePlaceLocation": { "additionalProperties": true, "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place latitude.", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place longitude.", "title": "Longitude" } }, "title": "GoogleMapsPlaceReviewsResponsePlaceLocation", "type": "object" }, "GoogleMapsPlaceReviewsResponseReviewsItem": { "additionalProperties": true, "properties": { "rating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Star rating for the review.", "title": "Rating" }, "review_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review identifier.", "title": "Review Id" }, "review_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review body text.", "title": "Review Text" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reviewer display name when available.", "title": "User Name" } }, "title": "GoogleMapsPlaceReviewsResponseReviewsItem", "type": "object" } }, "additionalProperties": true, "properties": { "cursor_next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page when more results are available.", "title": "Cursor Next" }, "place": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsPlaceReviewsResponsePlace" }, { "type": "null" } ], "default": null, "description": "Place metadata for the reviewed location." }, "reviews": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleMapsPlaceReviewsResponseReviewsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Place reviews.", "title": "Reviews" } }, "title": "GoogleMapsPlaceReviewsResponse", "type": "object" } }, { "description": "List supported Google Maps place type values for search filters.\n\nReturns place_types as a string array. Use a value with place_type on google-maps.search or google-maps.nearby_search.\n\nCost = 1 token.", "inputSchema": { "properties": {}, "title": "get_google_maps_place_typesArguments", "type": "object" }, "name": "google-maps.place_types", "outputSchema": { "additionalProperties": true, "properties": { "place_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Supported Google Maps place type string values.", "title": "Place Types" } }, "title": "GoogleMapsPlaceTypesResponse", "type": "object" } }, { "description": "Get details for one Google Maps review.\n\nProvide review_id from a place reviews response. Returns one review object at the top level with fields such as review_id, review_text, rating, and user_name when available. Additional upstream fields may appear.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "review_id": { "description": "Google Maps review identifier.", "maxLength": 512, "title": "Review Id", "type": "string" } }, "required": [ "review_id" ], "title": "get_google_maps_review_detailsArguments", "type": "object" }, "name": "google-maps.review_details", "outputSchema": { "additionalProperties": true, "properties": { "rating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Star rating for the review.", "title": "Rating" }, "review_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review identifier.", "title": "Review Id" }, "review_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review body text.", "title": "Review Text" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reviewer display name when available.", "title": "User Name" } }, "title": "GoogleMapsReviewDetailsResponse", "type": "object" } }, { "description": "Search Google Maps by text query.\n\nOptional filters include location, radius (defaults to 1000 meters), open_now, min_price, max_price, place_type, language, and region. Pass cursor from a previous cursor_next to fetch the next page.\n\nReturns matching places in places with names, full_address, place_id, ratings, and location. Use place_id with place detail, review, and photo endpoints.\n\ncursor_next and cursor_previous appear only when pagination cursors are available. Additional upstream fields may appear.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursor_next on a previous response.", "title": "Cursor" }, "language": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for results (for example en).", "title": "Language" }, "location": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional latitude and longitude bias point (for example 40,-110). A location embedded in the query may override this.", "title": "Location" }, "max_price": { "anyOf": [ { "maximum": 4, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum price level (0–4, inclusive).", "title": "Max Price" }, "min_price": { "anyOf": [ { "maximum": 4, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Minimum price level (0–4, inclusive).", "title": "Min Price" }, "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "When true, return only places open for business at query time.", "title": "Open Now" }, "place_type": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Restrict results to a single Google Maps place type (for example restaurant).", "title": "Place Type" }, "query": { "description": "Search query for places (for example restaurants in Paris).", "maxLength": 512, "title": "Query", "type": "string" }, "radius": { "anyOf": [ { "maximum": 50000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Search radius in meters (default 1000).", "title": "Radius" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Two-character region code (for example us). On search endpoints this biases results by ccTLD. On place endpoints this selects regional place data.", "title": "Region" } }, "required": [ "query" ], "title": "search_google_mapsArguments", "type": "object" }, "name": "google-maps.search", "outputSchema": { "$defs": { "GoogleMapsSearchResponsePlacesItem": { "additionalProperties": true, "properties": { "business_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Operational status when available.", "title": "Business Status" }, "full_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full formatted address when available.", "title": "Full Address" }, "hours": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsSearchResponsePlacesItemHours" }, { "type": "null" } ], "default": null, "description": "Opening hours when available." }, "location": { "anyOf": [ { "$ref": "#/$defs/GoogleMapsSearchResponsePlacesItemLocation" }, { "type": "null" } ], "default": null, "description": "Place coordinates when available." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place display name.", "title": "Name" }, "place_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Google Maps place identifier.", "title": "Place Id" }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average user rating when available.", "title": "Rating" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable open/closed status when available.", "title": "Status" }, "types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Place type labels when available.", "title": "Types" } }, "title": "GoogleMapsSearchResponsePlacesItem", "type": "object" }, "GoogleMapsSearchResponsePlacesItemHours": { "additionalProperties": true, "properties": { "open_now": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the place is open now when only open_now is available.", "title": "Open Now" } }, "title": "GoogleMapsSearchResponsePlacesItemHours", "type": "object" }, "GoogleMapsSearchResponsePlacesItemLocation": { "additionalProperties": true, "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place latitude.", "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Place longitude.", "title": "Longitude" } }, "title": "GoogleMapsSearchResponsePlacesItemLocation", "type": "object" } }, "additionalProperties": true, "properties": { "cursor_next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page when more results are available.", "title": "Cursor Next" }, "cursor_previous": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the previous page when available.", "title": "Cursor Previous" }, "places": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleMapsSearchResponsePlacesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Matching places from the text search. Additional upstream fields may appear.", "title": "Places" } }, "title": "GoogleMapsSearchResponse", "type": "object" } }, { "description": "Add a domain as a Google Search Console property on Vee3's Search Console account.\n\nThe user or agent can pass a domain, a domain property, or a URL. Vee3-managed domains are added and verified automatically. If the apex host uses URL forwarding, Vee3 writes a Google DNS CNAME record instead of a TXT record. If Google still needs time to verify, the response asks the agent to wait and retry this tool. If Vee3 cannot write DNS, the response includes dns_host_name, dns_record_type, and dns_token. Domains that are not managed by Vee3 return DNS TXT instructions so the user or agent can prove ownership, then retry this tool.\n\nAfter a site is added, call google-search-console.list_sites to see it, then use the other Search Console tools.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "site_url": { "description": "Domain or property to add. The user or agent passes a hostname (example.com), a domain property (sc-domain:example.com), or a URL (https://example.com/).", "title": "Site Url", "type": "string" } }, "required": [ "site_url" ], "title": "add_google_search_console_siteArguments", "type": "object" }, "name": "google-search-console.add_site", "outputSchema": { "additionalProperties": true, "properties": { "dns_host_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS host to create when status is needs_verification. @ for TXT, or the Google CNAME host for domain properties that cannot use an apex TXT record.", "title": "Dns Host Name" }, "dns_record_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record type to create when status is needs_verification. TXT or CNAME.", "title": "Dns Record Type" }, "dns_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DNS record value to create when status is needs_verification.", "title": "Dns Token" }, "domain_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Normalized domain name for the property.", "title": "Domain Name" }, "is_managed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when the domain is a Vee3-managed domain for this account.", "title": "Is Managed" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What happened and what the user or agent should do next.", "title": "Message" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Normalized Search Console domain property URL.", "title": "Site Url" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "added, already_added, pending_verification (wait and retry), or needs_verification (create the DNS record in this response, then retry).", "title": "Status" } }, "title": "AddGoogleSearchConsoleSiteResponse", "type": "object" } }, { "description": "Remove a sitemap URL from Search Console for a verified property.\n\nCall google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact feed_path. Omit site_url to use the default property. This only removes the sitemap from Search Console tracking; it does not delete the sitemap file from the website.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "feed_path": { "description": "Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.", "title": "Feed Path", "type": "string" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" } }, "required": [ "feed_path" ], "title": "delete_google_search_console_sitemapArguments", "type": "object" }, "name": "google-search-console.delete_sitemap", "outputSchema": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when Search Console accepted the sitemap deletion.", "title": "Deleted" }, "feed_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap URL that was removed from Search Console.", "title": "Feed Path" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search Console property URL used for the request.", "title": "Site Url" } }, "title": "DeleteGoogleSearchConsoleSitemapResponse", "type": "object" } }, { "description": "Get one Search Console property for this account.\n\nCall google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response, including unverified properties. Returns the property URL and permission level.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" } }, "title": "get_google_search_console_siteArguments", "type": "object" }, "name": "google-search-console.get_site", "outputSchema": { "additionalProperties": true, "properties": { "permission_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Access level for this property.", "title": "Permission Level" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Property URL.", "title": "Site Url" } }, "title": "GetGoogleSearchConsoleSiteResponse", "type": "object" } }, { "description": "Get details for one sitemap submitted to Search Console.\n\nCall google-search-console.list_sites to discover sites, then google-search-console.list_sitemaps for an exact feed_path when available. Omit site_url to use the default property. Returns submission status, download time, warnings, errors, and content counts.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "feed_path": { "description": "Full sitemap URL for the property, for example https://example.com/sitemap.xml. Use an exact path from google-search-console.list_sitemaps when available.", "title": "Feed Path", "type": "string" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" } }, "required": [ "feed_path" ], "title": "get_google_search_console_sitemapArguments", "type": "object" }, "name": "google-search-console.get_sitemap", "outputSchema": { "$defs": { "GetGoogleSearchConsoleSitemapResponseSitemap": { "additionalProperties": true, "properties": { "contents": { "anyOf": [ { "items": { "$ref": "#/$defs/GetGoogleSearchConsoleSitemapResponseSitemapContentsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Per-content-type submitted and indexed counts.", "title": "Contents" }, "errors": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Error count reported for the sitemap.", "title": "Errors" }, "is_pending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Search Console is still processing the sitemap.", "title": "Is Pending" }, "is_sitemaps_index": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this entry is a sitemap index.", "title": "Is Sitemaps Index" }, "last_downloaded": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timestamp when Google last downloaded the sitemap.", "title": "Last Downloaded" }, "last_submitted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timestamp when the sitemap was last submitted.", "title": "Last Submitted" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full sitemap URL path for the property.", "title": "Path" }, "sitemap_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap type reported by Search Console.", "title": "Sitemap Type" }, "warnings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Warning count reported for the sitemap.", "title": "Warnings" } }, "title": "GetGoogleSearchConsoleSitemapResponseSitemap", "type": "object" }, "GetGoogleSearchConsoleSitemapResponseSitemapContentsItem": { "additionalProperties": true, "properties": { "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap content type reported by Search Console.", "title": "Content Type" }, "indexed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Number of indexed URLs of this content type, when available.", "title": "Indexed" }, "submitted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Number of submitted URLs of this content type, when available.", "title": "Submitted" } }, "title": "GetGoogleSearchConsoleSitemapResponseSitemapContentsItem", "type": "object" } }, "additionalProperties": true, "properties": { "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search Console property URL used for the request.", "title": "Site Url" }, "sitemap": { "anyOf": [ { "$ref": "#/$defs/GetGoogleSearchConsoleSitemapResponseSitemap" }, { "type": "null" } ], "default": null, "description": "Sitemap details for the requested feed_path." } }, "title": "GetGoogleSearchConsoleSitemapResponse", "type": "object" } }, { "description": "Inspect indexing status for a single URL in Search Console.\n\nCall google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns indexing verdict, coverage state, crawl details, and canonical information for the inspected URL.\n\nURL Inspection has limited daily quota. Each call inspects one URL.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "inspection_url": { "description": "Fully qualified URL to inspect within the selected property.", "title": "Inspection Url", "type": "string" }, "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional BCP-47 language code for localized inspection results.", "title": "Language Code" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" } }, "required": [ "inspection_url" ], "title": "inspect_google_search_console_urlArguments", "type": "object" }, "name": "google-search-console.inspect_url", "outputSchema": { "$defs": { "InspectGoogleSearchConsoleUrlResponseIndexStatusResult": { "additionalProperties": true, "properties": { "coverage_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Coverage state describing how the URL is indexed.", "title": "Coverage State" }, "crawled_as": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User agent type used for the most recent crawl.", "title": "Crawled As" }, "google_canonical": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical URL selected by Google, when available.", "title": "Google Canonical" }, "indexing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Indexing state reported by Google.", "title": "Indexing State" }, "last_crawl_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timestamp of the most recent crawl, when available.", "title": "Last Crawl Time" }, "page_fetch_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Result of the most recent page fetch attempt.", "title": "Page Fetch State" }, "robots_txt_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Whether robots.txt allows indexing of the URL.", "title": "Robots Txt State" }, "user_canonical": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical URL declared on the page, when available.", "title": "User Canonical" }, "verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Overall indexing verdict for the inspected URL.", "title": "Verdict" } }, "title": "InspectGoogleSearchConsoleUrlResponseIndexStatusResult", "type": "object" } }, "additionalProperties": true, "properties": { "index_status_result": { "anyOf": [ { "$ref": "#/$defs/InspectGoogleSearchConsoleUrlResponseIndexStatusResult" }, { "type": "null" } ], "default": null, "description": "Indexing status details for the inspected URL." }, "inspection_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL that was inspected.", "title": "Inspection Url" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verified property URL used for the inspection.", "title": "Site Url" } }, "title": "InspectGoogleSearchConsoleUrlResponse", "type": "object" } }, { "description": "List sitemaps submitted for a Search Console property.\n\nCall google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns sitemap paths plus submission, download, warning, and error details. Use an exact path from this response with get_sitemap, submit_sitemap, or delete_sitemap.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" }, "sitemap_index": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional sitemap index URL. When set, only child sitemaps under that index are returned.", "title": "Sitemap Index" } }, "title": "list_google_search_console_sitemapsArguments", "type": "object" }, "name": "google-search-console.list_sitemaps", "outputSchema": { "$defs": { "ListGoogleSearchConsoleSitemapsResponseSitemapsItem": { "additionalProperties": true, "properties": { "contents": { "anyOf": [ { "items": { "$ref": "#/$defs/ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Per-content-type submitted and indexed counts.", "title": "Contents" }, "errors": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Error count reported for the sitemap.", "title": "Errors" }, "is_pending": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether Search Console is still processing the sitemap.", "title": "Is Pending" }, "is_sitemaps_index": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this entry is a sitemap index.", "title": "Is Sitemaps Index" }, "last_downloaded": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timestamp when Google last downloaded the sitemap.", "title": "Last Downloaded" }, "last_submitted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timestamp when the sitemap was last submitted.", "title": "Last Submitted" }, "path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Full sitemap URL path for the property.", "title": "Path" }, "sitemap_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap type reported by Search Console.", "title": "Sitemap Type" }, "warnings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Warning count reported for the sitemap.", "title": "Warnings" } }, "title": "ListGoogleSearchConsoleSitemapsResponseSitemapsItem", "type": "object" }, "ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem": { "additionalProperties": true, "properties": { "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap content type reported by Search Console.", "title": "Content Type" }, "indexed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Number of indexed URLs of this content type, when available.", "title": "Indexed" }, "submitted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Number of submitted URLs of this content type, when available.", "title": "Submitted" } }, "title": "ListGoogleSearchConsoleSitemapsResponseSitemapsItemContentsItem", "type": "object" } }, "additionalProperties": true, "properties": { "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search Console property URL used for the request.", "title": "Site Url" }, "sitemaps": { "anyOf": [ { "items": { "$ref": "#/$defs/ListGoogleSearchConsoleSitemapsResponseSitemapsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Sitemaps submitted for the property.", "title": "Sitemaps" } }, "title": "ListGoogleSearchConsoleSitemapsResponse", "type": "object" } }, { "description": "List Search Console properties for this account.\n\nReturns Vee3-managed domains plus sites added with google-search-console.add_site. Call this to discover sites, then omit site_url on later calls to use the default property, or pass an exact site_url from this response.\n\nIf no properties appear, add a site with google-search-console.add_site or register a domain with domains.register.\n\nCost = 5 tokens.", "inputSchema": { "properties": {}, "title": "list_google_search_console_sitesArguments", "type": "object" }, "name": "google-search-console.list_sites", "outputSchema": { "$defs": { "ListGoogleSearchConsoleSitesResponseSitesItem": { "additionalProperties": true, "properties": { "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this property is used when site_url is omitted on Search Console calls.", "title": "Is Default" }, "permission_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Access level for this property.", "title": "Permission Level" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verified property URL. Either a URL-prefix property (for example https://example.com/) or a domain property (sc-domain:example.com).", "title": "Site Url" } }, "title": "ListGoogleSearchConsoleSitesResponseSitesItem", "type": "object" } }, "additionalProperties": true, "properties": { "sites": { "anyOf": [ { "items": { "$ref": "#/$defs/ListGoogleSearchConsoleSitesResponseSitesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Search Console properties for this account's Vee3-managed domains and sites added with google-search-console.add_site.", "title": "Sites" } }, "title": "ListGoogleSearchConsoleSitesResponse", "type": "object" } }, { "description": "Query Search Console search analytics for a verified property.\n\nCall google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. Returns performance rows with clicks, impressions, CTR, and average position, grouped by the requested dimensions.\n\nDaily search analytics typically lag by two to three days. For the Search Console last-24-hours hourly view, group by hour; those rows can include partial hours and cover up to ten days.\n\nCost = 20 tokens.", "inputSchema": { "properties": { "data_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Whether to return only finalized data, all available daily data, or hourly data. Use hourly_all when grouping by hour. Defaults to final.", "title": "Data State" }, "dimension_filter_groups": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Optional filter groups matching the Google Search Console Search Analytics API shape. Each group contains filters that restrict which rows are returned.", "title": "Dimension Filter Groups" }, "dimensions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Optional dimension names to group results. Supported values: date, query, page, country, device, searchAppearance, hour. Grouping by hour uses the hourly feed.", "title": "Dimensions" }, "end_date": { "description": "Inclusive range end date in YYYY-MM-DD format.", "title": "End Date", "type": "string" }, "row_limit": { "anyOf": [ { "maximum": 25000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of rows to return. Defaults to 1000.", "title": "Row Limit" }, "search_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search type filter. Defaults to web.", "title": "Search Type" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" }, "start_date": { "description": "Inclusive range start date in YYYY-MM-DD format.", "title": "Start Date", "type": "string" }, "start_row": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Zero-based row offset for pagination. Defaults to 0.", "title": "Start Row" } }, "required": [ "start_date", "end_date" ], "title": "query_google_search_console_search_analyticsArguments", "type": "object" }, "name": "google-search-console.query_search_analytics", "outputSchema": { "$defs": { "QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata": { "additionalProperties": true, "properties": { "first_incomplete_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "First date still being collected when grouping by date, in YYYY-MM-DD format.", "title": "First Incomplete Date" }, "first_incomplete_hour": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "First hour still being collected when grouping by hour, in America/Los_Angeles time.", "title": "First Incomplete Hour" } }, "title": "QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata", "type": "object" }, "QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem": { "additionalProperties": true, "properties": { "clicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Click count for this row.", "title": "Clicks" }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Click-through rate for this row.", "title": "Ctr" }, "impressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Impression count for this row.", "title": "Impressions" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Dimension values for this row, in the same order as the requested dimensions.", "title": "Keys" }, "position": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Average position for this row.", "title": "Position" } }, "title": "QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem", "type": "object" } }, "additionalProperties": true, "properties": { "metadata": { "anyOf": [ { "$ref": "#/$defs/QueryGoogleSearchConsoleSearchAnalyticsResponseMetadata" }, { "type": "null" } ], "default": null, "description": "Optional context about incomplete recent data. Present when Google is still collecting rows in the requested range." }, "response_aggregation_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "How rows were aggregated (for example auto or byProperty).", "title": "Response Aggregation Type" }, "rows": { "anyOf": [ { "items": { "$ref": "#/$defs/QueryGoogleSearchConsoleSearchAnalyticsResponseRowsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Search analytics result rows.", "title": "Rows" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verified property URL that was queried.", "title": "Site Url" } }, "title": "QueryGoogleSearchConsoleSearchAnalyticsResponse", "type": "object" } }, { "description": "Submit a sitemap URL to Search Console for a verified property.\n\nCall google-search-console.list_sites to discover sites. Omit site_url to use the default property, or pass an exact site_url from that response. feed_path must be the full sitemap URL hosted on that property.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "feed_path": { "description": "Full sitemap URL for the property, for example https://example.com/sitemap.xml.", "title": "Feed Path", "type": "string" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional property URL from google-search-console.list_sites. When omitted, the default property is used. The user or agent passes an exact site_url value from that response.", "title": "Site Url" } }, "required": [ "feed_path" ], "title": "submit_google_search_console_sitemapArguments", "type": "object" }, "name": "google-search-console.submit_sitemap", "outputSchema": { "additionalProperties": true, "properties": { "feed_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Sitemap URL that was submitted.", "title": "Feed Path" }, "site_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search Console property URL used for the request.", "title": "Site Url" }, "submitted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True when Search Console accepted the sitemap submission.", "title": "Submitted" } }, "title": "SubmitGoogleSearchConsoleSitemapResponse", "type": "object" } }, { "description": "Get Google Search autocomplete suggestions for a partial query.\n\nReturns the normalized query and an array of suggested search phrases.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "query": { "description": "Partial search keywords or phrase.", "maxLength": 512, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "get_google_search_autocompleteArguments", "type": "object" }, "name": "google-search.autocomplete", "outputSchema": { "$defs": { "GoogleSearchAutocompleteResponseSuggestionsItem": { "additionalProperties": true, "properties": { "phrase": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Single autocomplete suggestion phrase.", "title": "Phrase" } }, "title": "GoogleSearchAutocompleteResponseSuggestionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Normalized query echoed from the request.", "title": "Query" }, "suggestions": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleSearchAutocompleteResponseSuggestionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Suggested search phrases for the query.", "title": "Suggestions" } }, "title": "GoogleSearchAutocompleteResponse", "type": "object" } }, { "description": "Get Google keyword traffic insights and related keyword suggestions for a seed keyword.\n\nReturns an array of keyword suggestions. Each item includes text, monthly search volume, competition_level, competition_index, low_bid, high_bid, and trend.\n\nRequired: keyword and language (for example en). Optional: location (for example US) for country-specific data; omit location for global results (default). Optional: mode (exact or all, default all), min_search_volume (default 0), and intent (informational, navigational, commercial, or transactional).\n\nCost = 20 tokens.", "inputSchema": { "properties": { "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by search intent: informational, navigational, commercial, or transactional.", "title": "Intent" }, "keyword": { "description": "Seed keyword to get traffic insights and suggestions for.", "maxLength": 512, "title": "Keyword", "type": "string" }, "language": { "description": "Language code for the search market (for example en).", "maxLength": 16, "title": "Language", "type": "string" }, "location": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional country or region code for localized traffic (for example US). Omit for global keyword insights.", "title": "Location" }, "min_search_volume": { "default": 0, "description": "Minimum monthly search volume; only keywords at or above this threshold are returned.", "minimum": 0, "title": "Min Search Volume", "type": "integer" }, "mode": { "default": "all", "description": "Keyword suggestion filter: exact returns only suggestions that exactly match the seed keyword; all returns all suggestions (default).", "title": "Mode", "type": "string" } }, "required": [ "keyword", "language" ], "title": "get_seo_keyword_traffic_insightsArguments", "type": "object" }, "name": "google-search.keyword_traffic_insights", "outputSchema": { "$defs": { "SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem": { "additionalProperties": true, "properties": { "competition_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Competition index score.", "title": "Competition Index" }, "competition_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Competition level (for example LOW, MEDIUM, HIGH, UNSPECIFIED).", "title": "Competition Level" }, "high_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "High top-of-page bid estimate.", "title": "High Bid" }, "low_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Low top-of-page bid estimate.", "title": "Low Bid" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested keyword text.", "title": "Text" }, "trend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Search volume trend percentage.", "title": "Trend" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated monthly search volume.", "title": "Volume" } }, "title": "SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "keyword_suggestions": { "anyOf": [ { "items": { "$ref": "#/$defs/SeoKeywordTrafficInsightsResponseKeywordSuggestionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Keyword suggestions with traffic and competition metrics.", "title": "Keyword Suggestions" } }, "title": "SeoKeywordTrafficInsightsResponse", "type": "object" } }, { "description": "List languages you can pass as language on google-search.keyword_traffic_insights and google-search.url_traffic_insights.\n\nReturns an array of entries with language_name and language_code (for example en, de). Maps to upstream lang on the provider API. No request parameters.\n\nCost = 5 tokens.", "inputSchema": { "properties": {}, "title": "get_google_search_languagesArguments", "type": "object" }, "name": "google-search.languages", "outputSchema": { "$defs": { "GoogleSearchLanguagesResponseLanguagesItem": { "additionalProperties": true, "properties": { "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Language code for the language parameter (for example en).", "title": "Language Code" }, "language_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Language display name.", "title": "Language Name" } }, "title": "GoogleSearchLanguagesResponseLanguagesItem", "type": "object" } }, "additionalProperties": true, "properties": { "languages": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleSearchLanguagesResponseLanguagesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Supported languages for the language request parameter.", "title": "Languages" } }, "title": "GoogleSearchLanguagesResponse", "type": "object" } }, { "description": "List countries and region codes you can pass as location on google-search.keyword_traffic_insights and google-search.url_traffic_insights.\n\nReturns an array of entries with country_name and country_code (for example US, GB). No request parameters.\n\nCost = 5 tokens.", "inputSchema": { "properties": {}, "title": "get_google_search_locationsArguments", "type": "object" }, "name": "google-search.locations", "outputSchema": { "$defs": { "GoogleSearchLocationsResponseLocationsItem": { "additionalProperties": true, "properties": { "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Country code for the location parameter (for example US).", "title": "Country Code" }, "country_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Country display name.", "title": "Country Name" } }, "title": "GoogleSearchLocationsResponseLocationsItem", "type": "object" } }, "additionalProperties": true, "properties": { "locations": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleSearchLocationsResponseLocationsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Supported countries for the location request parameter.", "title": "Locations" } }, "title": "GoogleSearchLocationsResponse", "type": "object" } }, { "description": "Get Google keyword traffic insights and related keyword suggestions for a URL.\n\nReturns an array of keyword suggestions. Each item includes text, monthly search volume, competition_level, competition_index, low_bid, high_bid, and trend.\n\nRequired: url and language (for example en). Optional: location (for example US) for country-specific data; omit location for global results (default). Optional: min_search_volume (default 0) and intent (informational, navigational, commercial, or transactional).\n\nCost = 20 tokens.", "inputSchema": { "properties": { "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filter by search intent: informational, navigational, commercial, or transactional.", "title": "Intent" }, "language": { "description": "Language code for the search market (for example en).", "maxLength": 16, "title": "Language", "type": "string" }, "location": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional country or region code for localized traffic (for example US). Omit for global URL keyword insights.", "title": "Location" }, "min_search_volume": { "default": 0, "description": "Minimum monthly search volume; only keywords at or above this threshold are returned.", "minimum": 0, "title": "Min Search Volume", "type": "integer" }, "url": { "description": "Public http or https URL to get traffic insights and suggestions for.", "maxLength": 2048, "title": "Url", "type": "string" } }, "required": [ "url", "language" ], "title": "get_seo_url_traffic_insightsArguments", "type": "object" }, "name": "google-search.url_traffic_insights", "outputSchema": { "$defs": { "SeoUrlTrafficInsightsResponseKeywordSuggestionsItem": { "additionalProperties": true, "properties": { "competition_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Competition index score.", "title": "Competition Index" }, "competition_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Competition level (for example LOW, MEDIUM, HIGH, UNSPECIFIED).", "title": "Competition Level" }, "high_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "High top-of-page bid estimate.", "title": "High Bid" }, "low_bid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Low top-of-page bid estimate.", "title": "Low Bid" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested keyword text.", "title": "Text" }, "trend": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Search volume trend percentage.", "title": "Trend" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated monthly search volume.", "title": "Volume" } }, "title": "SeoUrlTrafficInsightsResponseKeywordSuggestionsItem", "type": "object" } }, "additionalProperties": true, "properties": { "keyword_suggestions": { "anyOf": [ { "items": { "$ref": "#/$defs/SeoUrlTrafficInsightsResponseKeywordSuggestionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Keyword suggestions with traffic and competition metrics.", "title": "Keyword Suggestions" } }, "title": "SeoUrlTrafficInsightsResponse", "type": "object" } }, { "description": "List all Google Trends category and subcategory labels you can pass to other Google Trends tools in the category field.\n\nReturns cat (array of category names, including All categories) and msg. Use this before interest-over-time or interest-by-region calls when filtering by category.\n\nCost = 5 tokens.", "inputSchema": { "properties": {}, "title": "get_google_trends_categoriesArguments", "type": "object" }, "name": "google-trends.categories", "outputSchema": { "$defs": { "GoogleTrendsCategoriesResponseCatItem": { "additionalProperties": true, "properties": {}, "title": "GoogleTrendsCategoriesResponseCatItem", "type": "object" } }, "additionalProperties": true, "properties": { "cat": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleTrendsCategoriesResponseCatItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Category and subcategory names accepted by the category field.", "title": "Cat" }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Status or informational message from the upstream API (often empty).", "title": "Msg" } }, "title": "GoogleTrendsCategoriesResponse", "type": "object" } }, { "description": "Fetch Google Trends interest-by-region breakdowns for one to five keywords.\n\nReturns a JSON object whose top-level keys are your keywords. Each value maps location names (countries or subregions) to interest scores (0–100).\n\nRequires start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100). Optional end defaults to now. country defaults to global; region requires a valid country. category and gprop default to all when omitted or empty. resolution is COUNTRY (default) or REGION.\n\nCost = 40 tokens.", "inputSchema": { "properties": { "category": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "default": null, "description": "Trends category or subcategory. Defaults to all.", "title": "Category" }, "country": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Country name for geo filtering. Defaults to global.", "title": "Country" }, "end": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Range end in datetime-with-timezone form. Defaults to now.", "title": "End" }, "gprop": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Google property filter (for example images, news, youtube, froogle). Defaults to all.", "title": "Gprop" }, "keywords": { "description": "Up to five keywords to compare.", "items": { "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Keywords", "type": "array" }, "region": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Region within country. Requires country when set.", "title": "Region" }, "resolution": { "default": "COUNTRY", "description": "Geographic resolution: COUNTRY (default) or REGION.", "enum": [ "COUNTRY", "REGION" ], "title": "Resolution", "type": "string" }, "start": { "description": "Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).", "maxLength": 64, "title": "Start", "type": "string" } }, "required": [ "keywords", "start" ], "title": "get_google_trends_interest_by_regionArguments", "type": "object" }, "name": "google-trends.interest_by_region", "outputSchema": { "additionalProperties": true, "properties": {}, "title": "GoogleTrendsInterestByRegionResponse", "type": "object" } }, { "description": "Fetch Google Trends interest-over-time series for one to five keywords.\n\nReturns a JSON object whose top-level keys are your keywords. Each value maps timestamps to interest scores (0–100). Granularity depends on the requested date range (from about one minute to monthly buckets).\n\nRequires start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100). Optional end defaults to now. country defaults to global; region requires a valid country. category and gprop default to all when omitted or empty.\n\nCost = 40 tokens.", "inputSchema": { "properties": { "category": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "default": null, "description": "Trends category or subcategory. Defaults to all.", "title": "Category" }, "country": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Country name for geo filtering. Defaults to global.", "title": "Country" }, "end": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Range end in datetime-with-timezone form. Defaults to now.", "title": "End" }, "gprop": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Google property filter (for example images, news, youtube, froogle). Defaults to all.", "title": "Gprop" }, "keywords": { "description": "Up to five keywords to compare.", "items": { "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Keywords", "type": "array" }, "region": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Region within country. Requires country when set.", "title": "Region" }, "start": { "description": "Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).", "maxLength": 64, "title": "Start", "type": "string" } }, "required": [ "keywords", "start" ], "title": "get_google_trends_interest_over_timeArguments", "type": "object" }, "name": "google-trends.interest_over_time", "outputSchema": { "additionalProperties": true, "properties": {}, "title": "GoogleTrendsInterestOverTimeResponse", "type": "object" } }, { "description": "List all countries and subregions you can pass to other Google Trends tools in the country and region fields.\n\nReturns geo.countries: each country name maps to country (label) and regions (array of subregion names). Also returns msg.\n\nUse this before interest-over-time or interest-by-region calls when filtering by geography. Pair with google-trends.categories when filtering by category.\n\nCost = 5 tokens.", "inputSchema": { "properties": {}, "title": "get_google_trends_regionsArguments", "type": "object" }, "name": "google-trends.regions", "outputSchema": { "$defs": { "GoogleTrendsRegionsResponseGeo": { "additionalProperties": true, "properties": { "countries": { "anyOf": [ { "$ref": "#/$defs/GoogleTrendsRegionsResponseGeoCountries" }, { "type": "null" } ], "default": null, "description": "Map of country name to country metadata and subregions." } }, "title": "GoogleTrendsRegionsResponseGeo", "type": "object" }, "GoogleTrendsRegionsResponseGeoCountries": { "additionalProperties": true, "properties": {}, "title": "GoogleTrendsRegionsResponseGeoCountries", "type": "object" } }, "additionalProperties": true, "properties": { "geo": { "anyOf": [ { "$ref": "#/$defs/GoogleTrendsRegionsResponseGeo" }, { "type": "null" } ], "default": null, "description": "Geographic options keyed by country name." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Status or informational message (often empty).", "title": "Msg" } }, "title": "GoogleTrendsRegionsResponse", "type": "object" } }, { "description": "Fetch Google Trends related queries for one to five keywords.\n\nReturns a JSON object whose top-level keys are your keywords. Each value has top and rising sections; each section has query (rank index to query string) and value (rank index to score).\n\nRequires start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100). Optional end defaults to now. country defaults to global; region requires a valid country. category and gprop default to all when omitted or empty.\n\nUse google-trends.categories and google-trends.regions to discover valid category, country, and region values.\n\nCost = 40 tokens.", "inputSchema": { "properties": { "category": { "anyOf": [ { "maxLength": 256, "type": "string" }, { "type": "null" } ], "default": null, "description": "Trends category or subcategory. Defaults to all.", "title": "Category" }, "country": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Country name for geo filtering. Defaults to global.", "title": "Country" }, "end": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Range end in datetime-with-timezone form. Defaults to now.", "title": "End" }, "gprop": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "Google property filter (for example images, news, youtube, froogle). Defaults to all.", "title": "Gprop" }, "keywords": { "description": "Up to five keywords to compare.", "items": { "type": "string" }, "maxItems": 5, "minItems": 1, "title": "Keywords", "type": "array" }, "region": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Region within country. Requires country when set.", "title": "Region" }, "start": { "description": "Range start in datetime-with-timezone form (for example 2020-05-01T00:43:37+0100).", "maxLength": 64, "title": "Start", "type": "string" } }, "required": [ "keywords", "start" ], "title": "get_google_trends_related_queriesArguments", "type": "object" }, "name": "google-trends.related_queries", "outputSchema": { "additionalProperties": true, "properties": {}, "title": "GoogleTrendsRelatedQueriesResponse", "type": "object" } }, { "description": "Get Google Trends suggestions for a single keyword.\n\nReturns result: an array of suggested topics and entities, each with mid (topic id), title (display name), and type (for example Topic, Software, Book).\n\nUse this to refine keywords before interest-over-time, interest-by-region, or related-queries calls.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "keyword": { "description": "Keyword or phrase to get suggestions for.", "maxLength": 512, "title": "Keyword", "type": "string" } }, "required": [ "keyword" ], "title": "get_google_trends_suggestionsArguments", "type": "object" }, "name": "google-trends.suggestions", "outputSchema": { "$defs": { "GoogleTrendsSuggestionsResponseResultItem": { "additionalProperties": true, "properties": { "mid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Google Trends topic or entity identifier.", "title": "Mid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display title for the suggestion.", "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggestion kind (for example Topic, Software, Book).", "title": "Type" } }, "title": "GoogleTrendsSuggestionsResponseResultItem", "type": "object" } }, "additionalProperties": true, "properties": { "result": { "anyOf": [ { "items": { "$ref": "#/$defs/GoogleTrendsSuggestionsResponseResultItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Suggested topics and entities for the keyword.", "title": "Result" } }, "title": "GoogleTrendsSuggestionsResponse", "type": "object" } }, { "description": "Edit an existing image or compose several images into one scene with Muse Image.\n\nThe user or agent passes stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit; several images are composed into one result.\n\nThe result is saved to account file storage. The response includes a signed URL for API users and download_code for agents to run `vee3-get-file`.\n\nCost = 50 tokens per generated image.", "inputSchema": { "properties": { "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.", "title": "File Name" }, "images": { "description": "Source images as stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit. Several images are composed into one scene. Upload files with files.upload_file first.", "items": { "type": "string" }, "maxItems": 8, "minItems": 1, "title": "Images", "type": "array" }, "n": { "default": 1, "description": "Number of images to generate (1 to 10). Each returned image costs 50 tokens.", "maximum": 10, "minimum": 1, "title": "N", "type": "integer" }, "output_format": { "default": "webp", "description": "Encoding of the returned image. webp is smaller; png is lossless.", "enum": [ "webp", "png", "jpeg" ], "title": "Output Format", "type": "string" }, "prompt": { "description": "Text description of the image to generate or of the edit to apply.", "maxLength": 4000, "title": "Prompt", "type": "string" }, "size": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.", "title": "Size" } }, "required": [ "prompt", "images" ], "title": "edit_imageArguments", "type": "object" }, "name": "image-generation.edit", "outputSchema": { "$defs": { "EditImageResponseImagesItem": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved download.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the image was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image file size in bytes.", "title": "File Size Bytes" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "Image Url" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" } }, "title": "EditImageResponseImagesItem", "type": "object" } }, "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp.", "title": "Created At" }, "generation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier, prefix igen_.", "title": "Generation Id" }, "image_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of images returned and billed.", "title": "Image Count" }, "images": { "anyOf": [ { "items": { "$ref": "#/$defs/EditImageResponseImagesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Generated images stored in account file storage.", "title": "Images" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "output_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Encoding of the stored images (webp, png, or jpeg).", "title": "Output Format" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested prompt.", "title": "Prompt" }, "size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested size when one was passed.", "title": "Size" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Always \"completed\" for a successful generation.", "title": "Status" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens charged for this request (50 times image_count).", "title": "Token Cost" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "EditImageResponse", "type": "object" } }, { "description": "Generate an image from a text prompt with Muse Image.\n\nThe image is saved to account file storage. The response includes a signed URL for API users and download_code for agents to run `vee3-get-file`. When n is greater than 1, each returned image is stored separately.\n\nCost = 50 tokens per generated image.", "inputSchema": { "properties": { "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.", "title": "File Name" }, "n": { "default": 1, "description": "Number of images to generate (1 to 10). Each returned image costs 50 tokens.", "maximum": 10, "minimum": 1, "title": "N", "type": "integer" }, "output_format": { "default": "webp", "description": "Encoding of the returned image. webp is smaller; png is lossless.", "enum": [ "webp", "png", "jpeg" ], "title": "Output Format", "type": "string" }, "prompt": { "description": "Text description of the image to generate or of the edit to apply.", "maxLength": 4000, "title": "Prompt", "type": "string" }, "size": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.", "title": "Size" } }, "required": [ "prompt" ], "title": "generate_imageArguments", "type": "object" }, "name": "image-generation.generate", "outputSchema": { "$defs": { "GenerateImageResponseImagesItem": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved download.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the image was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image file size in bytes.", "title": "File Size Bytes" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "Image Url" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" } }, "title": "GenerateImageResponseImagesItem", "type": "object" } }, "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp.", "title": "Created At" }, "generation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier, prefix igen_.", "title": "Generation Id" }, "image_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of images returned and billed.", "title": "Image Count" }, "images": { "anyOf": [ { "items": { "$ref": "#/$defs/GenerateImageResponseImagesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Generated images stored in account file storage.", "title": "Images" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "output_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Encoding of the stored images (webp, png, or jpeg).", "title": "Output Format" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested prompt.", "title": "Prompt" }, "size": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested size when one was passed.", "title": "Size" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Always \"completed\" for a successful generation.", "title": "Status" }, "token_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens charged for this request (50 times image_count).", "title": "Token Cost" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "GenerateImageResponse", "type": "object" } }, { "description": "Describe a single Vee3 capability.\n\nPass the MCP tool name (for example `website-screenshots.capture`) or capability id (for example `website-screenshot`). Use this after meta-tools.list_group_tools when you need parameter names, defaults, response fields, examples, and token cost before calling a tool\n\nCost = 0 tokens.", "inputSchema": { "properties": { "tool_name": { "description": "MCP tool name (for example `x-twitter.create_post`) or capability id (for example `create-x-post`).", "maxLength": 128, "title": "Tool Name", "type": "string" } }, "required": [ "tool_name" ], "title": "describe_toolArguments", "type": "object" }, "name": "meta-tools.describe", "outputSchema": { "$defs": { "DescribeToolResponseTool": { "additionalProperties": true, "properties": { "agent_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Longer description intended for agents.", "title": "Agent Description" }, "error_codes": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolErrorCodesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Error codes that may appear in error responses.", "title": "Error Codes" }, "examples": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolExamplesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Request examples for the capability.", "title": "Examples" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Capability group id.", "title": "Group Id" }, "mcp_tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MCP tool name when the capability is exposed over MCP.", "title": "Mcp Tool Name" }, "request_fields": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolRequestFieldsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Request parameter schema for the capability.", "title": "Request Fields" }, "response_examples": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolResponseExamplesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Response examples for the capability.", "title": "Response Examples" }, "response_fields": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolResponseFieldsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Response field schema for the capability.", "title": "Response Fields" }, "success_body_codes": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolSuccessBodyCodesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Non-error body codes that may appear on HTTP 200 responses.", "title": "Success Body Codes" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short capability summary.", "title": "Summary" }, "usage_unit_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Label for usage reporting (for example screenshots).", "title": "Usage Unit Label" } }, "title": "DescribeToolResponseTool", "type": "object" }, "DescribeToolResponseToolErrorCodesItem": { "additionalProperties": true, "properties": { "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine-readable error code.", "title": "Error Code" } }, "title": "DescribeToolResponseToolErrorCodesItem", "type": "object" }, "DescribeToolResponseToolExamplesItem": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What the example demonstrates.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Example identifier.", "title": "Name" }, "request_body": { "anyOf": [ { "$ref": "#/$defs/DescribeToolResponseToolExamplesItemRequestBody" }, { "type": "null" } ], "default": null, "description": "Sample request payload for the capability." }, "surfaces": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolExamplesItemSurfacesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Surfaces where the example applies.", "title": "Surfaces" } }, "title": "DescribeToolResponseToolExamplesItem", "type": "object" }, "DescribeToolResponseToolExamplesItemRequestBody": { "additionalProperties": true, "properties": { "parameter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Capability-specific request parameter documented in the example.", "title": "Parameter" } }, "title": "DescribeToolResponseToolExamplesItemRequestBody", "type": "object" }, "DescribeToolResponseToolExamplesItemSurfacesItem": { "additionalProperties": true, "properties": { "surface": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "rest or mcp.", "title": "Surface" } }, "title": "DescribeToolResponseToolExamplesItemSurfacesItem", "type": "object" }, "DescribeToolResponseToolRequestFieldsItem": { "additionalProperties": true, "properties": { "constraints": { "anyOf": [ { "$ref": "#/$defs/DescribeToolResponseToolRequestFieldsItemConstraints" }, { "type": "null" } ], "default": null, "description": "Optional numeric or length limits." }, "default": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Default value when omitted (string, integer, or boolean), or null when none.", "title": "Default" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Parameter description.", "title": "Description" }, "enum_values": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolRequestFieldsItemEnumValuesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Allowed enum values when type_name is enum.", "title": "Enum Values" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Request parameter name.", "title": "Name" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the parameter is required.", "title": "Required" }, "surfaces": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolRequestFieldsItemSurfacesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Surfaces where the parameter applies.", "title": "Surfaces" }, "type_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Parameter type (string, integer, boolean, or enum).", "title": "Type Name" } }, "title": "DescribeToolResponseToolRequestFieldsItem", "type": "object" }, "DescribeToolResponseToolRequestFieldsItemConstraints": { "additionalProperties": true, "properties": { "max_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum allowed string length when set.", "title": "Max Length" }, "maximum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum allowed numeric value when set.", "title": "Maximum" }, "minimum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Minimum allowed numeric value when set.", "title": "Minimum" } }, "title": "DescribeToolResponseToolRequestFieldsItemConstraints", "type": "object" }, "DescribeToolResponseToolRequestFieldsItemEnumValuesItem": { "additionalProperties": true, "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Allowed enum value.", "title": "Value" } }, "title": "DescribeToolResponseToolRequestFieldsItemEnumValuesItem", "type": "object" }, "DescribeToolResponseToolRequestFieldsItemSurfacesItem": { "additionalProperties": true, "properties": { "surface": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "rest or mcp.", "title": "Surface" } }, "title": "DescribeToolResponseToolRequestFieldsItemSurfacesItem", "type": "object" }, "DescribeToolResponseToolResponseExamplesItem": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What the example demonstrates.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Example identifier.", "title": "Name" }, "response_body": { "anyOf": [ { "$ref": "#/$defs/DescribeToolResponseToolResponseExamplesItemResponseBody" }, { "type": "null" } ], "default": null, "description": "Sample response payload for the capability." }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "HTTP status code for the example response.", "title": "Status Code" } }, "title": "DescribeToolResponseToolResponseExamplesItem", "type": "object" }, "DescribeToolResponseToolResponseExamplesItemResponseBody": { "additionalProperties": true, "properties": { "field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Capability-specific response field documented in the example.", "title": "Field" } }, "title": "DescribeToolResponseToolResponseExamplesItemResponseBody", "type": "object" }, "DescribeToolResponseToolResponseFieldsItem": { "additionalProperties": true, "properties": { "children": { "anyOf": [ { "items": { "$ref": "#/$defs/DescribeToolResponseToolResponseFieldsItemChildrenItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Nested response field specs when type_name is array or object. Items use the same shape and may nest further.", "title": "Children" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Field description.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Response field name.", "title": "Name" }, "type_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Field type (string, integer, boolean, enum, array, or object).", "title": "Type Name" } }, "title": "DescribeToolResponseToolResponseFieldsItem", "type": "object" }, "DescribeToolResponseToolResponseFieldsItemChildrenItem": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Field description.", "title": "Description" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Response field name.", "title": "Name" }, "type_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Field type (string, integer, boolean, enum, array, or object).", "title": "Type Name" } }, "title": "DescribeToolResponseToolResponseFieldsItemChildrenItem", "type": "object" }, "DescribeToolResponseToolSuccessBodyCodesItem": { "additionalProperties": true, "properties": { "body_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Machine-readable success-body code.", "title": "Body Code" } }, "title": "DescribeToolResponseToolSuccessBodyCodesItem", "type": "object" } }, "additionalProperties": true, "properties": { "capability_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Described capability id.", "title": "Capability Id" }, "tool": { "anyOf": [ { "$ref": "#/$defs/DescribeToolResponseTool" }, { "type": "null" } ], "default": null, "description": "Full capability detail including fields, examples, and bindings." } }, "title": "DescribeToolResponse", "type": "object" } }, { "description": "List all live Vee3 agent tools.\n\nUse this when you need to discover which tools exist and what they are called in MCP. Each entry includes mcp_tool_name, group_id, and summary. Use meta-tools.describe for full request/response schemas and token costs\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "list_all_toolsArguments", "type": "object" }, "name": "meta-tools.list_all", "outputSchema": { "$defs": { "ListAllToolsResponseToolsItem": { "additionalProperties": true, "properties": { "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Capability group id.", "title": "Group Id" }, "mcp_tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MCP tool name when the capability is exposed over MCP.", "title": "Mcp Tool Name" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short capability summary.", "title": "Summary" } }, "title": "ListAllToolsResponseToolsItem", "type": "object" } }, "additionalProperties": true, "properties": { "tools": { "anyOf": [ { "items": { "$ref": "#/$defs/ListAllToolsResponseToolsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Live tool summaries for every capability exposed to agents.", "title": "Tools" } }, "title": "ListAllToolsResponse", "type": "object" } }, { "description": "List live tools belonging to a single capability group.\n\nUse group_id from meta-tools.list_groups (for example website-screenshots). Returns name and summary for each live tool in the group\n\nCost = 0 tokens.", "inputSchema": { "properties": { "group_id": { "description": "Group id to list tools for (for example website-screenshots).", "maxLength": 128, "title": "Group Id", "type": "string" } }, "required": [ "group_id" ], "title": "list_group_toolsArguments", "type": "object" }, "name": "meta-tools.list_group_tools", "outputSchema": { "$defs": { "ListGroupToolsResponseToolsItem": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MCP tool name when the capability is exposed over MCP.", "title": "Name" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short capability summary.", "title": "Summary" } }, "title": "ListGroupToolsResponseToolsItem", "type": "object" } }, "additionalProperties": true, "properties": { "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Requested group id.", "title": "Group Id" }, "tools": { "anyOf": [ { "items": { "$ref": "#/$defs/ListGroupToolsResponseToolsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Live tool summaries in the requested group.", "title": "Tools" } }, "title": "ListGroupToolsResponse", "type": "object" } }, { "description": "List all Vee3 capability groups.\n\nUse this to see how tools are organized (for example website-screenshots or meta-tools) before listing tools in a specific group\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "list_groupsArguments", "type": "object" }, "name": "meta-tools.list_groups", "outputSchema": { "$defs": { "ListGroupsResponseGroupsItem": { "additionalProperties": true, "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable group name.", "title": "Display Name" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Group id (for example website-screenshots).", "title": "Group Id" }, "live_tool_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of live capabilities in the group.", "title": "Live Tool Count" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short group summary.", "title": "Summary" } }, "title": "ListGroupsResponseGroupsItem", "type": "object" } }, "additionalProperties": true, "properties": { "groups": { "anyOf": [ { "items": { "$ref": "#/$defs/ListGroupsResponseGroupsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Capability groups with live tool counts.", "title": "Groups" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "How the user can enable and disable capability groups from Customize MCP in the dashboard.", "title": "Message" } }, "title": "ListGroupsResponse", "type": "object" } }, { "description": "Report a bug, error, or anything that did not work as expected while using Vee3.\n\nUse this when a capability fails unexpectedly, returns wrong data, or behaves inconsistently. Include what you tried, what happened, and any error output\n\nCost = 0 tokens.", "inputSchema": { "properties": { "description": { "description": "Detailed explanation of what went wrong, what was expected, and steps to reproduce if known.", "maxLength": 8000, "title": "Description", "type": "string" }, "error_details": { "anyOf": [ { "maxLength": 8000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Raw error message, stack trace, or API response that shows the failure.", "title": "Error Details" }, "related_capability_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "MCP tool name or capability id involved in the issue, if applicable.", "title": "Related Capability Id" }, "summary": { "description": "Short title describing the issue.", "maxLength": 200, "title": "Summary", "type": "string" } }, "required": [ "summary", "description" ], "title": "report_bugArguments", "type": "object" }, "name": "meta-tools.report_bug", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the report was recorded.", "title": "Created At" }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the submitted bug report.", "title": "Report Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Submission status. Always \"received\" on success.", "title": "Status" } }, "title": "ReportBugResponse", "type": "object" } }, { "description": "Request a new capability or feature that Vee3 does not offer yet.\n\nUse this when you need something that is not available in the catalog — a missing integration, data source, workflow, or enhancement to an existing capability. Describe what you need, why you cannot accomplish it today, and how you would use it\n\nCost = 0 tokens.", "inputSchema": { "properties": { "description": { "description": "Detailed explanation of what is needed, why it cannot be done with existing tools, and how it would help.", "maxLength": 8000, "title": "Description", "type": "string" }, "related_capability_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Capability id this request extends or relates to, if applicable.", "title": "Related Capability Id" }, "summary": { "description": "Short title describing the requested capability or feature.", "maxLength": 200, "title": "Summary", "type": "string" }, "use_case": { "anyOf": [ { "maxLength": 8000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Example workflow or scenario where this feature would be used.", "title": "Use Case" } }, "required": [ "summary", "description" ], "title": "request_featureArguments", "type": "object" }, "name": "meta-tools.request_feature", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the request was recorded.", "title": "Created At" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the submitted feature request.", "title": "Request Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Submission status. Always \"received\" on success.", "title": "Status" } }, "title": "RequestFeatureResponse", "type": "object" } }, { "description": "Search live Vee3 agent tools by keyword or short task description.\n\nCall this first when you are unsure which tool to use. Returns ranked matches with tool_name, summary, and cost for each hit. Use meta-tools.describe on the best match for full request and response schemas.\n\nOptional group_id narrows results to one capability group. limit defaults to 8 (maximum 20).\n\nCost = 0 tokens.", "inputSchema": { "properties": { "group_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional group id to narrow results (for example `x-twitter`).", "title": "Group Id" }, "limit": { "anyOf": [ { "maximum": 20, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum results to return (1–20).", "title": "Limit" }, "query": { "description": "Keywords or short task description (for example `tiktok video comments` or `domain availability`).", "maxLength": 256, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "search_toolsArguments", "type": "object" }, "name": "meta-tools.search", "outputSchema": { "$defs": { "SearchToolsResponseResultsItem": { "additionalProperties": true, "properties": { "cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Successful request token cost for the capability.", "title": "Cost" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short capability summary.", "title": "Summary" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MCP tool name for the matched capability.", "title": "Tool Name" } }, "title": "SearchToolsResponseResultsItem", "type": "object" } }, "additionalProperties": true, "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Normalized search query that was executed.", "title": "Query" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchToolsResponseResultsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Ranked capability matches visible to the caller.", "title": "Results" } }, "title": "SearchToolsResponse", "type": "object" } }, { "description": "Get the current API token balance for the authenticated account.\n\nReturns tokens used, tokens remaining, monthly allowance, billing plan, and when the allowance resets (billing_period_end). Use this before expensive calls or when you receive a 402 insufficient_tokens response\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "get_token_balanceArguments", "type": "object" }, "name": "meta-tools.token_balance", "outputSchema": { "additionalProperties": true, "properties": { "billing_period_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 end of the current billing period.", "title": "Billing Period End" }, "billing_period_resets_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the token allowance resets (same as period end).", "title": "Billing Period Resets At" }, "billing_period_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 start of the current billing period.", "title": "Billing Period Start" }, "billing_plan": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current billing plan id (free, starter, pro, scale).", "title": "Billing Plan" }, "monthly_token_allowance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total tokens included in the current billing period.", "title": "Monthly Token Allowance" }, "tokens_remaining": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens left before quota is exhausted.", "title": "Tokens Remaining" }, "tokens_used": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tokens consumed in the current billing period.", "title": "Tokens Used" } }, "title": "GetTokenBalanceResponse", "type": "object" } }, { "description": "Create a new static website for this Vee3 account.\n\nReturns a page id and public URL at {slug}.vee3.site. Deploy uploaded files next with pages.deploy.\n\nCost = 200 tokens.", "inputSchema": { "properties": { "name": { "anyOf": [ { "maxLength": 80, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional display name for the page. Does not change the public URL. At most 80 characters.", "title": "Name" }, "slug": { "description": "Page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.", "maxLength": 48, "title": "Slug", "type": "string" } }, "required": [ "slug" ], "title": "createArguments", "type": "object" }, "name": "pages.create", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status.", "title": "Status" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page (https://{slug}.vee3.site until a custom domain is attached).", "title": "Url" } }, "title": "PagesCreateResponse", "type": "object" } }, { "description": "Delete a hosted static website and its CDN resources.\n\nRemoves the page from this Vee3 account after deleting upstream resources.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "page_id": { "description": "Page id to delete.", "title": "Page Id", "type": "string" } }, "required": [ "page_id" ], "title": "deleteArguments", "type": "object" }, "name": "pages.delete", "outputSchema": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the page was deleted.", "title": "Deleted" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deleted page id.", "title": "Page Id" } }, "title": "PagesDeleteResponse", "type": "object" } }, { "description": "Deploy uploaded account files to a hosted static website.\n\nPass file_name values from files.upload_file / files.list_uploaded_files. Optional path overrides the destination path on the page (defaults to the file basename). Up to 500 files per deploy.\n\nCost = 100 tokens.", "inputSchema": { "properties": { "files": { "description": "Files to deploy. Each item is an object with file_name (uploaded account-relative path) and optional path (destination path on the page; defaults to the file basename). Maximum 500 files.", "items": { "additionalProperties": true, "type": "object" }, "maxItems": 500, "minItems": 1, "title": "Files", "type": "array" }, "page_id": { "description": "Page id returned by pages.create.", "title": "Page Id", "type": "string" } }, "required": [ "page_id", "files" ], "title": "deployArguments", "type": "object" }, "name": "pages.deploy", "outputSchema": { "additionalProperties": true, "properties": { "deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When this deploy completed.", "title": "Deployed At" }, "deployed_file_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of files deployed in this request.", "title": "Deployed File Count" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page id.", "title": "Page Id" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Live CDN URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesDeployResponse", "type": "object" } }, { "description": "Update a hosted static website for this Vee3 account.\n\nChange the display name and/or the public slug. Changing the slug moves the preview hostname to {slug}.vee3.site and issues a new TLS certificate. An attached custom domain stays in place. Pass at least one of name or slug.\n\nCost = 20 tokens.", "inputSchema": { "properties": { "name": { "anyOf": [ { "maxLength": 80, "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page. Does not change the public URL. Pass an empty value to clear the name. At most 80 characters.", "title": "Name" }, "page_id": { "description": "Page id to update.", "title": "Page Id", "type": "string" }, "slug": { "anyOf": [ { "maxLength": 48, "type": "string" }, { "type": "null" } ], "default": null, "description": "New page slug used for the public hostname ({slug}.vee3.site). Must be unique across Vee3. Lowercase alphanumeric characters and hyphens only; 1-48 characters; must start and end with an alphanumeric character.", "title": "Slug" } }, "required": [ "page_id" ], "title": "editArguments", "type": "object" }, "name": "pages.edit", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "last_deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When files were last deployed to the page.", "title": "Last Deployed At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page record was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesEditResponse", "type": "object" } }, { "description": "Get details for one static website this Vee3 account hosts.\n\nReturns name, status, public URL, preview hostname on vee3.site, attached custom domain if any, and timestamps.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "page_id": { "description": "Page id to look up.", "title": "Page Id", "type": "string" } }, "required": [ "page_id" ], "title": "getArguments", "type": "object" }, "name": "pages.get", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "last_deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When files were last deployed to the page.", "title": "Last Deployed At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status: active, disabled, pending, or failed. disabled means the page is offline because the account stayed over its token allowance. It comes back after a plan upgrade or the monthly allowance reset.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page record was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesGetResponse", "type": "object" } }, { "description": "List static websites this Vee3 account hosts.\n\nReturns page ids, names, slugs, status, public URLs, preview hostnames on vee3.site, attached custom domains if any, and paging metadata.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "limit": { "default": 50, "description": "Maximum number of pages to return.", "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" }, "page": { "default": 1, "description": "Page number for paginated results.", "minimum": 1, "title": "Page", "type": "integer" } }, "title": "list_pagesArguments", "type": "object" }, "name": "pages.list", "outputSchema": { "$defs": { "PagesListResponsePagesItem": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "last_deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When files were last deployed to the page.", "title": "Last Deployed At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status: active, disabled, pending, or failed. disabled means the page is offline because the account stayed over its token allowance. It comes back after a plan upgrade or the monthly allowance reset.", "title": "Status" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesListResponsePagesItem", "type": "object" }, "PagesListResponsePaging": { "additionalProperties": true, "properties": { "current_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Current page number.", "title": "Current Page" }, "page_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of pages returned per page.", "title": "Page Size" }, "total_items": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total pages matching the query.", "title": "Total Items" } }, "title": "PagesListResponsePaging", "type": "object" } }, "additionalProperties": true, "properties": { "pages": { "anyOf": [ { "items": { "$ref": "#/$defs/PagesListResponsePagesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Pages for this Vee3 account.", "title": "Pages" }, "paging": { "anyOf": [ { "$ref": "#/$defs/PagesListResponsePaging" }, { "type": "null" } ], "default": null, "description": "Pagination metadata for the result set." } }, "title": "PagesListResponse", "type": "object" } }, { "description": "Detach the custom hostname from a hosted static website.\n\nRemoves the custom-domain DNS record and CDN hostname. The page stays online at the preview hostname on vee3.site.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "page_id": { "description": "Page id to detach the custom domain from.", "title": "Page Id", "type": "string" } }, "required": [ "page_id" ], "title": "remove_custom_domainArguments", "type": "object" }, "name": "pages.remove_custom_domain", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "last_deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When files were last deployed to the page.", "title": "Last Deployed At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page record was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesRemoveCustomDomainResponse", "type": "object" } }, { "description": "Attach a custom hostname to a hosted static website.\n\nThe hostname must be on a domain this Vee3 account already manages. Vee3 writes DNS and attaches the hostname to the page CDN with TLS. Subdomains use CNAME; the domain apex uses ALIAS. The preview hostname on vee3.site stays available. Setting a new custom domain replaces the previous one. If HTTPS is not ready yet, call this tool again after DNS is live; Vee3 retries TLS issuance.\n\nCost = 50 tokens.", "inputSchema": { "properties": { "custom_domain": { "description": "Hostname to attach, such as www.example.com or example.com. Must be on a domain this Vee3 account already manages. At most 253 characters.", "maxLength": 253, "title": "Custom Domain", "type": "string" }, "page_id": { "description": "Page id to attach the custom domain to.", "title": "Page Id", "type": "string" } }, "required": [ "page_id", "custom_domain" ], "title": "set_custom_domainArguments", "type": "object" }, "name": "pages.set_custom_domain", "outputSchema": { "additionalProperties": true, "properties": { "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page was created.", "title": "Created At" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Custom hostname attached to the page, if any.", "title": "Custom Domain" }, "hostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.", "title": "Hostname" }, "last_deployed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When files were last deployed to the page.", "title": "Last Deployed At" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Note that DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes.", "title": "Message" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name for the page, if set.", "title": "Name" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Page slug.", "title": "Slug" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current page status.", "title": "Status" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the page record was last updated.", "title": "Updated At" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public HTTPS URL for the page. Uses the custom domain when one is attached.", "title": "Url" } }, "title": "PagesSetCustomDomainResponse", "type": "object" } }, { "description": "Get CDN traffic for one static website this Vee3 account hosts.\n\nReturns request count, bandwidth, cache hit rate, and bandwidth by country for a UTC date range. Request count includes every file the CDN served, not unique visitors. The range is inclusive. When the user or agent omits dates, the last 7 UTC days including today are used. The range can be at most 31 days.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "date_from": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "default": null, "description": "Inclusive UTC start date (YYYY-MM-DD). Defaults to 6 days before date_to.", "title": "Date From" }, "date_to": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "default": null, "description": "Inclusive UTC end date (YYYY-MM-DD). Defaults to today UTC.", "title": "Date To" }, "page_id": { "description": "Page id returned by pages.create.", "title": "Page Id", "type": "string" } }, "required": [ "page_id" ], "title": "get_statisticsArguments", "type": "object" }, "name": "pages.statistics", "outputSchema": { "$defs": { "PagesStatisticsResponseTrafficByCountryItem": { "additionalProperties": true, "properties": { "bandwidth_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Bytes the CDN served to this country in the range.", "title": "Bandwidth Bytes" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 3166-1 alpha-2 country code.", "title": "Country Code" } }, "title": "PagesStatisticsResponseTrafficByCountryItem", "type": "object" } }, "additionalProperties": true, "properties": { "bandwidth_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total bytes the CDN served in the range.", "title": "Bandwidth Bytes" }, "cache_hit_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Fraction of requests served from cache, from 0 to 1.", "title": "Cache Hit Rate" }, "date_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Inclusive UTC start date actually used (YYYY-MM-DD).", "title": "Date From" }, "date_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Inclusive UTC end date actually used (YYYY-MM-DD).", "title": "Date To" }, "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier for the page.", "title": "Page Id" }, "request_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "CDN requests served in the range, including HTML, CSS, images, and other files. Not unique visitors.", "title": "Request Count" }, "traffic_by_country": { "anyOf": [ { "items": { "$ref": "#/$defs/PagesStatisticsResponseTrafficByCountryItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Bandwidth by country code, largest first. Omits countries with no traffic.", "title": "Traffic By Country" } }, "title": "PagesStatisticsResponse", "type": "object" } }, { "description": "Look up a celebrity on Rotten Tomatoes by slug (for example morgan-freeman).\n\nReturns name, bio, birth date and place, profile image, and filmography lists for movies and TV with scores and years.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "celebrity_slug": { "description": "Celebrity slug (for example morgan-freeman).", "maxLength": 512, "title": "Celebrity Slug", "type": "string" } }, "required": [ "celebrity_slug" ], "title": "get_rotten_tomatoes_celebrity_detailsArguments", "type": "object" }, "name": "rotten-tomatoes.celebrity_details", "outputSchema": { "$defs": { "RottenTomatoesCelebrityDetailsResponseMoviesItem": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tomatometer score when available.", "title": "Score" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title slug.", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title name.", "title": "Title" }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Release or air year.", "title": "Year" } }, "title": "RottenTomatoesCelebrityDetailsResponseMoviesItem", "type": "object" }, "RottenTomatoesCelebrityDetailsResponseTvItem": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tomatometer score when available.", "title": "Score" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title slug.", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title name.", "title": "Title" }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Release or air year.", "title": "Year" } }, "title": "RottenTomatoesCelebrityDetailsResponseTvItem", "type": "object" } }, "additionalProperties": true, "properties": { "movies": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesCelebrityDetailsResponseMoviesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Movie credits with title, slug, year, and score.", "title": "Movies" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Celebrity name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Celebrity slug.", "title": "Slug" }, "tv": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesCelebrityDetailsResponseTvItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "TV credits with title, slug, year, and score.", "title": "Tv" } }, "title": "RottenTomatoesCelebrityDetailsResponse", "type": "object" } }, { "description": "List cast and crew credits for a movie by slug (for example shawshank-redemption).\n\nReturns cast and crew members with names, roles, character names, and profile links where available.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "movie_slug": { "description": "Movie slug (for example shawshank-redemption).", "maxLength": 512, "title": "Movie Slug", "type": "string" } }, "required": [ "movie_slug" ], "title": "get_rotten_tomatoes_movie_cast_and_crewArguments", "type": "object" }, "name": "rotten-tomatoes.movie_cast_and_crew", "outputSchema": { "$defs": { "RottenTomatoesMovieCastAndCrewResponseCastItem": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Person name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Celebrity slug when available.", "title": "Slug" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Rotten Tomatoes profile or title URL.", "title": "Url" } }, "title": "RottenTomatoesMovieCastAndCrewResponseCastItem", "type": "object" } }, "additionalProperties": true, "properties": { "cast": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesMovieCastAndCrewResponseCastItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Cast and crew credits for the movie.", "title": "Cast" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Movie slug.", "title": "Slug" } }, "title": "RottenTomatoesMovieCastAndCrewResponse", "type": "object" } }, { "description": "Look up a movie on Rotten Tomatoes by slug (for example shawshank-redemption).\n\nReturns title, year, rating, runtime, genres, description, poster and hero images, Tomatometer and Popcornmeter scores, cast highlights, and where to watch links.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "movie_slug": { "description": "Movie slug (for example shawshank-redemption).", "maxLength": 512, "title": "Movie Slug", "type": "string" } }, "required": [ "movie_slug" ], "title": "get_rotten_tomatoes_movie_detailsArguments", "type": "object" }, "name": "rotten-tomatoes.movie_details", "outputSchema": { "$defs": { "RottenTomatoesMovieDetailsResponseCastItem": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Person name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Celebrity slug when available.", "title": "Slug" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Rotten Tomatoes profile or title URL.", "title": "Url" } }, "title": "RottenTomatoesMovieDetailsResponseCastItem", "type": "object" }, "RottenTomatoesMovieDetailsResponsePopcornmeter": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Numeric score.", "title": "Score" }, "scoreRaw": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted score string (for example 89%).", "title": "Scoreraw" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Score sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesMovieDetailsResponsePopcornmeter", "type": "object" }, "RottenTomatoesMovieDetailsResponseTomatometer": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Numeric score.", "title": "Score" }, "scoreRaw": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted score string (for example 89%).", "title": "Scoreraw" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Score sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesMovieDetailsResponseTomatometer", "type": "object" } }, "additionalProperties": true, "properties": { "cast": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesMovieDetailsResponseCastItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Featured cast with name, slug, and imageUrl.", "title": "Cast" }, "popcornmeter": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesMovieDetailsResponsePopcornmeter" }, { "type": "null" } ], "default": null, "description": "Audience Popcornmeter score and metadata." }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Movie slug.", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Movie title.", "title": "Title" }, "tomatometer": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesMovieDetailsResponseTomatometer" }, { "type": "null" } ], "default": null, "description": "Critic Tomatometer score and metadata." }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Release year.", "title": "Year" } }, "title": "RottenTomatoesMovieDetailsResponse", "type": "object" } }, { "description": "Load reviews for a movie by slug (for example shawshank-redemption).\n\nReturns review quotes, sentiment, publication, critic details, and pageInfo for pagination. Use cursor from pageInfo.endCursor for the next page. Optionally set type to critic for critic reviews only.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response pageInfo.endCursor field.", "title": "Cursor" }, "limit": { "anyOf": [ { "maximum": 50, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of review pages to return (1–50, default 20).", "title": "Limit" }, "movie_slug": { "description": "Movie slug (for example shawshank-redemption).", "maxLength": 512, "title": "Movie Slug", "type": "string" }, "review_type": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Review filter. Use critic for critic reviews; omit for the default set.", "title": "Review Type" } }, "required": [ "movie_slug" ], "title": "get_rotten_tomatoes_movie_reviewsArguments", "type": "object" }, "name": "rotten-tomatoes.movie_reviews", "outputSchema": { "$defs": { "RottenTomatoesMovieReviewsResponsePageInfo": { "additionalProperties": true, "properties": { "endCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page of reviews.", "title": "Endcursor" }, "hasNextPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether more review pages are available.", "title": "Hasnextpage" } }, "title": "RottenTomatoesMovieReviewsResponsePageInfo", "type": "object" }, "RottenTomatoesMovieReviewsResponseReviewsItem": { "additionalProperties": true, "properties": { "quote": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review excerpt or quote.", "title": "Quote" }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review identifier.", "title": "Reviewid" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesMovieReviewsResponseReviewsItem", "type": "object" } }, "additionalProperties": true, "properties": { "pageInfo": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesMovieReviewsResponsePageInfo" }, { "type": "null" } ], "default": null, "description": "Pagination metadata for review listings." }, "reviews": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesMovieReviewsResponseReviewsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Review entries with quote, sentiment, critic, and publication.", "title": "Reviews" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Movie slug.", "title": "Slug" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review set type (for example critic).", "title": "Type" } }, "title": "RottenTomatoesMovieReviewsResponse", "type": "object" } }, { "description": "Search Rotten Tomatoes by title or name.\n\nReturns matching movies, TV series, and celebrities with slugs, scores, poster URLs, release years, and top-billed cast where available.\n\nCost = 13 tokens.", "inputSchema": { "properties": { "limit": { "anyOf": [ { "maximum": 50, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of search results to return (1–50, default 20).", "title": "Limit" }, "query": { "description": "Search query for movies, TV series, or celebrities.", "maxLength": 256, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "search_rotten_tomatoesArguments", "type": "object" }, "name": "rotten-tomatoes.search", "outputSchema": { "$defs": { "RottenTomatoesSearchResponseMoviesItem": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Tomatometer or list score when available.", "title": "Score" }, "scoreSentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Score sentiment (for example POSITIVE).", "title": "Scoresentiment" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Slug for detail lookups (for example inception or breaking-bad).", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display title.", "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Result type (movie, tv, or celebrity).", "title": "Type" } }, "title": "RottenTomatoesSearchResponseMoviesItem", "type": "object" } }, "additionalProperties": true, "properties": { "movies": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesSearchResponseMoviesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Search hits (movies, TV series, or celebrities). Each entry includes type, slug, title, url, posterUrl, score, and cast when available.", "title": "Movies" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the search query.", "title": "Query" } }, "title": "RottenTomatoesSearchResponse", "type": "object" } }, { "description": "List cast and crew credits for a TV series by slug (for example breaking-bad).\n\nReturns cast and crew members with names, roles, character names, and profile links where available.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "tv_show_slug": { "description": "TV series slug (for example breaking-bad).", "maxLength": 512, "title": "Tv Show Slug", "type": "string" } }, "required": [ "tv_show_slug" ], "title": "get_rotten_tomatoes_tv_show_cast_and_crewArguments", "type": "object" }, "name": "rotten-tomatoes.tv_show_cast_and_crew", "outputSchema": { "$defs": { "RottenTomatoesTvShowCastAndCrewResponseCastItem": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Person name.", "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Celebrity slug when available.", "title": "Slug" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Rotten Tomatoes profile or title URL.", "title": "Url" } }, "title": "RottenTomatoesTvShowCastAndCrewResponseCastItem", "type": "object" } }, "additionalProperties": true, "properties": { "cast": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesTvShowCastAndCrewResponseCastItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Cast and crew credits for the series.", "title": "Cast" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TV series slug.", "title": "Slug" } }, "title": "RottenTomatoesTvShowCastAndCrewResponse", "type": "object" } }, { "description": "Look up a TV series on Rotten Tomatoes by slug (for example breaking-bad).\n\nReturns title, years on air, TV rating, season count, genres, description, poster and hero images, Tomatometer and Popcornmeter scores, and creator/cast highlights.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "tv_show_slug": { "description": "TV series slug (for example breaking-bad).", "maxLength": 512, "title": "Tv Show Slug", "type": "string" } }, "required": [ "tv_show_slug" ], "title": "get_rotten_tomatoes_tv_show_detailsArguments", "type": "object" }, "name": "rotten-tomatoes.tv_show_details", "outputSchema": { "$defs": { "RottenTomatoesTvShowDetailsResponsePopcornmeter": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Numeric score.", "title": "Score" }, "scoreRaw": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted score string (for example 89%).", "title": "Scoreraw" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Score sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesTvShowDetailsResponsePopcornmeter", "type": "object" }, "RottenTomatoesTvShowDetailsResponseTomatometer": { "additionalProperties": true, "properties": { "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Numeric score.", "title": "Score" }, "scoreRaw": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted score string (for example 89%).", "title": "Scoreraw" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Score sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesTvShowDetailsResponseTomatometer", "type": "object" } }, "additionalProperties": true, "properties": { "popcornmeter": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesTvShowDetailsResponsePopcornmeter" }, { "type": "null" } ], "default": null, "description": "Average Popcornmeter score and metadata." }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TV series slug.", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Series title.", "title": "Title" }, "tomatometer": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesTvShowDetailsResponseTomatometer" }, { "type": "null" } ], "default": null, "description": "Average Tomatometer score and metadata." }, "year": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Years on air (for example 2008 - 2013).", "title": "Year" } }, "title": "RottenTomatoesTvShowDetailsResponse", "type": "object" } }, { "description": "Load a single episode by TV series slug (for example breaking-bad), season number, and episode number.\n\nReturns episode title, air date, description, and episode Tomatometer score when available.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "episode_number": { "description": "Episode number as one or two digits (for example 1 or 01).", "maxLength": 2, "title": "Episode Number", "type": "string" }, "season_number": { "description": "Season number as one or two digits (for example 1 or 01).", "maxLength": 2, "title": "Season Number", "type": "string" }, "tv_show_slug": { "description": "TV series slug (for example breaking-bad).", "maxLength": 512, "title": "Tv Show Slug", "type": "string" } }, "required": [ "tv_show_slug", "season_number", "episode_number" ], "title": "get_rotten_tomatoes_tv_show_episodeArguments", "type": "object" }, "name": "rotten-tomatoes.tv_show_episode", "outputSchema": { "additionalProperties": true, "properties": { "episode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Episode number.", "title": "Episode" }, "season": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Season number.", "title": "Season" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TV series slug.", "title": "Slug" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Episode title.", "title": "Title" } }, "title": "RottenTomatoesTvShowEpisodesResponse", "type": "object" } }, { "description": "Load season-level details for a TV series by slug (for example breaking-bad) and season number.\n\nReturns season title, episode list summaries, and season Tomatometer scores when available.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "season_number": { "description": "Season number as one or two digits (for example 1 or 01).", "maxLength": 2, "title": "Season Number", "type": "string" }, "tv_show_slug": { "description": "TV series slug (for example breaking-bad).", "maxLength": 512, "title": "Tv Show Slug", "type": "string" } }, "required": [ "tv_show_slug", "season_number" ], "title": "get_rotten_tomatoes_tv_show_seasonArguments", "type": "object" }, "name": "rotten-tomatoes.tv_show_season", "outputSchema": { "$defs": { "RottenTomatoesTvShowSeasonsResponseEpisodesItem": { "additionalProperties": true, "properties": { "episode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Episode number.", "title": "Episode" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Episode title.", "title": "Title" } }, "title": "RottenTomatoesTvShowSeasonsResponseEpisodesItem", "type": "object" } }, "additionalProperties": true, "properties": { "episodes": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesTvShowSeasonsResponseEpisodesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Episodes in the season when listed.", "title": "Episodes" }, "season": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Season identifier.", "title": "Season" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TV series slug.", "title": "Slug" } }, "title": "RottenTomatoesTvShowSeasonsResponse", "type": "object" } }, { "description": "Load reviews for a TV season by series slug (for example breaking-bad) and season number.\n\nReturns review quotes, sentiment, publication, critic details, and pageInfo for pagination. Use cursor from pageInfo.endCursor for the next page. Optionally set type to critic for critic reviews only.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response pageInfo.endCursor field.", "title": "Cursor" }, "limit": { "anyOf": [ { "maximum": 50, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of review pages to return (1–50, default 20).", "title": "Limit" }, "review_type": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Review filter. Use critic for critic reviews; omit for the default set.", "title": "Review Type" }, "season_number": { "description": "Season number as one or two digits (for example 1 or 01).", "maxLength": 2, "title": "Season Number", "type": "string" }, "tv_show_slug": { "description": "TV series slug (for example breaking-bad).", "maxLength": 512, "title": "Tv Show Slug", "type": "string" } }, "required": [ "tv_show_slug", "season_number" ], "title": "get_rotten_tomatoes_tv_show_season_reviewsArguments", "type": "object" }, "name": "rotten-tomatoes.tv_show_season_reviews", "outputSchema": { "$defs": { "RottenTomatoesTvShowSeasonReviewsResponsePageInfo": { "additionalProperties": true, "properties": { "endCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page of reviews.", "title": "Endcursor" }, "hasNextPage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether more review pages are available.", "title": "Hasnextpage" } }, "title": "RottenTomatoesTvShowSeasonReviewsResponsePageInfo", "type": "object" }, "RottenTomatoesTvShowSeasonReviewsResponseReviewsItem": { "additionalProperties": true, "properties": { "quote": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review excerpt or quote.", "title": "Quote" }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review identifier.", "title": "Reviewid" }, "sentiment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Review sentiment (for example POSITIVE).", "title": "Sentiment" } }, "title": "RottenTomatoesTvShowSeasonReviewsResponseReviewsItem", "type": "object" } }, "additionalProperties": true, "properties": { "pageInfo": { "anyOf": [ { "$ref": "#/$defs/RottenTomatoesTvShowSeasonReviewsResponsePageInfo" }, { "type": "null" } ], "default": null, "description": "Pagination metadata for review listings." }, "reviews": { "anyOf": [ { "items": { "$ref": "#/$defs/RottenTomatoesTvShowSeasonReviewsResponseReviewsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Review entries with quote, sentiment, critic, and publication.", "title": "Reviews" }, "season": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Season number.", "title": "Season" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TV series slug.", "title": "Slug" } }, "title": "RottenTomatoesTvShowSeasonReviewsResponse", "type": "object" } }, { "description": "Find backlinks pointing to a website URL.\n\nReturns an overview (domain rating, URL rating, backlink counts, referring domains, dofollow breakdown) and a list of individual backlinks with anchor text, source and target URLs, domain rating, and redirect chains.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "include_subdomains": { "default": true, "description": "When true (default), include backlinks to the domain and its subdomains. When false, analyze only the exact URL.", "title": "Include Subdomains", "type": "boolean" }, "url": { "description": "Public website URL to check for backlinks.", "maxLength": 2048, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "get_seo_backlinksArguments", "type": "object" }, "name": "seo.backlinks", "outputSchema": { "$defs": { "SeoBacklinkCheckerResponseBacklinksItem": { "additionalProperties": true, "properties": { "anchor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Anchor text of the backlink.", "title": "Anchor" }, "domainRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Domain rating of the linking page.", "title": "Domainrating" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Title of the linking page.", "title": "Title" }, "urlFrom": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the page containing the backlink.", "title": "Urlfrom" }, "urlTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Target URL receiving the backlink.", "title": "Urlto" } }, "title": "SeoBacklinkCheckerResponseBacklinksItem", "type": "object" }, "SeoBacklinkCheckerResponseOverview": { "additionalProperties": true, "properties": { "backlinks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total backlinks found.", "title": "Backlinks" }, "domainRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Domain authority score for the target.", "title": "Domainrating" }, "referringDomains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of referring domains.", "title": "Referringdomains" }, "urlRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "URL rating for the target.", "title": "Urlrating" } }, "title": "SeoBacklinkCheckerResponseOverview", "type": "object" } }, "additionalProperties": true, "properties": { "backlinks": { "anyOf": [ { "items": { "$ref": "#/$defs/SeoBacklinkCheckerResponseBacklinksItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Individual backlink records with anchor text and source URLs.", "title": "Backlinks" }, "overview": { "anyOf": [ { "$ref": "#/$defs/SeoBacklinkCheckerResponseOverview" }, { "type": "null" } ], "default": null, "description": "Aggregate backlink statistics for the target." } }, "title": "SeoBacklinkCheckerResponse", "type": "object" } }, { "description": "Get Ahrefs domain authority signals for a website URL.\n\nReturns domainRating (0–100 Ahrefs authority score) and ahRank (global Ahrefs website rank). Useful for comparing site strength and prioritizing outreach or competitive research.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "url": { "description": "Public website URL to analyze (for example https://example.com).", "maxLength": 2048, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "get_seo_basic_metricsArguments", "type": "object" }, "name": "seo.basic_metrics", "outputSchema": { "additionalProperties": true, "properties": { "ahRank": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Global website rank (lower is stronger).", "title": "Ahrank" }, "domainRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Domain authority score from 0 to 100.", "title": "Domainrating" } }, "title": "SeoBasicMetricsResponse", "type": "object" } }, { "description": "List country codes you can pass as country on seo.keyword_metrics.\n\nReturns an array of 2-letter ISO country codes (for example us, gb, de).\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "list_seo_country_codesArguments", "type": "object" }, "name": "seo.country_codes", "outputSchema": { "additionalProperties": true, "properties": { "country_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Supported ISO country codes for keyword metrics.", "title": "Country Codes" } }, "title": "SeoCountryCodesResponse", "type": "object" } }, { "description": "Get SEO metrics for a search keyword in a specific country market.\n\nReturns keyword, searchVolume, clicks, cpc, difficulty, globalSearchVolume, and trafficPotential.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "country": { "default": "us", "description": "2-letter ISO country code for the target market (default us). Use seo.country_codes for supported values.", "maxLength": 2, "title": "Country", "type": "string" }, "keyword": { "description": "Search keyword or phrase to analyze.", "maxLength": 512, "title": "Keyword", "type": "string" } }, "required": [ "keyword" ], "title": "get_seo_keyword_metricsArguments", "type": "object" }, "name": "seo.keyword_metrics", "outputSchema": { "additionalProperties": true, "properties": { "clicks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated monthly clicks from organic search.", "title": "Clicks" }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Estimated cost per click in paid search.", "title": "Cpc" }, "difficulty": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Keyword difficulty score (higher is harder to rank).", "title": "Difficulty" }, "globalSearchVolume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated global monthly search volume.", "title": "Globalsearchvolume" }, "keyword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Analyzed keyword.", "title": "Keyword" }, "searchVolume": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated monthly search volume in the selected country.", "title": "Searchvolume" }, "trafficPotential": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Estimated traffic potential if ranking well.", "title": "Trafficpotential" } }, "title": "SeoKeywordMetricsResponse", "type": "object" } }, { "description": "Get detailed Ahrefs SEO metrics for a specific URL.\n\nReturns two sections:\n- page: backlinks, referring domains, estimated traffic, traffic value, organic keywords, URL rating, and word count on the page\n- domain: domain rating, rank, backlinks, referring domains, traffic, traffic value, and organic keywords\n\nCost = 10 tokens.", "inputSchema": { "properties": { "url": { "description": "Public page URL to analyze.", "maxLength": 2048, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "get_seo_url_metricsArguments", "type": "object" }, "name": "seo.url_metrics", "outputSchema": { "$defs": { "SeoUrlMetricsResponseDomain": { "additionalProperties": true, "properties": { "backlinks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total backlinks for the domain.", "title": "Backlinks" }, "domainRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Domain authority score from 0 to 100.", "title": "Domainrating" }, "refDomains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Referring domains for the domain.", "title": "Refdomains" }, "traffic": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Estimated organic traffic for the domain.", "title": "Traffic" } }, "title": "SeoUrlMetricsResponseDomain", "type": "object" }, "SeoUrlMetricsResponsePage": { "additionalProperties": true, "properties": { "backlinks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Backlinks pointing to the page.", "title": "Backlinks" }, "refDomains": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Referring domains for the page.", "title": "Refdomains" }, "traffic": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Estimated organic traffic for the page.", "title": "Traffic" }, "urlRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "URL rating score for the page.", "title": "Urlrating" } }, "title": "SeoUrlMetricsResponsePage", "type": "object" } }, "additionalProperties": true, "properties": { "domain": { "anyOf": [ { "$ref": "#/$defs/SeoUrlMetricsResponseDomain" }, { "type": "null" } ], "default": null, "description": "Metrics for the parent domain." }, "page": { "anyOf": [ { "$ref": "#/$defs/SeoUrlMetricsResponsePage" }, { "type": "null" } ], "default": null, "description": "Metrics for the requested page URL." } }, "title": "SeoUrlMetricsResponse", "type": "object" } }, { "description": "List replies to a TikTok comment. Requires video_id and comment_id. Pass cursor from a previous response to fetch the next page.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "comment_id": { "description": "TikTok comment id.", "maxLength": 32, "title": "Comment Id", "type": "string" }, "count": { "anyOf": [ { "maximum": 40, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of replies to return (max 40).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "video_id": { "description": "TikTok video id.", "maxLength": 32, "title": "Video Id", "type": "string" } }, "required": [ "video_id", "comment_id" ], "title": "get_tiktok_comment_repliesArguments", "type": "object" }, "name": "tiktok.comment_replies", "outputSchema": { "$defs": { "GetTiktokCommentRepliesResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokCommentRepliesResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokCommentRepliesResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokCommentRepliesResponse", "type": "object" } }, { "description": "Download a TikTok music track so the user or agent can save and reuse it.\n\nProvide either music_id or music_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run `vee3-get-file`.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.", "title": "File Name" }, "music_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok music id.", "title": "Music Id" }, "music_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok music page URL.", "title": "Music Url" } }, "title": "download_tiktok_musicArguments", "type": "object" }, "name": "tiktok.download_music", "outputSchema": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type of the music file.", "title": "Content Type" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved agent download session.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the file was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Music file size in bytes.", "title": "File Size Bytes" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "File Url" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" }, "tiktok_download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique TikTok download operation identifier, prefix td_.", "title": "Tiktok Download Id" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "DownloadTiktokMusicResponse", "type": "object" } }, { "description": "Download music from a TikTok video so the user or agent can save and reuse it.\n\nProvide either video_id or video_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run `vee3-get-file`.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the music file. If omitted, the file is stored under downloads/ with a generated name.", "title": "File Name" }, "video_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video id.", "title": "Video Id" }, "video_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video URL.", "title": "Video Url" } }, "title": "download_tiktok_music_from_videoArguments", "type": "object" }, "name": "tiktok.download_music_from_video", "outputSchema": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type of the music file.", "title": "Content Type" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved agent download session.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the file was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Music file size in bytes.", "title": "File Size Bytes" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "File Url" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" }, "tiktok_download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique TikTok download operation identifier, prefix td_.", "title": "Tiktok Download Id" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "DownloadTiktokMusicFromVideoResponse", "type": "object" } }, { "description": "Download a TikTok video so the user or agent can save and reuse it.\n\nProvide either video_id or video_url, not both. The file is saved to account file storage. The response includes file_url for API users and download_code for agents to run `vee3-get-file`.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the video. If omitted, the file is stored under downloads/ with a generated name.", "title": "File Name" }, "quality": { "default": "standard", "description": "Video quality to download. 'standard' is default quality; 'hd' is high definition. Only one selected quality is downloaded.", "enum": [ "standard", "hd" ], "title": "Quality", "type": "string" }, "video_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video id.", "title": "Video Id" }, "video_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video URL.", "title": "Video Url" } }, "title": "download_tiktok_videoArguments", "type": "object" }, "name": "tiktok.download_video", "outputSchema": { "additionalProperties": true, "properties": { "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type of the downloaded file.", "title": "Content Type" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved agent download session.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the file was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Downloaded file size in bytes.", "title": "File Size Bytes" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "File Url" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "quality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested video quality (standard or hd).", "title": "Quality" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" }, "tiktok_download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique TikTok download operation identifier, prefix td_.", "title": "Tiktok Download Id" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" } }, "title": "DownloadTiktokVideoResponse", "type": "object" } }, { "description": "Fetch for-you feed videos for a region. Requires region.\n\nCost = 4 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 20, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of videos to return (max 20).", "title": "Count" }, "region": { "description": "Region code (for example us, jp, kr).", "maxLength": 8, "title": "Region", "type": "string" } }, "required": [ "region" ], "title": "get_tiktok_for_you_feedArguments", "type": "object" }, "name": "tiktok.for_you_feed", "outputSchema": { "$defs": { "GetTiktokForYouFeedResponseDataItem": { "additionalProperties": true, "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video title or caption.", "title": "Title" }, "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video id.", "title": "Video Id" } }, "title": "GetTiktokForYouFeedResponseDataItem", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "items": { "$ref": "#/$defs/GetTiktokForYouFeedResponseDataItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "For-you feed videos from the upstream provider.", "title": "Data" }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokForYouFeedResponse", "type": "object" } }, { "description": "Look up metadata for a TikTok music track. Provide either music_id or music_url, not both.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "music_id": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok music id.", "title": "Music Id" }, "music_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok music page URL.", "title": "Music Url" } }, "title": "get_tiktok_music_detailsArguments", "type": "object" }, "name": "tiktok.music_details", "outputSchema": { "$defs": { "GetTiktokMusicDetailsResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokMusicDetailsResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokMusicDetailsResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokMusicDetailsResponse", "type": "object" } }, { "description": "List videos that use a TikTok music track. Requires music_id. Pass cursor from a previous response to fetch the next page.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "music_id": { "description": "TikTok music id.", "maxLength": 64, "title": "Music Id", "type": "string" } }, "required": [ "music_id" ], "title": "get_tiktok_music_videosArguments", "type": "object" }, "name": "tiktok.music_videos", "outputSchema": { "$defs": { "GetTiktokMusicVideosResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokMusicVideosResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokMusicVideosResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokMusicVideosResponse", "type": "object" } }, { "description": "Search TikTok photo posts by keyword. Requires query. Pass cursor from a previous response to fetch the next page.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "query": { "description": "Search keywords.", "maxLength": 512, "title": "Query", "type": "string" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Region code (for example us, jp, kr).", "title": "Region" } }, "required": [ "query" ], "title": "search_tiktok_photosArguments", "type": "object" }, "name": "tiktok.search_photos", "outputSchema": { "$defs": { "SearchTiktokPhotosResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "SearchTiktokPhotosResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/SearchTiktokPhotosResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "SearchTiktokPhotosResponse", "type": "object" } }, { "description": "Search TikTok users by keyword. Requires query. Pass cursor from a previous response to fetch the next page.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "follower_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "0", "description": "Follower count filter: 0-4.", "title": "Follower Count" }, "query": { "description": "Search keywords.", "maxLength": 512, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "search_tiktok_usersArguments", "type": "object" }, "name": "tiktok.search_users", "outputSchema": { "$defs": { "SearchTiktokUsersResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "SearchTiktokUsersResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/SearchTiktokUsersResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "SearchTiktokUsersResponse", "type": "object" } }, { "description": "Search TikTok videos by keyword. Requires query. Pass cursor from a previous response to fetch the next page.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "publish_time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Publish time filter: 0, 1, 7, 30, 90, or 180.", "title": "Publish Time" }, "query": { "description": "Search keywords.", "maxLength": 512, "title": "Query", "type": "string" }, "region": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "default": null, "description": "Region code (for example us, jp, kr).", "title": "Region" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "relevance", "description": "Sort order: relevance, like_count, or date_posted.", "title": "Sort By" } }, "required": [ "query" ], "title": "search_tiktok_videosArguments", "type": "object" }, "name": "tiktok.search_videos", "outputSchema": { "$defs": { "SearchTiktokVideosResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "SearchTiktokVideosResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/SearchTiktokVideosResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "SearchTiktokVideosResponse", "type": "object" } }, { "description": "List followers for a TikTok user. Requires user_id. Pass cursor from a previous response to fetch the next page.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 200).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "user_id": { "description": "TikTok numeric user id.", "maxLength": 128, "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "get_tiktok_user_followersArguments", "type": "object" }, "name": "tiktok.user_followers", "outputSchema": { "$defs": { "GetTiktokUserFollowersResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokUserFollowersResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokUserFollowersResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokUserFollowersResponse", "type": "object" } }, { "description": "List accounts a TikTok user follows. Requires user_id. Pass cursor from a previous response to fetch the next page.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 200, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 200).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "user_id": { "description": "TikTok numeric user id.", "maxLength": 128, "title": "User Id", "type": "string" } }, "required": [ "user_id" ], "title": "get_tiktok_user_followingArguments", "type": "object" }, "name": "tiktok.user_following", "outputSchema": { "$defs": { "GetTiktokUserFollowingResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokUserFollowingResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokUserFollowingResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokUserFollowingResponse", "type": "object" } }, { "description": "Look up a TikTok user profile. Provide either user_id or unique_id, not both.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "unique_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok unique id (username).", "title": "Unique Id" }, "user_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok numeric user id.", "title": "User Id" } }, "title": "get_tiktok_user_infoArguments", "type": "object" }, "name": "tiktok.user_info", "outputSchema": { "$defs": { "GetTiktokUserInfoResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokUserInfoResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokUserInfoResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokUserInfoResponse", "type": "object" } }, { "description": "List reposts for a TikTok user. Provide either user_id or unique_id, not both. Pass cursor from a previous response to fetch the next page.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "unique_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok unique id (username).", "title": "Unique Id" }, "user_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok numeric user id.", "title": "User Id" } }, "title": "get_tiktok_user_repostsArguments", "type": "object" }, "name": "tiktok.user_reposts", "outputSchema": { "$defs": { "GetTiktokUserRepostsResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokUserRepostsResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokUserRepostsResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokUserRepostsResponse", "type": "object" } }, { "description": "List videos posted by a TikTok user. Provide either user_id or unique_id, not both. Set latest to true for newest posts or false for top posts. Pass cursor from a previous response to fetch the next page.\n\nCost = 3 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 30, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of items to return (max 30).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "latest": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "description": "When true, return latest videos. When false, return top videos.", "title": "Latest" }, "unique_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok unique id (username).", "title": "Unique Id" }, "user_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok numeric user id.", "title": "User Id" } }, "title": "get_tiktok_user_videosArguments", "type": "object" }, "name": "tiktok.user_videos", "outputSchema": { "$defs": { "GetTiktokUserVideosResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokUserVideosResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokUserVideosResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokUserVideosResponse", "type": "object" } }, { "description": "List comments on a TikTok video. Provide either video_id or video_url, not both. Pass cursor from a previous response to fetch the next page.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "count": { "anyOf": [ { "maximum": 50, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of comments to return (max 50).", "title": "Count" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response.", "title": "Cursor" }, "video_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video id.", "title": "Video Id" }, "video_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video URL.", "title": "Video Url" } }, "title": "get_tiktok_video_commentsArguments", "type": "object" }, "name": "tiktok.video_comments", "outputSchema": { "$defs": { "GetTiktokVideoCommentsResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokVideoCommentsResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokVideoCommentsResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokVideoCommentsResponse", "type": "object" } }, { "description": "Look up metadata for a TikTok video. Provide either video_id or video_url, not both.\n\nCost = 1 token.", "inputSchema": { "properties": { "video_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video id.", "title": "Video Id" }, "video_url": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok video URL.", "title": "Video Url" } }, "title": "get_tiktok_video_detailsArguments", "type": "object" }, "name": "tiktok.video_details", "outputSchema": { "$defs": { "GetTiktokVideoDetailsResponseData": { "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor when returned by the provider.", "title": "Cursor" }, "hasMore": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether additional pages are available.", "title": "Hasmore" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total result count when provided by the upstream provider.", "title": "Total" } }, "title": "GetTiktokVideoDetailsResponseData", "type": "object" } }, "additionalProperties": true, "properties": { "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Upstream status code (0 = success).", "title": "Code" }, "data": { "anyOf": [ { "$ref": "#/$defs/GetTiktokVideoDetailsResponseData" }, { "type": "null" } ], "default": null, "description": "Capability-specific payload from the upstream provider." }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Upstream status message.", "title": "Msg" }, "processed_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Upstream processing time in seconds.", "title": "Processed Time" } }, "title": "GetTiktokVideoDetailsResponse", "type": "object" } }, { "description": "Capture a screenshot of a public website so the user or agent can inspect its layout, content, and UI.\n\nThe image is saved to account file storage. The response includes screenshot_url for API users and download_code for agents to run `vee3-get-file`.\n\nCost = 20 tokens.", "inputSchema": { "properties": { "block_cookie_banners": { "default": false, "description": "When true, attempt to dismiss common cookie consent banners and overlays before capture. Best-effort - custom or first-party banners may remain.", "title": "Block Cookie Banners", "type": "boolean" }, "dark_mode": { "default": false, "description": "When true, emulate prefers-color-scheme: dark so sites with dark-mode CSS render in dark mode. Has no effect on sites without dark-mode styling.", "title": "Dark Mode", "type": "boolean" }, "file_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional account-relative storage path for the screenshot. If omitted, the file is stored under downloads/ with a generated name.", "title": "File Name" }, "format": { "default": "png", "description": "Output image format. 'png' preserves lossless quality (default). 'jpeg' produces smaller files.", "enum": [ "png", "jpeg" ], "title": "Format", "type": "string" }, "full_page": { "default": false, "description": "Capture the full scrollable page. When false, only the viewport area is captured.", "title": "Full Page", "type": "boolean" }, "post_load_wait": { "default": 0, "description": "Extra seconds to wait after wait_until before capturing. Only valid when wait_until is domcontentloaded. Use this instead of networkidle when pages keep network activity.", "maximum": 20, "minimum": 0, "title": "Post Load Wait", "type": "integer" }, "quality": { "default": 80, "description": "JPEG compression quality from 0 (smallest) to 100 (best). Only applies when format is 'jpeg'; ignored for PNG.", "maximum": 100, "minimum": 0, "title": "Quality", "type": "integer" }, "timeout_seconds": { "default": 30, "description": "Maximum seconds to wait for the page to load before failing.", "maximum": 60, "minimum": 5, "title": "Timeout Seconds", "type": "integer" }, "url": { "description": "Public http or https URL to capture. Private, localhost, and internal network addresses are blocked.", "maxLength": 2048, "title": "Url", "type": "string" }, "viewport_height": { "default": 720, "description": "Browser viewport height in pixels.", "maximum": 2160, "minimum": 240, "title": "Viewport Height", "type": "integer" }, "viewport_width": { "default": 1280, "description": "Browser viewport width in pixels.", "maximum": 3840, "minimum": 320, "title": "Viewport Width", "type": "integer" }, "wait_until": { "default": "domcontentloaded", "description": "When to take the screenshot: 'load' (load event), 'domcontentloaded' (DOM ready, faster; use with post_load_wait to let the page settle), or 'networkidle' (no network activity for 500ms; can time out on pages with ongoing requests).", "enum": [ "load", "domcontentloaded", "networkidle" ], "title": "Wait Until", "type": "string" } }, "required": [ "url" ], "title": "capture_website_screenshotArguments", "type": "object" }, "name": "website-screenshots.capture", "outputSchema": { "additionalProperties": true, "properties": { "block_cookie_banners": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Echo of whether cookie banner dismissal was attempted.", "title": "Block Cookie Banners" }, "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested terminal command for downloading to a local path.", "title": "Command" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp.", "title": "Created At" }, "dark_mode": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Echo of whether dark color scheme emulation was used.", "title": "Dark Mode" }, "download_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short code to pass to the @vee3/cli `vee3-get-file` command.", "title": "Download Code" }, "download_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Stable identifier for the reserved download.", "title": "Download Id" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the download code can no longer be resolved (60 minutes after reserve).", "title": "Expires At" }, "file_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account-relative path where the screenshot was stored.", "title": "File Name" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image file size in bytes.", "title": "File Size Bytes" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of the requested output format (png or jpeg).", "title": "Format" }, "full_page": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether full page was captured.", "title": "Full Page" }, "install_command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "One-time command to install the Vee3 CLI (`npm install -g @vee3/cli`). On networks that inspect HTTPS, install may require Node 22.15+ with NODE_OPTIONS=--use-system-ca.", "title": "Install Command" }, "quality": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Echo of JPEG quality used when format is jpeg.", "title": "Quality" }, "retained_until": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when account storage retention expires.", "title": "Retained Until" }, "screenshot_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Unique identifier, prefix ss_.", "title": "Screenshot Id" }, "screenshot_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Signed download URL from account file storage.", "title": "Screenshot Url" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Always \"completed\" for synchronous capture.", "title": "Status" }, "troubleshooting": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "What to do if installation or downloading fails: re-read this tool's description via meta-tools.describe for setup and troubleshooting steps.", "title": "Troubleshooting" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Echo of requested URL.", "title": "Url" }, "viewport_height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Actual viewport height used.", "title": "Viewport Height" }, "viewport_width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Actual viewport width used.", "title": "Viewport Width" } }, "title": "WebsiteScreenshotResponse", "type": "object" } }, { "description": "List X (Twitter) accounts connected to the authenticated Vee3 account for write capabilities.\n\nReturns user_id, user_name, display name, avatar URL, and whether each account is the default. Use user_id or user_name on future write calls, or omit both to use the default account.\n\nIf accounts is empty, the user must connect an X account at https://vee3.io/dashboard/connections before write capabilities work. Agents cannot complete OAuth; ask the user to connect, then call this tool again.\n\nCost = 0 tokens.", "inputSchema": { "properties": {}, "title": "get_x_connected_accountsArguments", "type": "object" }, "name": "x-twitter.connected_accounts", "outputSchema": { "$defs": { "GetXConnectedAccountsResponseAccountsItem": { "additionalProperties": true, "properties": { "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Avatar Url" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name shown on the profile.", "title": "Display Name" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this account is used when user_id and user_name are omitted on write calls.", "title": "Is Default" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id to pass as user_id on write calls.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle without the leading @ to pass as user_name on write calls.", "title": "User Name" } }, "title": "GetXConnectedAccountsResponseAccountsItem", "type": "object" } }, "additionalProperties": true, "properties": { "accounts": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXConnectedAccountsResponseAccountsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Active connected X accounts for the authenticated Vee3 account.", "title": "Accounts" } }, "title": "GetXConnectedAccountsResponse", "type": "object" } }, { "description": "Bookmark a post for a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nCost = 30 tokens.", "inputSchema": { "properties": { "post_id": { "description": "Numeric id of the post to bookmark.", "title": "Post Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "create_x_bookmarkArguments", "type": "object" }, "name": "x-twitter.create_bookmark", "outputSchema": { "additionalProperties": true, "properties": { "bookmarked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is bookmarked after this request.", "title": "Bookmarked" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "CreateXBookmarkResponse", "type": "object" } }, { "description": "Publish a post to a connected X account via the official X API (POST /2/tweets).\n\nCall x-twitter.connected_accounts first. If accounts is empty, the user must connect an X account at https://vee3.io/dashboard/connections before posting. Agents cannot complete OAuth; ask the user to connect, then call x-twitter.connected_accounts again.\n\nPass user_id or user_name to target a specific account, not both. Omit both to use the default connected account.\n\nAt least one of text, poll, media, or card_uri is required.\n\nSupports text, polls, media attachments, reply settings, paid partnership disclosure, AI-generated labels, super-follower exclusivity, nullcast posts, cards, communities, and direct-message deep links.\n\nTo attach media, upload files with files.upload_file and the @vee3/upload CLI, then pass file_name values returned by files.list_uploaded_files in the media array (up to 4 files). Only files listed by list_uploaded_files can be attached. poll, media, and card_uri are mutually exclusive in the X API.\n\nToken pricing: 60 tokens base for text posts. Posts whose text includes a URL are billed 1000 tokens base instead. Attaching only media (an image or video) without a URL in the text does not trigger the URL rate. Each attached image adds 50 tokens. Each attached video adds 150 tokens plus 50 tokens per 5 MB of video size.\n\nX rate limit: 100 POST /2/tweets requests per connected user per 15 minutes. Wait and retry if posting is temporarily blocked.\n\nIf X authorization fails, reconnect the account in the Vee3 dashboard. Read the error message when X rejects a post and adjust the request.", "inputSchema": { "properties": { "card_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Card URI for the post. Mutually exclusive with poll and media.", "title": "Card Uri" }, "community_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Community id when posting to an X community.", "title": "Community Id" }, "direct_message_deep_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deep link that moves the conversation into Direct Messages.", "title": "Direct Message Deep Link" }, "for_super_followers_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is exclusive to super followers.", "title": "For Super Followers Only" }, "made_with_ai": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post contains AI-generated media.", "title": "Made With Ai" }, "media": { "default": null, "description": "File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file and @vee3/upload first, then list_uploaded_files to get the stored file_name values.", "items": { "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Media", "type": "array" }, "nullcast": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is promoted-only and hidden from the public timeline.", "title": "Nullcast" }, "paid_partnership": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is a paid partnership.", "title": "Paid Partnership" }, "poll": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Poll object with options (2-4 strings) and duration_minutes (5-10080).", "title": "Poll" }, "reply_settings": { "anyOf": [ { "enum": [ "following", "mentionedUsers", "subscribers", "verified" ], "type": "string" }, { "type": "null" } ], "default": null, "description": "Who can reply to the post.", "title": "Reply Settings" }, "share_with_followers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to share a community post with followers too.", "title": "Share With Followers" }, "text": { "anyOf": [ { "maxLength": 25000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Post text content. At least one of text, poll, media, or card_uri is required.", "title": "Text" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "title": "create_x_postArguments", "type": "object" }, "name": "x-twitter.create_post", "outputSchema": { "additionalProperties": true, "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Post text returned by the X API.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric id of the created or edited post.", "title": "Tweet Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account that published the post.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account that published the post.", "title": "User Name" } }, "title": "CreateXPostResponse", "type": "object" } }, { "description": "Remove a bookmarked post for a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nCost = 30 tokens.", "inputSchema": { "properties": { "post_id": { "description": "Numeric id of the bookmarked post to remove.", "title": "Post Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "delete_x_bookmarkArguments", "type": "object" }, "name": "x-twitter.delete_bookmark", "outputSchema": { "additionalProperties": true, "properties": { "bookmarked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is bookmarked after this request.", "title": "Bookmarked" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "DeleteXBookmarkResponse", "type": "object" } }, { "description": "Delete a post published by a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nCost = 25 tokens.", "inputSchema": { "properties": { "post_id": { "description": "Numeric id of the post to delete.", "title": "Post Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "delete_x_postArguments", "type": "object" }, "name": "x-twitter.delete_post", "outputSchema": { "additionalProperties": true, "properties": { "deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post was deleted.", "title": "Deleted" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "DeleteXPostResponse", "type": "object" } }, { "description": "Edit a recent post from a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nRequires post_id and at least one of text, media, paid_partnership, or made_with_ai.\n\nEdits must be within X's one-hour window after posting. The authenticated X account may need X Premium for API edits. Posts with polls and some other types cannot be edited. Each edit returns a new post_id.\n\nTo attach media, upload files with files.upload_file and pass file_name values from files.list_uploaded_files.\n\nToken pricing matches x-twitter.create_post: 60 tokens base, 1000 with URL, plus media surcharges.", "inputSchema": { "properties": { "made_with_ai": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post contains AI-generated media.", "title": "Made With Ai" }, "media": { "default": null, "description": "File names from files.list_uploaded_files to attach (up to 4). Upload with files.upload_file first.", "items": { "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Media", "type": "array" }, "paid_partnership": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is a paid partnership.", "title": "Paid Partnership" }, "post_id": { "description": "Numeric id of the post to edit.", "title": "Post Id", "type": "string" }, "text": { "anyOf": [ { "maxLength": 25000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Updated post text.", "title": "Text" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "edit_x_postArguments", "type": "object" }, "name": "x-twitter.edit_post", "outputSchema": { "additionalProperties": true, "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric id of the edited post returned by the X API.", "title": "Post Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Post text returned by the X API.", "title": "Text" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "EditXPostResponse", "type": "object" } }, { "description": "Fetch bookmarked posts for a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nReturns raw X API data with tweet objects, expanded authors, media, polls, and places. Use next_cursor to fetch the next page.\n\nCost = 25 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response next_cursor field.", "title": "Cursor" }, "limit": { "anyOf": [ { "maximum": 100, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum number of bookmarks to return (default 20, max 100).", "title": "Limit" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "title": "get_x_bookmarksArguments", "type": "object" }, "name": "x-twitter.get_bookmarks", "outputSchema": { "$defs": { "GetXBookmarksResponseDataItem": { "additionalProperties": true, "properties": { "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric author user id.", "title": "Author Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Post creation timestamp.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric post id.", "title": "Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Post text.", "title": "Text" } }, "title": "GetXBookmarksResponseDataItem", "type": "object" }, "GetXBookmarksResponseIncludes": { "additionalProperties": true, "properties": { "users": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXBookmarksResponseIncludesUsersItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Expanded user objects.", "title": "Users" } }, "title": "GetXBookmarksResponseIncludes", "type": "object" }, "GetXBookmarksResponseIncludesUsersItem": { "additionalProperties": true, "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric user id.", "title": "Id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle.", "title": "Username" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the user is verified.", "title": "Verified" } }, "title": "GetXBookmarksResponseIncludesUsersItem", "type": "object" } }, "additionalProperties": true, "properties": { "data": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXBookmarksResponseDataItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Bookmarked posts returned by the X API.", "title": "Data" }, "includes": { "anyOf": [ { "$ref": "#/$defs/GetXBookmarksResponseIncludes" }, { "type": "null" } ], "default": null, "description": "Expanded users, media, polls, places, and referenced posts." }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page of bookmarks, when available.", "title": "Next Cursor" }, "result_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of bookmarks in this page.", "title": "Result Count" } }, "title": "GetXBookmarksResponse", "type": "object" } }, { "description": "Reply to a post from a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nRequires reply_to_post_id. Supports the same content options as x-twitter.create_post: text, polls, media, reply settings, paid partnership disclosure, AI-generated labels, super-follower exclusivity, nullcast posts, cards, communities, and direct-message deep links.\n\nAt least one of text, poll, media, or card_uri is required, same as x-twitter.create_post.\n\nToken pricing matches x-twitter.create_post.", "inputSchema": { "properties": { "auto_populate_reply_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to automatically populate reply metadata.", "title": "Auto Populate Reply Metadata" }, "card_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Card URI for the post. Mutually exclusive with poll and media.", "title": "Card Uri" }, "community_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Community id when posting to an X community.", "title": "Community Id" }, "direct_message_deep_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Deep link that moves the conversation into Direct Messages.", "title": "Direct Message Deep Link" }, "exclude_reply_user_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "User ids to exclude from the reply mention list.", "title": "Exclude Reply User Ids" }, "for_super_followers_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is exclusive to super followers.", "title": "For Super Followers Only" }, "made_with_ai": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post contains AI-generated media.", "title": "Made With Ai" }, "media": { "default": null, "description": "File names from files.list_uploaded_files to attach (up to 4).", "items": { "type": "string" }, "maxItems": 4, "minItems": 1, "title": "Media", "type": "array" }, "nullcast": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is promoted-only and hidden from the public timeline.", "title": "Nullcast" }, "paid_partnership": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is a paid partnership.", "title": "Paid Partnership" }, "poll": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Poll object with options (2-4 strings) and duration_minutes (5-10080).", "title": "Poll" }, "reply_settings": { "anyOf": [ { "enum": [ "following", "mentionedUsers", "subscribers", "verified" ], "type": "string" }, { "type": "null" } ], "default": null, "description": "Who can reply to the post.", "title": "Reply Settings" }, "reply_to_post_id": { "description": "Numeric id of the post to reply to.", "title": "Reply To Post Id", "type": "string" }, "share_with_followers": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether to share a community post with followers too.", "title": "Share With Followers" }, "text": { "anyOf": [ { "maxLength": 25000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Reply text content. At least one of text, poll, media, or card_uri is required.", "title": "Text" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "reply_to_post_id" ], "title": "reply_to_x_postArguments", "type": "object" }, "name": "x-twitter.reply_to_post", "outputSchema": { "additionalProperties": true, "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric id of the reply post.", "title": "Post Id" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reply text returned by the X API.", "title": "Text" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "ReplyToXPostResponse", "type": "object" } }, { "description": "Repost a post for a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nReturns the reposted post_id and retweeted status.\n\nCost = 75 tokens.", "inputSchema": { "properties": { "post_id": { "description": "Numeric id of the post to repost.", "title": "Post Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "repost_x_postArguments", "type": "object" }, "name": "x-twitter.repost_post", "outputSchema": { "additionalProperties": true, "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric id of the reposted post.", "title": "Post Id" }, "retweeted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post was reposted.", "title": "Retweeted" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "RepostXPostResponse", "type": "object" } }, { "description": "Search public X (Twitter) posts matching a keyword or phrase.\n\nReturns a timeline of matching posts with tweet text, engagement counts, author info, media, and quoted tweets. Use cursor from next_cursor to fetch the next page. search_type controls ranking: Top (default), Latest, Media, People, or Lists.\n\nCost = 5 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response next_cursor field.", "title": "Cursor" }, "query": { "description": "Search keywords or phrase.", "maxLength": 512, "title": "Query", "type": "string" }, "search_type": { "default": "Top", "description": "Result ranking mode.", "enum": [ "Top", "Latest", "Media", "People", "Lists" ], "title": "Search Type", "type": "string" } }, "required": [ "query" ], "title": "search_xArguments", "type": "object" }, "name": "x-twitter.search", "outputSchema": { "$defs": { "SearchXResponseTimelineItem": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/SearchXResponseTimelineItemAuthor" }, { "type": "null" } ], "default": null, "description": "Author profile summary embedded in the timeline entry." }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Bookmark count.", "title": "Bookmarks" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Conversation thread id for the tweet.", "title": "Conversation Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet creation timestamp from X.", "title": "Created At" }, "display_text_range": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices for the display text range.", "title": "Display Text Range" }, "entities": { "anyOf": [ { "$ref": "#/$defs/SearchXResponseTimelineItemEntities" }, { "type": "null" } ], "default": null, "description": "Parsed entities from the tweet text." }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like count.", "title": "Favorites" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Detected language code.", "title": "Lang" }, "media": { "anyOf": [ { "$ref": "#/$defs/SearchXResponseTimelineItemMedia" }, { "type": "null" } ], "default": null, "description": "Attached media grouped by type (for example video and photo arrays) when present." }, "quoted_tweet": { "anyOf": [ { "$ref": "#/$defs/SearchXResponseTimelineItemQuotedTweet" }, { "type": "null" } ], "default": null, "description": "Quoted tweet summary when the post quotes another tweet." }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Quote count.", "title": "Quotes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Reply count.", "title": "Replies" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Repost count.", "title": "Retweets" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Client or app source string from X.", "title": "Source" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id.", "title": "Tweet Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timeline entry type (for example tweet).", "title": "Type" }, "user_info": { "anyOf": [ { "$ref": "#/$defs/SearchXResponseTimelineItemUserInfo" }, { "type": "null" } ], "default": null, "description": "Embedded author profile for the tweet." }, "views": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "View count when provided by the upstream provider.", "title": "Views" } }, "title": "SearchXResponseTimelineItem", "type": "object" }, "SearchXResponseTimelineItemAuthor": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" } }, "title": "SearchXResponseTimelineItemAuthor", "type": "object" }, "SearchXResponseTimelineItemEntities": { "additionalProperties": true, "properties": { "hashtags": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemEntitiesHashtagsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Hashtags parsed from the tweet text.", "title": "Hashtags" }, "urls": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemEntitiesUrlsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "URLs parsed from the tweet text.", "title": "Urls" }, "user_mentions": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemEntitiesUserMentionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "User mentions parsed from the tweet text.", "title": "User Mentions" } }, "title": "SearchXResponseTimelineItemEntities", "type": "object" }, "SearchXResponseTimelineItemEntitiesHashtagsItem": { "additionalProperties": true, "properties": { "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Hashtag text without the leading #.", "title": "Text" } }, "title": "SearchXResponseTimelineItemEntitiesHashtagsItem", "type": "object" }, "SearchXResponseTimelineItemEntitiesUrlsItem": { "additionalProperties": true, "properties": { "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display-friendly URL.", "title": "Display Url" }, "expanded_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Expanded destination URL.", "title": "Expanded Url" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short or display URL.", "title": "Url" } }, "title": "SearchXResponseTimelineItemEntitiesUrlsItem", "type": "object" }, "SearchXResponseTimelineItemEntitiesUserMentionsItem": { "additionalProperties": true, "properties": { "id_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user id.", "title": "Id Str" }, "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user display name.", "title": "Name" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user handle without the leading @.", "title": "Screen Name" } }, "title": "SearchXResponseTimelineItemEntitiesUserMentionsItem", "type": "object" }, "SearchXResponseTimelineItemMedia": { "additionalProperties": true, "properties": { "photo": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemMediaPhotoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Photo media items when present.", "title": "Photo" }, "video": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemMediaVideoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video media items when present.", "title": "Video" } }, "title": "SearchXResponseTimelineItemMedia", "type": "object" }, "SearchXResponseTimelineItemMediaPhotoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the photo asset.", "title": "Media Url Https" } }, "title": "SearchXResponseTimelineItemMediaPhotoItem", "type": "object" }, "SearchXResponseTimelineItemMediaVideoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the video thumbnail or asset.", "title": "Media Url Https" }, "variants": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItemMediaVideoItemVariantsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Available video quality variants when present.", "title": "Variants" } }, "title": "SearchXResponseTimelineItemMediaVideoItem", "type": "object" }, "SearchXResponseTimelineItemMediaVideoItemVariantsItem": { "additionalProperties": true, "properties": { "bitrate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video bitrate when provided.", "title": "Bitrate" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type for the media variant.", "title": "Content Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the media variant.", "title": "Url" } }, "title": "SearchXResponseTimelineItemMediaVideoItemVariantsItem", "type": "object" }, "SearchXResponseTimelineItemQuotedTweet": { "additionalProperties": true, "properties": { "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet author handle.", "title": "Screen Name" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id for the quoted post.", "title": "Tweet Id" } }, "title": "SearchXResponseTimelineItemQuotedTweet", "type": "object" }, "SearchXResponseTimelineItemUserInfo": { "additionalProperties": true, "properties": { "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Avatar" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Follower count when provided by the upstream provider.", "title": "Followers Count" }, "friends_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Following count when provided by the upstream provider.", "title": "Friends Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the author account is verified.", "title": "Verified" } }, "title": "SearchXResponseTimelineItemUserInfo", "type": "object" } }, "additionalProperties": true, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next results page, when available.", "title": "Next Cursor" }, "prev_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the previous results page, when available.", "title": "Prev Cursor" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Search status from the upstream provider (ok on success).", "title": "Status" }, "timeline": { "anyOf": [ { "items": { "$ref": "#/$defs/SearchXResponseTimelineItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Matching posts from the search. Additional provider-specific fields may appear on each entry.", "title": "Timeline" } }, "title": "SearchXResponse", "type": "object" } }, { "description": "Fetch metadata for a single public X (Twitter) post by its numeric tweet id.\n\nReturns tweet text, engagement counts (likes, retweets, replies, quotes, bookmarks), language, conversation id, author profile summary, and attached media when present.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "id": { "description": "Numeric tweet id.", "maxLength": 32, "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "get_x_tweet_infoArguments", "type": "object" }, "name": "x-twitter.tweet_info", "outputSchema": { "$defs": { "GetXTweetInfoResponseAuthor": { "additionalProperties": true, "properties": { "blue_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the author has X blue verification.", "title": "Blue Verified" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Image" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" } }, "title": "GetXTweetInfoResponseAuthor", "type": "object" }, "GetXTweetInfoResponseMedia": { "additionalProperties": true, "properties": { "photo": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetInfoResponseMediaPhotoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Photo media items when present.", "title": "Photo" }, "video": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetInfoResponseMediaVideoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video media items when present.", "title": "Video" } }, "title": "GetXTweetInfoResponseMedia", "type": "object" }, "GetXTweetInfoResponseMediaPhotoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the photo asset.", "title": "Media Url Https" } }, "title": "GetXTweetInfoResponseMediaPhotoItem", "type": "object" }, "GetXTweetInfoResponseMediaVideoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the video thumbnail or asset.", "title": "Media Url Https" }, "variants": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetInfoResponseMediaVideoItemVariantsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Available video quality variants when present.", "title": "Variants" } }, "title": "GetXTweetInfoResponseMediaVideoItem", "type": "object" }, "GetXTweetInfoResponseMediaVideoItemVariantsItem": { "additionalProperties": true, "properties": { "bitrate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video bitrate when provided.", "title": "Bitrate" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type for the media variant.", "title": "Content Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the media variant.", "title": "Url" } }, "title": "GetXTweetInfoResponseMediaVideoItemVariantsItem", "type": "object" } }, "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/GetXTweetInfoResponseAuthor" }, { "type": "null" } ], "default": null, "description": "Author profile summary for the tweet." }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Bookmark count.", "title": "Bookmarks" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Conversation thread id for the tweet.", "title": "Conversation Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet creation timestamp from X.", "title": "Created At" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id.", "title": "Id" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Detected language code.", "title": "Lang" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like count.", "title": "Likes" }, "media": { "anyOf": [ { "$ref": "#/$defs/GetXTweetInfoResponseMedia" }, { "type": "null" } ], "default": null, "description": "Attached media grouped by type (for example photo or video arrays). Additional provider-specific media fields may appear." }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Quote count.", "title": "Quotes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Reply count.", "title": "Replies" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Repost count.", "title": "Retweets" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet body text.", "title": "Text" } }, "title": "GetXTweetInfoResponse", "type": "object" } }, { "description": "Fetch the latest replies for a single X (Twitter) post by its numeric tweet id.\n\nReturns a timeline of reply tweets with text, engagement counts, author info, media, and in-reply-to metadata. Use cursor from next_cursor to fetch the next page.\n\nCost = 4 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response next_cursor field.", "title": "Cursor" }, "id": { "description": "Numeric tweet id.", "maxLength": 32, "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "get_x_tweet_repliesArguments", "type": "object" }, "name": "x-twitter.tweet_replies", "outputSchema": { "$defs": { "GetXTweetRepliesResponseTimelineItem": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemAuthor" }, { "type": "null" } ], "default": null, "description": "Author profile summary embedded in the timeline entry." }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Bookmark count.", "title": "Bookmarks" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Conversation thread id for the tweet.", "title": "Conversation Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet creation timestamp from X.", "title": "Created At" }, "display_text_range": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices for the display text range.", "title": "Display Text Range" }, "entities": { "anyOf": [ { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemEntities" }, { "type": "null" } ], "default": null, "description": "Parsed entities from the tweet text." }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like count.", "title": "Favorites" }, "in_reply_to_screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Handle of the user being replied to.", "title": "In Reply To Screen Name" }, "in_reply_to_status_id_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet id of the post being replied to.", "title": "In Reply To Status Id Str" }, "in_reply_to_user_id_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "User id of the account being replied to.", "title": "In Reply To User Id Str" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Detected language code.", "title": "Lang" }, "media": { "anyOf": [ { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemMedia" }, { "type": "null" } ], "default": null, "description": "Attached media grouped by type (for example video and photo arrays) when present." }, "quoted_tweet": { "anyOf": [ { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemQuotedTweet" }, { "type": "null" } ], "default": null, "description": "Quoted tweet summary when the post quotes another tweet." }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Quote count.", "title": "Quotes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Reply count.", "title": "Replies" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Repost count.", "title": "Retweets" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Client or app source string from X.", "title": "Source" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id.", "title": "Tweet Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timeline entry type (for example tweet).", "title": "Type" }, "user_info": { "anyOf": [ { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemUserInfo" }, { "type": "null" } ], "default": null, "description": "Embedded author profile for the tweet." }, "views": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "View count when provided by the upstream provider.", "title": "Views" } }, "title": "GetXTweetRepliesResponseTimelineItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemAuthor": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" } }, "title": "GetXTweetRepliesResponseTimelineItemAuthor", "type": "object" }, "GetXTweetRepliesResponseTimelineItemEntities": { "additionalProperties": true, "properties": { "hashtags": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Hashtags parsed from the tweet text.", "title": "Hashtags" }, "urls": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "URLs parsed from the tweet text.", "title": "Urls" }, "user_mentions": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "User mentions parsed from the tweet text.", "title": "User Mentions" } }, "title": "GetXTweetRepliesResponseTimelineItemEntities", "type": "object" }, "GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem": { "additionalProperties": true, "properties": { "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Hashtag text without the leading #.", "title": "Text" } }, "title": "GetXTweetRepliesResponseTimelineItemEntitiesHashtagsItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem": { "additionalProperties": true, "properties": { "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display-friendly URL.", "title": "Display Url" }, "expanded_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Expanded destination URL.", "title": "Expanded Url" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short or display URL.", "title": "Url" } }, "title": "GetXTweetRepliesResponseTimelineItemEntitiesUrlsItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem": { "additionalProperties": true, "properties": { "id_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user id.", "title": "Id Str" }, "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user display name.", "title": "Name" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user handle without the leading @.", "title": "Screen Name" } }, "title": "GetXTweetRepliesResponseTimelineItemEntitiesUserMentionsItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemMedia": { "additionalProperties": true, "properties": { "photo": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemMediaPhotoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Photo media items when present.", "title": "Photo" }, "video": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemMediaVideoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video media items when present.", "title": "Video" } }, "title": "GetXTweetRepliesResponseTimelineItemMedia", "type": "object" }, "GetXTweetRepliesResponseTimelineItemMediaPhotoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the photo asset.", "title": "Media Url Https" } }, "title": "GetXTweetRepliesResponseTimelineItemMediaPhotoItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemMediaVideoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the video thumbnail or asset.", "title": "Media Url Https" }, "variants": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Available video quality variants when present.", "title": "Variants" } }, "title": "GetXTweetRepliesResponseTimelineItemMediaVideoItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem": { "additionalProperties": true, "properties": { "bitrate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video bitrate when provided.", "title": "Bitrate" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type for the media variant.", "title": "Content Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the media variant.", "title": "Url" } }, "title": "GetXTweetRepliesResponseTimelineItemMediaVideoItemVariantsItem", "type": "object" }, "GetXTweetRepliesResponseTimelineItemQuotedTweet": { "additionalProperties": true, "properties": { "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet author handle.", "title": "Screen Name" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id for the quoted post.", "title": "Tweet Id" } }, "title": "GetXTweetRepliesResponseTimelineItemQuotedTweet", "type": "object" }, "GetXTweetRepliesResponseTimelineItemUserInfo": { "additionalProperties": true, "properties": { "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Avatar" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Follower count when provided by the upstream provider.", "title": "Followers Count" }, "friends_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Following count when provided by the upstream provider.", "title": "Friends Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the author account is verified.", "title": "Verified" } }, "title": "GetXTweetRepliesResponseTimelineItemUserInfo", "type": "object" } }, "additionalProperties": true, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next replies page, when available.", "title": "Next Cursor" }, "prev_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the previous replies page, when available.", "title": "Prev Cursor" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Reply fetch status from the upstream provider (ok on success).", "title": "Status" }, "timeline": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXTweetRepliesResponseTimelineItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Reply tweets, newest first. Additional provider-specific fields may appear on each entry.", "title": "Timeline" } }, "title": "GetXTweetRepliesResponse", "type": "object" } }, { "description": "Remove a repost for a connected X account.\n\nCall x-twitter.connected_accounts first. Pass user_id or user_name to target a specific account, or omit both to use the default account.\n\nCost = 50 tokens.", "inputSchema": { "properties": { "post_id": { "description": "Numeric id of the original post to unrepost.", "title": "Post Id", "type": "string" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id from x-twitter.connected_accounts. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle from x-twitter.connected_accounts, with or without a leading @. Pass user_id or user_name to target a specific account, not both. Omit both to use the default account.", "title": "User Name" } }, "required": [ "post_id" ], "title": "unrepost_x_postArguments", "type": "object" }, "name": "x-twitter.unrepost_post", "outputSchema": { "additionalProperties": true, "properties": { "retweeted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the post is still reposted after this request.", "title": "Retweeted" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id of the connected account.", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle of the connected account.", "title": "User Name" } }, "title": "UnrepostXPostResponse", "type": "object" } }, { "description": "Fetch public profile metadata for an X (Twitter) user.\n\nProvide user_name (handle without @) or rest_id (numeric user id). At least one is required. When rest_id is set, it takes precedence over user_name. Returns display name, bio, follower counts, verification flags, avatar URLs, and related profile fields.\n\nCost = 2 tokens.", "inputSchema": { "properties": { "rest_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id (rest_id). When provided, user_name is ignored.", "title": "Rest Id" }, "user_name": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.", "title": "User Name" } }, "title": "get_x_user_infoArguments", "type": "object" }, "name": "x-twitter.user_info", "outputSchema": { "$defs": { "GetXUserInfoResponseAffiliates": { "additionalProperties": true, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliate description text when provided.", "title": "Description" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Affiliate profile or badge URL when provided.", "title": "Url" } }, "title": "GetXUserInfoResponseAffiliates", "type": "object" }, "GetXUserInfoResponseBusinessAccount": { "additionalProperties": true, "properties": { "affiliates_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of affiliate accounts when provided.", "title": "Affiliates Count" }, "category": { "anyOf": [ { "$ref": "#/$defs/GetXUserInfoResponseBusinessAccountCategory" }, { "type": "null" } ], "default": null, "description": "Business category metadata when provided." } }, "title": "GetXUserInfoResponseBusinessAccount", "type": "object" }, "GetXUserInfoResponseBusinessAccountCategory": { "additionalProperties": true, "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business category id.", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business category name.", "title": "Name" } }, "title": "GetXUserInfoResponseBusinessAccountCategory", "type": "object" } }, "additionalProperties": true, "properties": { "affiliates": { "anyOf": [ { "$ref": "#/$defs/GetXUserInfoResponseAffiliates" }, { "type": "null" } ], "default": null, "description": "Affiliate account metadata when present (object or empty array from the provider). Additional provider-specific fields may appear." }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Avatar" }, "blue_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the account has X blue verification.", "title": "Blue Verified" }, "business_account": { "anyOf": [ { "$ref": "#/$defs/GetXUserInfoResponseBusinessAccount" }, { "type": "null" } ], "default": null, "description": "Business account metadata when present (object with counts or empty array from the provider when not applicable)." }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account creation timestamp from X.", "title": "Created At" }, "desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile bio / description.", "title": "Desc" }, "friends": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of accounts the user follows.", "title": "Friends" }, "header_image": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile banner image URL.", "title": "Header Image" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id (may duplicate rest_id).", "title": "Id" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile location string.", "title": "Location" }, "media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total media item count.", "title": "Media Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name shown on the profile.", "title": "Name" }, "pinned_tweet_ids_str": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Pinned tweet ids for the profile when present.", "title": "Pinned Tweet Ids Str" }, "profile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X screen name (handle).", "title": "Profile" }, "protected": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the account is protected (private).", "title": "Protected" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile lookup status from the upstream provider.", "title": "Status" }, "statuses_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total post count.", "title": "Statuses Count" }, "sub_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Follower count.", "title": "Sub Count" }, "verification_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Verification type label from X when present.", "title": "Verification Type" } }, "title": "GetXUserInfoResponse", "type": "object" } }, { "description": "Fetch a user's recent X (Twitter) posts, pinned tweet, and profile summary.\n\nProvide user_name (handle without @) or rest_id (numeric user id). At least one is required. When rest_id is set, it takes precedence over user_name. Returns timeline entries with tweet text, engagement counts, media, quoted tweets, and author info. Use cursor from next_cursor to fetch the next page.\n\nCost = 4 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response next_cursor field.", "title": "Cursor" }, "rest_id": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id (rest_id). When provided, user_name is ignored.", "title": "Rest Id" }, "user_name": { "anyOf": [ { "maxLength": 50, "type": "string" }, { "type": "null" } ], "default": null, "description": "X handle without the leading @ (for example elonmusk). Required when rest_id is omitted.", "title": "User Name" } }, "title": "get_x_user_timelineArguments", "type": "object" }, "name": "x-twitter.user_timeline", "outputSchema": { "$defs": { "GetXUserTimelineResponsePinned": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponsePinnedAuthor" }, { "type": "null" } ], "default": null, "description": "Author profile summary for the pinned tweet." }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like count.", "title": "Favorites" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Repost count.", "title": "Retweets" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinned tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id for the pinned post.", "title": "Tweet Id" } }, "title": "GetXUserTimelineResponsePinned", "type": "object" }, "GetXUserTimelineResponsePinnedAuthor": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" } }, "title": "GetXUserTimelineResponsePinnedAuthor", "type": "object" }, "GetXUserTimelineResponseTimelineItem": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemAuthor" }, { "type": "null" } ], "default": null, "description": "Author profile summary embedded in the timeline entry." }, "bookmarks": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Bookmark count.", "title": "Bookmarks" }, "conversation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Conversation thread id for the tweet.", "title": "Conversation Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet creation timestamp from X.", "title": "Created At" }, "display_text_range": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices for the display text range.", "title": "Display Text Range" }, "entities": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemEntities" }, { "type": "null" } ], "default": null, "description": "Parsed entities from the tweet text." }, "favorites": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like count.", "title": "Favorites" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Detected language code.", "title": "Lang" }, "media": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemMedia" }, { "type": "null" } ], "default": null, "description": "Attached media grouped by type (for example video and photo arrays) when present." }, "quoted_tweet": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemQuotedTweet" }, { "type": "null" } ], "default": null, "description": "Quoted tweet summary when the post quotes another tweet." }, "quotes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Quote count.", "title": "Quotes" }, "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Reply count.", "title": "Replies" }, "retweets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Repost count.", "title": "Retweets" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Client or app source string from X.", "title": "Source" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id.", "title": "Tweet Id" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timeline entry type (for example tweet).", "title": "Type" }, "user_info": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemUserInfo" }, { "type": "null" } ], "default": null, "description": "Embedded author profile for the tweet." }, "views": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "View count when provided by the upstream provider.", "title": "Views" } }, "title": "GetXUserTimelineResponseTimelineItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemAuthor": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" } }, "title": "GetXUserTimelineResponseTimelineItemAuthor", "type": "object" }, "GetXUserTimelineResponseTimelineItemEntities": { "additionalProperties": true, "properties": { "hashtags": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Hashtags parsed from the tweet text.", "title": "Hashtags" }, "urls": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemEntitiesUrlsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "URLs parsed from the tweet text.", "title": "Urls" }, "user_mentions": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "User mentions parsed from the tweet text.", "title": "User Mentions" } }, "title": "GetXUserTimelineResponseTimelineItemEntities", "type": "object" }, "GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem": { "additionalProperties": true, "properties": { "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Hashtag text without the leading #.", "title": "Text" } }, "title": "GetXUserTimelineResponseTimelineItemEntitiesHashtagsItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemEntitiesUrlsItem": { "additionalProperties": true, "properties": { "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display-friendly URL.", "title": "Display Url" }, "expanded_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Expanded destination URL.", "title": "Expanded Url" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short or display URL.", "title": "Url" } }, "title": "GetXUserTimelineResponseTimelineItemEntitiesUrlsItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem": { "additionalProperties": true, "properties": { "id_str": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user id.", "title": "Id Str" }, "indices": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Start and end character indices in the tweet text.", "title": "Indices" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user display name.", "title": "Name" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mentioned user handle without the leading @.", "title": "Screen Name" } }, "title": "GetXUserTimelineResponseTimelineItemEntitiesUserMentionsItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemMedia": { "additionalProperties": true, "properties": { "photo": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemMediaPhotoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Photo media items when present.", "title": "Photo" }, "video": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemMediaVideoItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video media items when present.", "title": "Video" } }, "title": "GetXUserTimelineResponseTimelineItemMedia", "type": "object" }, "GetXUserTimelineResponseTimelineItemMediaPhotoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the photo asset.", "title": "Media Url Https" } }, "title": "GetXUserTimelineResponseTimelineItemMediaPhotoItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemMediaVideoItem": { "additionalProperties": true, "properties": { "media_url_https": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the video thumbnail or asset.", "title": "Media Url Https" }, "variants": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Available video quality variants when present.", "title": "Variants" } }, "title": "GetXUserTimelineResponseTimelineItemMediaVideoItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem": { "additionalProperties": true, "properties": { "bitrate": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video bitrate when provided.", "title": "Bitrate" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "MIME type for the media variant.", "title": "Content Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "HTTPS URL for the media variant.", "title": "Url" } }, "title": "GetXUserTimelineResponseTimelineItemMediaVideoItemVariantsItem", "type": "object" }, "GetXUserTimelineResponseTimelineItemQuotedTweet": { "additionalProperties": true, "properties": { "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet author handle.", "title": "Screen Name" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quoted tweet body text.", "title": "Text" }, "tweet_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric tweet id for the quoted post.", "title": "Tweet Id" } }, "title": "GetXUserTimelineResponseTimelineItemQuotedTweet", "type": "object" }, "GetXUserTimelineResponseTimelineItemUserInfo": { "additionalProperties": true, "properties": { "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Profile avatar image URL.", "title": "Avatar" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Follower count when provided by the upstream provider.", "title": "Followers Count" }, "friends_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Following count when provided by the upstream provider.", "title": "Friends Count" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author display name.", "title": "Name" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "screen_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Author handle without the leading @.", "title": "Screen Name" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the author account is verified.", "title": "Verified" } }, "title": "GetXUserTimelineResponseTimelineItemUserInfo", "type": "object" }, "GetXUserTimelineResponseUser": { "additionalProperties": true, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Display name shown on the profile.", "title": "Name" }, "profile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "X screen name (handle).", "title": "Profile" }, "rest_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Numeric X user id.", "title": "Rest Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Account status from the upstream provider.", "title": "Status" }, "sub_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Follower count.", "title": "Sub Count" } }, "title": "GetXUserTimelineResponseUser", "type": "object" } }, "additionalProperties": true, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next timeline page, when available.", "title": "Next Cursor" }, "pinned": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponsePinned" }, { "type": "null" } ], "default": null, "description": "Pinned tweet object when the user has one pinned post." }, "prev_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the previous timeline page, when available.", "title": "Prev Cursor" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Timeline fetch status from the upstream provider (ok on success).", "title": "Status" }, "timeline": { "anyOf": [ { "items": { "$ref": "#/$defs/GetXUserTimelineResponseTimelineItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Recent posts from the user. Additional provider-specific fields may appear on each entry.", "title": "Timeline" }, "user": { "anyOf": [ { "$ref": "#/$defs/GetXUserTimelineResponseUser" }, { "type": "null" } ], "default": null, "description": "Profile summary for the requested user." } }, "title": "GetXUserTimelineResponse", "type": "object" } }, { "description": "Fetch metadata for a public YouTube channel by channel id or URL.\n\nAccepts a channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg) or common YouTube channel URLs (for example https://www.youtube.com/@WWE). Returns title, username, description, subscriber and view counts, join date, verification flags, avatar and banner images, keywords, and external links.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "channel_id": { "description": "YouTube channel id or URL (for example UCJ5v_MCY6GNUBTO8-D3XoAg or https://www.youtube.com/@WWE).", "maxLength": 2048, "title": "Channel Id", "type": "string" } }, "required": [ "channel_id" ], "title": "get_youtube_channel_detailsArguments", "type": "object" }, "name": "youtube.channel_details", "outputSchema": { "$defs": { "YoutubeChannelDetailsResponseAvatarItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelDetailsResponseAvatarItem", "type": "object" }, "YoutubeChannelDetailsResponseBadgesItem": { "additionalProperties": true, "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge label.", "title": "Text" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge type code.", "title": "Type" } }, "title": "YoutubeChannelDetailsResponseBadgesItem", "type": "object" }, "YoutubeChannelDetailsResponseBanner": { "additionalProperties": true, "properties": { "desktop": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseBannerDesktopItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Desktop banner images.", "title": "Desktop" }, "mobile": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseBannerMobileItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Mobile banner images.", "title": "Mobile" }, "tv": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseBannerTvItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "TV banner images.", "title": "Tv" } }, "title": "YoutubeChannelDetailsResponseBanner", "type": "object" }, "YoutubeChannelDetailsResponseBannerDesktopItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelDetailsResponseBannerDesktopItem", "type": "object" }, "YoutubeChannelDetailsResponseBannerMobileItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelDetailsResponseBannerMobileItem", "type": "object" }, "YoutubeChannelDetailsResponseBannerTvItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelDetailsResponseBannerTvItem", "type": "object" }, "YoutubeChannelDetailsResponseLinksItem": { "additionalProperties": true, "properties": { "icon": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseLinksItemIconItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Favicon images at different sizes.", "title": "Icon" }, "targetUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Destination URL.", "title": "Targeturl" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Link label shown on the channel About page.", "title": "Title" } }, "title": "YoutubeChannelDetailsResponseLinksItem", "type": "object" }, "YoutubeChannelDetailsResponseLinksItemIconItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelDetailsResponseLinksItemIconItem", "type": "object" }, "YoutubeChannelDetailsResponseStats": { "additionalProperties": true, "properties": { "subscribers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Subscriber count.", "title": "Subscribers" }, "subscribersText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted subscriber count.", "title": "Subscriberstext" }, "videos": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Published video count.", "title": "Videos" }, "videosText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Formatted video count when available.", "title": "Videostext" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Lifetime view count.", "title": "Views" } }, "title": "YoutubeChannelDetailsResponseStats", "type": "object" } }, "additionalProperties": true, "properties": { "artistBio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Artist bio text when the channel is a music artist.", "title": "Artistbio" }, "avatar": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseAvatarItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Channel avatar images at different sizes.", "title": "Avatar" }, "badges": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseBadgesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Channel badges (for example Official Artist Channel).", "title": "Badges" }, "banner": { "anyOf": [ { "$ref": "#/$defs/YoutubeChannelDetailsResponseBanner" }, { "type": "null" } ], "default": null, "description": "Channel banner images for desktop, mobile, and TV layouts." }, "canonicalBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical channel path on YouTube when available.", "title": "Canonicalbaseurl" }, "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical YouTube channel id.", "title": "Channelid" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Country associated with the channel when available.", "title": "Country" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel About description.", "title": "Description" }, "hasBusinessEmail": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether a business email is available for contact.", "title": "Hasbusinessemail" }, "isFamilySafe": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the channel is marked family safe.", "title": "Isfamilysafe" }, "isVerified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the channel is verified.", "title": "Isverified" }, "isVerifiedArtist": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the channel is a verified artist channel.", "title": "Isverifiedartist" }, "joinedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel creation date (ISO 8601).", "title": "Joineddate" }, "joinedDateText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable join date.", "title": "Joineddatetext" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Channel keywords from the About page.", "title": "Keywords" }, "links": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelDetailsResponseLinksItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "External links listed on the channel About page.", "title": "Links" }, "stats": { "anyOf": [ { "$ref": "#/$defs/YoutubeChannelDetailsResponseStats" }, { "type": "null" } ], "default": null, "description": "Public channel statistics." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel display name.", "title": "Title" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Public @ handle when available.", "title": "Username" } }, "title": "YoutubeChannelDetailsResponse", "type": "object" } }, { "description": "Search public videos on a YouTube channel by keyword or phrase.\n\nAccepts a bare channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg), not a URL. Returns matching video entries and cursorNext for pagination.\n\nUse cursorNext from a prior response as cursor for the next page.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "channel_id": { "description": "YouTube channel id (for example UCJ5v_MCY6GNUBTO8-D3XoAg, not a URL).", "maxLength": 24, "title": "Channel Id", "type": "string" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursorNext.", "title": "Cursor" }, "query": { "description": "Search keywords or phrase within the channel.", "maxLength": 512, "title": "Query", "type": "string" } }, "required": [ "channel_id", "query" ], "title": "search_youtube_channelArguments", "type": "object" }, "name": "youtube.channel_search", "outputSchema": { "$defs": { "YoutubeChannelSearchResponseContentsItem": { "additionalProperties": true, "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Result entry type (for example video).", "title": "Type" }, "video": { "anyOf": [ { "$ref": "#/$defs/YoutubeChannelSearchResponseContentsItemVideo" }, { "type": "null" } ], "default": null, "description": "Video payload when type is video." } }, "title": "YoutubeChannelSearchResponseContentsItem", "type": "object" }, "YoutubeChannelSearchResponseContentsItemVideo": { "additionalProperties": true, "properties": { "badges": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video badges (for example CC, 4K).", "title": "Badges" }, "descriptionSnippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Short description excerpt for the video.", "title": "Descriptionsnippet" }, "isLiveNow": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the video is live.", "title": "Islivenow" }, "lengthSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video duration in seconds.", "title": "Lengthseconds" }, "publishedTimeText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable publish age.", "title": "Publishedtimetext" }, "stats": { "anyOf": [ { "$ref": "#/$defs/YoutubeChannelSearchResponseContentsItemVideoStats" }, { "type": "null" } ], "default": null, "description": "View counts for the video." }, "thumbnails": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Static thumbnail images at different sizes.", "title": "Thumbnails" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video title.", "title": "Title" }, "videoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video id.", "title": "Videoid" } }, "title": "YoutubeChannelSearchResponseContentsItemVideo", "type": "object" }, "YoutubeChannelSearchResponseContentsItemVideoStats": { "additionalProperties": true, "properties": { "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "View count.", "title": "Views" } }, "title": "YoutubeChannelSearchResponseContentsItemVideoStats", "type": "object" }, "YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelSearchResponseContentsItemVideoThumbnailsItem", "type": "object" } }, "additionalProperties": true, "properties": { "contents": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelSearchResponseContentsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Matching video entries for the current page. Each entry includes a type field and nested video object.", "title": "Contents" }, "cursorNext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page, when available.", "title": "Cursornext" } }, "title": "YoutubeChannelSearchResponse", "type": "object" } }, { "description": "Fetch a paginated list of videos from a public YouTube channel by its channel id.\n\nAccepts a channel id (for example UCg6gPGh8HU2U01vaFCAsvmQ) or common YouTube channel URLs (for example https://www.youtube.com/@ChrisTitusTech). Use cursor from a prior response for the next page.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "channel_id": { "description": "YouTube channel id or URL (for example UCg6gPGh8HU2U01vaFCAsvmQ or https://www.youtube.com/@ChrisTitusTech).", "maxLength": 2048, "title": "Channel Id", "type": "string" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response cursor field.", "title": "Cursor" } }, "required": [ "channel_id" ], "title": "get_youtube_channel_videosArguments", "type": "object" }, "name": "youtube.channel_videos", "outputSchema": { "$defs": { "YoutubeChannelVideosResponseVideosItem": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel display name.", "title": "Author" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary category label when available.", "title": "Category" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Uploader channel id.", "title": "Channel Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video description when available.", "title": "Description" }, "is_live_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Whether the video is live content when available.", "title": "Is Live Content" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video keyword tags.", "title": "Keywords" }, "number_of_views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "View count.", "title": "Number Of Views" }, "published_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable publish time.", "title": "Published Time" }, "thumbnails": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelVideosResponseVideosItemThumbnailsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video thumbnail images at different sizes.", "title": "Thumbnails" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video title.", "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video type (for example NORMAL).", "title": "Type" }, "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video id.", "title": "Video Id" }, "video_length": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video duration (for example 17:19).", "title": "Video Length" } }, "title": "YoutubeChannelVideosResponseVideosItem", "type": "object" }, "YoutubeChannelVideosResponseVideosItemThumbnailsItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeChannelVideosResponseVideosItemThumbnailsItem", "type": "object" } }, "additionalProperties": true, "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next page, when available.", "title": "Cursor" }, "videos": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeChannelVideosResponseVideosItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Channel videos for the current page.", "title": "Videos" } }, "title": "YoutubeChannelVideosResponse", "type": "object" } }, { "description": "Fetch metadata for a public YouTube playlist by playlist id.\n\nReturns title, description, creator summary, video and view counts, thumbnails, badges, and last updated timestamps.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "playlist_id": { "description": "YouTube playlist id (for example PLcirGkCPmbmFeQ1sm4wFciF03D_EroIfr).", "maxLength": 512, "title": "Playlist Id", "type": "string" } }, "required": [ "playlist_id" ], "title": "get_youtube_playlist_detailsArguments", "type": "object" }, "name": "youtube.playlist_details", "outputSchema": { "$defs": { "YoutubePlaylistDetailsResponseAuthor": { "additionalProperties": true, "properties": { "avatar": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubePlaylistDetailsResponseAuthorAvatarItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Creator avatar images at different sizes.", "title": "Avatar" }, "canonicalBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical channel path on YouTube when available.", "title": "Canonicalbaseurl" }, "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Creator channel id.", "title": "Channelid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Playlist creator display name.", "title": "Title" } }, "title": "YoutubePlaylistDetailsResponseAuthor", "type": "object" }, "YoutubePlaylistDetailsResponseAuthorAvatarItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubePlaylistDetailsResponseAuthorAvatarItem", "type": "object" }, "YoutubePlaylistDetailsResponseBadgesItem": { "additionalProperties": true, "properties": { "badge": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge label.", "title": "Badge" } }, "title": "YoutubePlaylistDetailsResponseBadgesItem", "type": "object" }, "YoutubePlaylistDetailsResponseStats": { "additionalProperties": true, "properties": { "videos": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of videos in the playlist.", "title": "Videos" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total playlist view count.", "title": "Views" } }, "title": "YoutubePlaylistDetailsResponseStats", "type": "object" }, "YoutubePlaylistDetailsResponseThumbnailsItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubePlaylistDetailsResponseThumbnailsItem", "type": "object" } }, "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/YoutubePlaylistDetailsResponseAuthor" }, { "type": "null" } ], "default": null, "description": "Playlist creator summary." }, "badges": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubePlaylistDetailsResponseBadgesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Playlist badges when available.", "title": "Badges" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Playlist description.", "title": "Description" }, "playlistId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical YouTube playlist id.", "title": "Playlistid" }, "stats": { "anyOf": [ { "$ref": "#/$defs/YoutubePlaylistDetailsResponseStats" }, { "type": "null" } ], "default": null, "description": "Public playlist statistics." }, "thumbnails": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubePlaylistDetailsResponseThumbnailsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Playlist thumbnail images at different sizes.", "title": "Thumbnails" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Playlist title.", "title": "Title" }, "updatedTime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Last update date (ISO 8601).", "title": "Updatedtime" }, "updatedTimeText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable last update time.", "title": "Updatedtimetext" } }, "title": "YoutubePlaylistDetailsResponse", "type": "object" } }, { "description": "Search public YouTube content by keyword or phrase.\n\nReturns matching result cards, estimated result count, and spelling suggestions.\n\nUse filter parameters to apply multiple YouTube search filters:\n- upload_date: Last hour, Today, This week, This month, This year\n- content_type: Video, Channel, Playlist, Movie\n- duration: Under 4 minutes, 4 - 20 minutes, Over 20 minutes\n- features: Live, 4K, HD, Subtitles/CC, Creative Commons, 360°, VR180, 3D, HDR, Location, Purchased (multiple allowed)\n- sort_by: Relevance, Upload date, View count, Rating\n\nFilter values are matched case-insensitively. Only one option per group applies except features, which accepts multiple labels.\n\nWhen a requested filter cannot be applied, the API returns the best-effort results available so far and includes unappliedFilters with the labels that were skipped.\n\nUse cursor with the same query to paginate: pass cursorNext from a prior response. Filter parameters and cursor cannot be combined.\n\nCheck didYouMean when the query may be misspelled.\n\nCost = 20 tokens.", "inputSchema": { "properties": { "content_type": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Content type filter. One of: Video, Channel, Playlist, Movie.", "title": "Content Type" }, "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from cursorNext.", "title": "Cursor" }, "duration": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Duration filter. One of: Under 4 minutes, 4 - 20 minutes, Over 20 minutes.", "title": "Duration" }, "features": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 6, "type": "array" }, { "type": "null" } ], "default": null, "description": "Feature filters. Multiple allowed. Each value must be one of: Live, 4K, HD, Subtitles/CC, Creative Commons, 360°, VR180, 3D, HDR, Location, Purchased.", "title": "Features" }, "language": { "default": "en", "description": "Language code for localized results (for example en).", "maxLength": 10, "title": "Language", "type": "string" }, "location": { "default": "US", "description": "Country code for localized results (for example US).", "maxLength": 10, "title": "Location", "type": "string" }, "query": { "description": "Search keywords or phrase.", "maxLength": 512, "title": "Query", "type": "string" }, "sort_by": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Sort order. One of: Relevance, Upload date, View count, Rating.", "title": "Sort By" }, "upload_date": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Upload date filter. One of: Last hour, Today, This week, This month, This year.", "title": "Upload Date" } }, "required": [ "query" ], "title": "search_youtubeArguments", "type": "object" }, "name": "youtube.search", "outputSchema": { "$defs": { "YoutubeSearchResponseContentsItem": { "additionalProperties": true, "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Result entry type (for example video).", "title": "Type" }, "video": { "anyOf": [ { "$ref": "#/$defs/YoutubeSearchResponseContentsItemVideo" }, { "type": "null" } ], "default": null, "description": "Video payload when type is video." } }, "title": "YoutubeSearchResponseContentsItem", "type": "object" }, "YoutubeSearchResponseContentsItemVideo": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/YoutubeSearchResponseContentsItemVideoAuthor" }, { "type": "null" } ], "default": null, "description": "Video author summary (avatar omitted)." }, "isLiveNow": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the video is live.", "title": "Islivenow" }, "lengthSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Video duration in seconds.", "title": "Lengthseconds" }, "publishedTimeText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable publish age.", "title": "Publishedtimetext" }, "stats": { "anyOf": [ { "$ref": "#/$defs/YoutubeSearchResponseContentsItemVideoStats" }, { "type": "null" } ], "default": null, "description": "View counts for the video." }, "thumbnails": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeSearchResponseContentsItemVideoThumbnailsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Thumbnail images for the video.", "title": "Thumbnails" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video title.", "title": "Title" }, "videoId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video id.", "title": "Videoid" } }, "title": "YoutubeSearchResponseContentsItemVideo", "type": "object" }, "YoutubeSearchResponseContentsItemVideoAuthor": { "additionalProperties": true, "properties": { "badges": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeSearchResponseContentsItemVideoAuthorBadgesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Author badges (for example Official Artist Channel).", "title": "Badges" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel or creator display name.", "title": "Title" } }, "title": "YoutubeSearchResponseContentsItemVideoAuthor", "type": "object" }, "YoutubeSearchResponseContentsItemVideoAuthorBadgesItem": { "additionalProperties": true, "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge label.", "title": "Text" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge type code.", "title": "Type" } }, "title": "YoutubeSearchResponseContentsItemVideoAuthorBadgesItem", "type": "object" }, "YoutubeSearchResponseContentsItemVideoStats": { "additionalProperties": true, "properties": { "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "View count.", "title": "Views" } }, "title": "YoutubeSearchResponseContentsItemVideoStats", "type": "object" }, "YoutubeSearchResponseContentsItemVideoThumbnailsItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Thumbnail height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Thumbnail image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Thumbnail width in pixels.", "title": "Width" } }, "title": "YoutubeSearchResponseContentsItemVideoThumbnailsItem", "type": "object" } }, "additionalProperties": true, "properties": { "contents": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeSearchResponseContentsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Search result entries for the current page. Video entries include a type field and nested video object.", "title": "Contents" }, "cursorNext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next results page, when available.", "title": "Cursornext" }, "didYouMean": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Suggested corrected query when the search may be misspelled.", "title": "Didyoumean" }, "estimatedResults": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Approximate total number of matching results.", "title": "Estimatedresults" }, "unappliedFilters": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Requested filter labels that could not be applied. Present only when at least one filter was skipped.", "title": "Unappliedfilters" } }, "title": "YoutubeSearchResponse", "type": "object" } }, { "description": "Get YouTube search autocomplete suggestions for a partial query.\n\nReturns the normalized query and an array of suggested search phrases. Optional language and location codes localize suggestions (defaults: en, US).\n\nCost = 8 tokens.", "inputSchema": { "properties": { "language": { "default": "en", "description": "Language code for localized suggestions (for example en).", "maxLength": 10, "title": "Language", "type": "string" }, "location": { "default": "US", "description": "Country code for localized suggestions (for example US).", "maxLength": 10, "title": "Location", "type": "string" }, "query": { "description": "Partial search keywords or phrase.", "maxLength": 512, "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "get_youtube_search_autocompleteArguments", "type": "object" }, "name": "youtube.search_autocomplete", "outputSchema": { "additionalProperties": true, "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Normalized query echoed from the provider.", "title": "Query" }, "results": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Suggested search phrases for the query.", "title": "Results" } }, "title": "YoutubeSearchAutocompleteResponse", "type": "object" } }, { "description": "Fetch top-level comments for a public YouTube video by its 11-character video id.\n\nReturns comment text, author summary, vote and reply counts, pinned status, total comment count, and cursorNext for the next page.\n\nUse sort_by to choose comment order:\n- sort_by: Top comments, Newest first\n\nSort values are matched case-insensitively.\n\nUse cursor with the same video_id to paginate: pass cursorNext from a prior response. sort_by and cursor cannot be combined.\n\nCost = 15 tokens.", "inputSchema": { "properties": { "cursor": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor from a previous response cursorNext field.", "title": "Cursor" }, "sort_by": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Comment sort order. One of: Top comments, Newest first.", "title": "Sort By" }, "video_id": { "description": "YouTube video id (11 characters, not a URL).", "maxLength": 11, "title": "Video Id", "type": "string" } }, "required": [ "video_id" ], "title": "get_youtube_video_commentsArguments", "type": "object" }, "name": "youtube.video_comments", "outputSchema": { "$defs": { "YoutubeVideoCommentsResponseCommentsItem": { "additionalProperties": true, "properties": { "author": { "anyOf": [ { "$ref": "#/$defs/YoutubeVideoCommentsResponseCommentsItemAuthor" }, { "type": "null" } ], "default": null, "description": "Comment author profile summary." }, "commentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Comment id.", "title": "Commentid" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Comment text.", "title": "Content" }, "creatorHeart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the video creator hearted this comment.", "title": "Creatorheart" }, "cursorReplies": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pagination cursor for fetching replies to this comment.", "title": "Cursorreplies" }, "pinned": { "anyOf": [ { "$ref": "#/$defs/YoutubeVideoCommentsResponseCommentsItemPinned" }, { "type": "null" } ], "default": null, "description": "Pinned comment status." }, "publishedTimeText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable comment age.", "title": "Publishedtimetext" }, "stats": { "anyOf": [ { "$ref": "#/$defs/YoutubeVideoCommentsResponseCommentsItemStats" }, { "type": "null" } ], "default": null, "description": "Engagement counts for the comment." } }, "title": "YoutubeVideoCommentsResponseCommentsItem", "type": "object" }, "YoutubeVideoCommentsResponseCommentsItemAuthor": { "additionalProperties": true, "properties": { "badges": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Author badges (for example Verified).", "title": "Badges" }, "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Comment author channel id.", "title": "Channelid" }, "isChannelOwner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the author owns the video channel.", "title": "Ischannelowner" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Comment author display name.", "title": "Title" } }, "title": "YoutubeVideoCommentsResponseCommentsItemAuthor", "type": "object" }, "YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem": { "additionalProperties": true, "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge label.", "title": "Text" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Badge type code.", "title": "Type" } }, "title": "YoutubeVideoCommentsResponseCommentsItemAuthorBadgesItem", "type": "object" }, "YoutubeVideoCommentsResponseCommentsItemPinned": { "additionalProperties": true, "properties": { "status": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the comment is pinned.", "title": "Status" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinned label text when present.", "title": "Text" } }, "title": "YoutubeVideoCommentsResponseCommentsItemPinned", "type": "object" }, "YoutubeVideoCommentsResponseCommentsItemStats": { "additionalProperties": true, "properties": { "replies": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Reply count.", "title": "Replies" }, "votes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Like/vote count.", "title": "Votes" } }, "title": "YoutubeVideoCommentsResponseCommentsItemStats", "type": "object" } }, "additionalProperties": true, "properties": { "comments": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeVideoCommentsResponseCommentsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Top-level comments for the current page and sort order. Additional provider-specific fields may appear on each entry.", "title": "Comments" }, "cursorNext": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cursor for the next comments page, when available.", "title": "Cursornext" }, "totalCommentsCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total number of comments on the video.", "title": "Totalcommentscount" } }, "title": "YoutubeVideoCommentsResponse", "type": "object" } }, { "description": "Fetch metadata for a public YouTube video by video id or URL.\n\nAccepts a bare 11-character video id (for example PuQFESk0BrA) or common YouTube watch, youtu.be, Shorts, and embed URLs. Returns title, description, view count, duration, publish date, channel id, category, keywords, and thumbnails.\n\nCost = 10 tokens.", "inputSchema": { "properties": { "video_id": { "description": "YouTube video id or URL (for example PuQFESk0BrA, https://youtu.be/PuQFESk0BrA, or https://www.youtube.com/watch?v=PuQFESk0BrA).", "maxLength": 2048, "title": "Video Id", "type": "string" } }, "required": [ "video_id" ], "title": "get_youtube_video_detailsArguments", "type": "object" }, "name": "youtube.video_details", "outputSchema": { "$defs": { "YoutubeVideoDetailsResponseThumbnailsItem": { "additionalProperties": true, "properties": { "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image height in pixels.", "title": "Height" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Image URL.", "title": "Url" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Image width in pixels.", "title": "Width" } }, "title": "YoutubeVideoDetailsResponseThumbnailsItem", "type": "object" } }, "additionalProperties": true, "properties": { "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel display name.", "title": "Author" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Primary category label.", "title": "Category" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Uploader channel id.", "title": "Channel Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Plain-text video description.", "title": "Description" }, "is_live_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Whether the video is live content (True or False as a string).", "title": "Is Live Content" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Video keyword tags.", "title": "Keywords" }, "number_of_views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Total view count.", "title": "Number Of Views" }, "published_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Publish date (ISO 8601).", "title": "Published Time" }, "thumbnails": { "anyOf": [ { "items": { "$ref": "#/$defs/YoutubeVideoDetailsResponseThumbnailsItem" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Available thumbnail images at different sizes.", "title": "Thumbnails" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video title.", "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video type (for example NORMAL).", "title": "Type" }, "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Canonical YouTube video id.", "title": "Video Id" }, "video_length": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Video duration in seconds as a string.", "title": "Video Length" } }, "title": "YoutubeVideoDetailsResponse", "type": "object" } } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:1daaf958b98689af93471b29641d2d1655c87e5e2f3fe138cc748c5af0711431 | sha256sum