MCP server
Connect Claude Code, Cursor, or any MCP client over OAuth and let your agent drive the /v1 API.
The Rank Prompt MCP server is a hosted remote Model Context Protocol
server at https://mcp.rankprompt.com/mcp. It exposes your AI visibility data (brands, reports,
citations) as tools any MCP client can call, plus generic read, write, and delete over the
/v1 API. Same data and the same entitlement as the API; nothing to host or keep running.
For the product overview see the MCP landing page. This page is the technical reference.
| Property | Value |
|---|---|
| Endpoint | https://mcp.rankprompt.com/mcp |
| Transport | Streamable HTTP (remote), one JSON-RPC request per POST |
| Auth | OAuth 2.1 + PKCE in the browser, or a pass-through API key |
| Plan | Every plan, free included: the same entitlement as the /v1 API |
| Tools | The in-app Agent’s tools, plus generic read, write, and delete |
Connect
Pick your client, add the server, then authenticate. In Claude Code you sign in over OAuth and never paste a key. Other clients point at the URL and approve in the browser, or fall back to an API key.
claude mcp add --transport http --scope user rankprompt https://mcp.rankprompt.com/mcp{
"mcpServers": {
"rankprompt": {
"url": "https://mcp.rankprompt.com/mcp"
}
}
}--scope user makes the server available in every project. Once connected, call rankprompt_prime
first: it returns your entitlement status and the canonical workflow the agent should follow.
Authentication
Two ways to authenticate, both resolving to a scoped /v1 API key:
- OAuth 2.1 (interactive clients). The client registers over dynamic client registration, then you
approve access on a consent screen and sign in with Google. The flow uses PKCE (
S256), so no secret ends up in your shell history. The access token the server issues carries your API key encrypted: the client can read the token but not the key, which is decrypted server-side only to call/v1. - Pass-through API key (headless / CI). Send a
rp_live_...key as the bearer token. Mint one on the Developers page inside your workspace. Use this for clients without a built-in OAuth flow.
Either way, every call is bound to the key’s scopes and brand restriction, and revoking a key takes effect on its next call.
Scopes
The consent screen recommends the scopes of the everyday toolset: brands, reports, prompts, citations,
jobs, page audit, scheduled reports, region configs, competitors, content, CMS connections, brand
audits, tasks, analytics, SEO, reading outreach, account metadata and billing, read and write where a tool
needs it. Sending outreach email, community threads, Google Business Profile, client reports, the agency
portfolio and prospect searches are offered unticked. You can grant more or fewer in the picker. The generic rankprompt_read, rankprompt_write, and rankprompt_delete tools
reach any /v1 path within the scopes granted; an endpoint outside them returns
insufficient_scope.
Implementing your own client
Discovery is standard, so any compliant MCP client connects with no manual config. All paths are on the
server origin mcp.rankprompt.com:
| Document | Path |
|---|---|
| Protected resource metadata (RFC 9728) | /.well-known/oauth-protected-resource |
| Authorization server metadata (RFC 8414) | /.well-known/oauth-authorization-server |
| Dynamic client registration (RFC 7591) | POST /oauth/register |
| Authorize | GET /oauth/authorize |
| Token | POST /oauth/token |
Public clients only (token_endpoint_auth_method: none), the authorization_code grant, and PKCE
S256 are required. A tools/call sent without a token returns 401 with a WWW-Authenticate header
pointing at the protected-resource metadata, which is the pointer MCP clients follow to start OAuth.
Tools
The tools are the ones the in-app Agent runs, generated from the same catalog, so the server and the Agent
never drift, each with typed arguments and its credits and plan in its description.
Each one calls its own /v1 endpoint with your key, so it takes that endpoint’s scope,
request units and credits and answers its JSON; rankprompt_schema with tool names the endpoint. Pass
dry_run: true to see what a write would spend without running it. A tool that deletes something or acts
outside Rank Prompt (sends mail, publishes, opens a checkout) first answers a dry run of the call and what it
would do, and runs once called again with confirm: true after you agree.
Built in
| Tool | What it does |
|---|---|
rankprompt_prime | Start here: how to drive the server, what spends credits, and which playbook to read. |
rankprompt_skills_list, rankprompt_skills_read | The playbooks, one per area (measurement, prompts, content, publishing, keywords, site health, outreach and more), the same ones the Agent loads, and the Agent’s ready-made jobs. |
rankprompt_schema | Find any /v1 endpoint and its request schema, or one tool’s endpoint and arguments. |
rankprompt_read, rankprompt_write, rankprompt_delete | Generic GET, POST or PATCH, and DELETE against any /v1 path. |
By area
| Area | Tools |
|---|---|
| Tasks | rankprompt_list_tasks, rankprompt_get_task, rankprompt_create_task, rankprompt_update_task, rankprompt_generate_report_recommendations |
| Billing | rankprompt_get_credit_balance, rankprompt_buy_credits, rankprompt_subscribe |
| Brand | rankprompt_get_brand_info, rankprompt_update_brand_info, rankprompt_research_brand, rankprompt_create_brand, rankprompt_list_alias_suggestions, rankprompt_accept_alias_suggestion, rankprompt_dismiss_alias_suggestion |
| Brand audit | rankprompt_list_brand_audits, rankprompt_get_brand_audit, rankprompt_run_brand_audit |
| Reports | rankprompt_list_reports, rankprompt_get_report, rankprompt_get_prompt_answers, rankprompt_get_latest_visibility_score, rankprompt_create_report, rankprompt_update_report, rankprompt_delete_report, rankprompt_analyze_report_visibility |
| Diagnosis | rankprompt_get_report_visibility_breakdown, rankprompt_get_answers_by_platform |
| Report build | rankprompt_get_report_prompts, rankprompt_generate_report_brand_info, rankprompt_generate_report_prompts, rankprompt_add_report_prompt, rankprompt_update_prompt, rankprompt_delete_prompt, rankprompt_delete_report_prompts |
| Prompts | rankprompt_list_brand_prompts, rankprompt_set_prompt_tracking, rankprompt_list_fanouts, rankprompt_get_fanout_prompts, rankprompt_discover_prompts, rankprompt_discover_page_prompts, rankprompt_get_prompt_insights |
| Scheduled reports | rankprompt_list_scheduled_reports, rankprompt_create_scheduled_report, rankprompt_update_scheduled_report, rankprompt_delete_scheduled_report, rankprompt_duplicate_scheduled_report, rankprompt_run_scheduled_report_now, rankprompt_get_scheduled_report_analytics, rankprompt_list_calendar_events, rankprompt_update_schedule_delivery |
| Competitors | rankprompt_get_report_competitors, rankprompt_list_competitors, rankprompt_get_share_of_voice, rankprompt_find_competitor_duplicates, rankprompt_update_competitor, rankprompt_merge_competitors |
| Citations | rankprompt_list_citations, rankprompt_list_cited_pages, rankprompt_list_cited_domains, rankprompt_list_social_citations, rankprompt_list_offsite_pages, rankprompt_get_citation_trends, rankprompt_list_tracked_pages, rankprompt_track_pages, rankprompt_untrack_page |
| Community | rankprompt_list_community_threads, rankprompt_add_community_threads, rankprompt_draft_community_reply, rankprompt_search_community_threads, rankprompt_read_community_thread, rankprompt_update_community_thread |
| Outreach targets | rankprompt_add_outreach_targets, rankprompt_analyze_cited_pages, rankprompt_set_page_contact, rankprompt_verify_backlink, rankprompt_list_outreach_authors |
| Outreach contacts | rankprompt_list_outreach_contacts, rankprompt_get_outreach_contact, rankprompt_create_outreach_contact, rankprompt_update_outreach_contact, rankprompt_tag_outreach_contacts |
| Contact lists | rankprompt_list_contact_lists, rankprompt_get_contact_list, rankprompt_preview_contact_filter, rankprompt_create_contact_list, rankprompt_update_contact_list, rankprompt_add_contacts_to_list, rankprompt_remove_contact_from_list |
| Templates and sequences | rankprompt_list_email_templates, rankprompt_create_email_template, rankprompt_update_email_template, rankprompt_list_email_sequences, rankprompt_get_email_sequence, rankprompt_create_email_sequence, rankprompt_update_email_sequence, rankprompt_create_sequence_variant, rankprompt_update_sequence_variant |
| Campaigns | rankprompt_list_campaigns, rankprompt_get_campaign, rankprompt_create_campaign, rankprompt_update_campaign, rankprompt_preview_campaign, rankprompt_launch_campaign, rankprompt_pause_campaign, rankprompt_stop_campaign |
| Mailboxes | rankprompt_list_mailboxes, rankprompt_connect_mailbox, rankprompt_update_mailbox, rankprompt_disconnect_mailbox |
| Outreach inbox | rankprompt_list_outreach_emails, rankprompt_list_outreach_replies, rankprompt_get_email_thread, rankprompt_draft_outreach_email, rankprompt_draft_reply, rankprompt_update_outreach_email, rankprompt_send_outreach_email |
| Articles | rankprompt_list_briefs, rankprompt_generate_article, rankprompt_import_article, rankprompt_get_article_context, rankprompt_update_article, rankprompt_regenerate_article, rankprompt_preview_article_outline |
| Content plan | rankprompt_list_content_opportunities, rankprompt_plan_articles, rankprompt_get_content_plan |
| Publishing | rankprompt_list_cms_connections, rankprompt_publish_article, rankprompt_connect_publishing_target, rankprompt_test_publishing_target, rankprompt_get_github_publishing_profile, rankprompt_infer_github_publishing_profile, rankprompt_scaffold_github_blog |
| Autopilot | rankprompt_configure_content_autopilot, rankprompt_get_content_autopilot, rankprompt_list_content_interlinks, rankprompt_apply_content_interlink, rankprompt_dismiss_content_interlink, rankprompt_set_content_auto_interlink, rankprompt_get_content_preferences, rankprompt_update_content_preferences |
| Keywords | rankprompt_list_tracked_keywords, rankprompt_get_ranking_keywords, rankprompt_get_keyword_gap, rankprompt_check_keyword_ranks, rankprompt_research_keywords, rankprompt_track_keywords, rankprompt_refresh_domain_overview, rankprompt_refresh_keyword_gap |
| SEO audits | rankprompt_get_site_health, rankprompt_list_site_pages, rankprompt_add_seo_page, rankprompt_run_seo_audit, rankprompt_run_technical_check, rankprompt_run_page_audit |
| Analytics | rankprompt_get_analytics_summary, rankprompt_get_search_console, rankprompt_get_citation_uplift |
| Google Business Profile | rankprompt_list_gbp_locations, rankprompt_list_gbp_scheduled_posts, rankprompt_schedule_gbp_post, rankprompt_list_gbp_reviews, rankprompt_reply_to_gbp_review |
| Sharing | rankprompt_list_shares, rankprompt_create_share, rankprompt_revoke_share |
| Agency | rankprompt_list_my_brands, rankprompt_get_portfolio_overview, rankprompt_list_agency_tasks, rankprompt_get_cross_brand_intelligence, rankprompt_get_board_summary, rankprompt_get_pending_reviews, rankprompt_get_prospects_summary |
| Client reports | rankprompt_list_client_reports, rankprompt_get_client_report, rankprompt_create_client_report, rankprompt_edit_client_report, rankprompt_publish_client_report, rankprompt_send_client_report, rankprompt_share_client_report |
| Article reviews | rankprompt_get_article_review, rankprompt_reply_to_review, rankprompt_resolve_review_comment, rankprompt_share_article_review |
| Prospecting | rankprompt_list_prospect_lists, rankprompt_get_prospect_list, rankprompt_search_prospects, rankprompt_get_prospect_pipeline |
| Lead webhooks | rankprompt_list_webhooks, rankprompt_create_webhook, rankprompt_delete_webhook |
The Agent’s chat helpers (help search, the page on screen, plans, memory), its ready-to-paste copy, its GitHub repo browser and the team list stay in the app.
The workflow
Run it end to end. The value is in shipping the fixes, not in “report done”. rankprompt_prime
returns this loop in full.
- Pick or create a brand, and make sure it has facts. A report cannot run without them.
- Create a report and choose the engines.
- Seed prompts (the questions engines answer), or auto-generate them.
- Run the report and read it back until it completes.
- Read the summary (score plus AI analysis), the cited sources and the suggested tasks: those are the to-do list.
- Audit your pages, implement the fixes in your repo, then track over time with a schedule, and find
new questions to track with
rankprompt_discover_prompts.
Engines and credits
Reports measure mentions and citations across six answer engines, all on every plan: chatgpt,
claude, gemini, grok, perplexity and ai_overviews (Google AI Mode). Choose the platforms when
you create a report; with none picked it runs on chatgpt, claude and ai_overviews.
- 1 credit per prompt covers up to 3 platforms.
- 2 credits per prompt cover 4 to 6, so all six cost 2.
See Pricing for the full cost model.
Security
- OAuth 2.1 with PKCE (
S256): browser sign-in, no secret in your shell history. - Dynamic client registration plus an explicit consent screen with Google sign-in.
- Your API key is never exposed to the client. It is carried encrypted inside the access token and
decrypted server-side only to call
/v1. - Scoped, brand-restricted access. Revocation is enforced on every call.
- A hosted remote server; the OAuth endpoints are rate-limited per IP.