Servers Playground How we check Add a server Log in

Rankwise

Working · 2.1 s

com.tryrankwise/rankwisev0.1.0 Domain verified

AI search visibility: see if ChatGPT, Perplexity, Claude and Gemini cite a brand, then win it back.

Marketing & SEO

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://tryrankwise.com/api/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

add_domain

Start tracking a domain's AI visibility in this workspace. Rankwise seeds the homepage and crawls and scores it in the background. Fails when the plan's domain limit is reached. Free: it uses no credits.

domainstring, required

The domain, e.g. example.com

brand_domainsarray

Other domains of the same brand, counted as citations of it.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Rankwise MCP server | mcptry

Tools (49)

add_domain

Argument	Type	Description
domain*	string	The domain, e.g. example.com
brand_domains	array	Other domains of the same brand, counted as citations of it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "maxLength": 253,
      "minLength": 3,
      "description": "The domain, e.g. example.com"
    },
    "brand_domains": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 253
      },
      "maxItems": 10,
      "description": "Other domains of the same brand, counted as citations of it."
    }
  },
  "additionalProperties": false
}

add_keywords

Add up to 50 keywords to the Content Planner. Each becomes a card. With a day it takes that day (an unwritten card there moves to the next free day); without one it takes the next free publishing day. Keywords already planned are skipped, so a retry never adds twice. Free: articles are drafted when their day comes.

Argument	Type	Description
keywords*	array	Keywords as strings, or objects with keyword, day, article_type and article_length.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "keywords"
  ],
  "properties": {
    "keywords": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "required": [
              "keyword"
            ],
            "properties": {
              "day": {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "keyword": {
                "type": "string"
              },
              "article_type": {
                "enum": [
                  "how_to",
                  "explainer",
                  "comparison",
                  "reference",
                  "listicle"
                ],
                "type": "string"
              },
              "article_length": {
                "enum": [
                  "auto",
                  "short",
                  "medium",
                  "long",
                  "comprehensive"
                ],
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Keywords as strings, or objects with keyword, day, article_type and article_length."
    }
  },
  "additionalProperties": false
}

add_question

Track a new question for a domain, e.g. "best invoicing software for freelancers". Scheduled checks then ask the plan's AI engines whether they cite the brand. Fails at the plan's question limit. Free: it uses no credits.

Argument	Type	Description
locale	string	Market locale such as en-US or de-DE. Omit for the default market.
question*	string	The question, as a user would ask an AI engine.
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id",
    "question"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "maxLength": 20,
      "description": "Market locale such as en-US or de-DE. Omit for the default market."
    },
    "question": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3,
      "description": "The question, as a user would ask an AI engine."
    },
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

approve_brief

Approve a draft brief. This debits the workspace's credits (see get_plan_and_credits for the cost) and starts writing the AI draft article, which then waits for review; nothing is published. Re-approving a draft whose generation failed is free. Send a unique idempotency_key and reuse it on retry.

destructive

Argument	Type	Description
brief_id*	string
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "brief_id",
    "idempotency_key"
  ],
  "properties": {
    "brief_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

archive_brief

Remove a draft brief that was never approved. Approved briefs cannot be archived because their credits were spent. The brief can be restored in the app, and its topic goes back to the opportunity queue.

destructive

Argument	Type	Description
note	string
reason	string
brief_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "brief_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 300
    },
    "reason": {
      "enum": [
        "wrong_topic",
        "wrong_tone",
        "factual_concern",
        "other"
      ],
      "type": "string"
    },
    "brief_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

bulk_replace_articles

Replace up to 50 articles in one call, with the same rules as replace_article. Each article succeeds or fails on its own; the result lists both.

destructive

Argument	Type	Description
articles*	array

Input schema (JSON)

{
  "type": "object",
  "required": [
    "articles"
  ],
  "properties": {
    "articles": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "article_id"
        ],
        "properties": {
          "html": {
            "type": "string",
            "maxLength": 200001,
            "description": "The full article body as HTML. It is sanitised: scripts, styles, frames, forms and event handlers are removed."
          },
          "slug": {
            "type": "string",
            "maxLength": 400
          },
          "title": {
            "type": "string",
            "maxLength": 400
          },
          "article_id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "meta_description": {
            "type": "string",
            "maxLength": 600
          }
        },
        "additionalProperties": false
      },
      "maxItems": 50,
      "minItems": 1
    }
  },
  "additionalProperties": false
}

check_ai_crawler_access

Check whether AI crawlers (GPTBot, ClaudeBot, PerplexityBot, Google-Extended and others) are allowed or blocked by a website's robots.txt. Returns each crawler's status.

read-only

Argument	Type	Description
url*	string	Any URL on the site to check, e.g. https://example.com

Input schema (JSON)

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Any URL on the site to check, e.g. https://example.com"
    }
  },
  "additionalProperties": false
}

check_citation_readiness

Check whether a single page is easy for AI engines to quote and cite: clear answers, headings, metadata, authorship and freshness signals. Returns findings for that page.

read-only

Argument	Type	Description
url*	string	The full page URL to check

Input schema (JSON)

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The full page URL to check"
    }
  },
  "additionalProperties": false
}

create_brief

Create a draft brief for an article. Nothing is written or charged until the brief is approved with approve_brief. If tracked_domain_id is left out, the workspace's first tracked domain grounds the brief.

Argument	Type	Description
tone	string
title*	string
topic	string
intent	string
audience	string
language	string
target_queries	array
tracked_domain_id	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "title"
  ],
  "properties": {
    "tone": {
      "type": "string",
      "maxLength": 120
    },
    "title": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "topic": {
      "type": "string",
      "maxLength": 500
    },
    "intent": {
      "type": "string",
      "maxLength": 500
    },
    "audience": {
      "type": "string",
      "maxLength": 300
    },
    "language": {
      "type": "string",
      "maxLength": 60
    },
    "target_queries": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "default": [],
      "maxItems": 50
    },
    "tracked_domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

create_checkout_link

Create a Stripe Checkout link for a self-serve Rankwise plan (starter, growth or scale) for this workspace's account, and give it to the person. Nothing is charged by this call: the person opens the link and pays in their browser. If the account already has an active plan, the link opens the billing page to confirm the plan change instead. Agency plans are set up with the Rankwise team. Send a unique idempotency_key and reuse it on a retry.

Argument	Type	Description
plan*	string
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "plan",
    "idempotency_key"
  ],
  "properties": {
    "plan": {
      "enum": [
        "starter",
        "growth",
        "scale"
      ],
      "type": "string"
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

dismiss_opportunity

Remove one topic from the workspace's opportunity queue. It can be restored in the Rankwise app (Demand page). Nothing is deleted.

Argument	Type	Description
opportunity_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "opportunity_id"
  ],
  "properties": {
    "opportunity_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

generate_article

Write a new AI article for a keyword. It uses the same research-and-cite writer as Autopilot: real sources, links only to pages that exist, a closing call to action, and Article and FAQ schema. This spends workspace credits (1 for short, 2 for medium, 3 for long, 4 for comprehensive; check get_plan_and_credits first). The article is generated in the background and is NOT published: call publish_article for that. Retries with the same idempotency_key never spend twice.

destructive

Argument	Type	Description
tone	string
length	string	short 1,200-1,600 words, medium 1,600-2,400 (default), long 2,400-3,200, comprehensive 3,200-4,200
keyword*	string	The topic or search keyword
language	string
article_type	string	auto (default, chosen from the keyword), how_to, explainer, comparison, reference or listicle
integration_id	string	A connected CMS in this workspace, used for internal links and later publishing
idempotency_key*	string

Input schema (JSON)

get_article

Read one article in this workspace: its metadata, status, meta description, the first 4,000 characters of its text (or the full HTML with include_html), the sources it cites, and the Article and FAQ structured data (JSON-LD) that ships with it. Use list_articles to find the id.

read-only

Argument	Type	Description
article_id*	string
include_html	boolean	Also return the full article body as HTML.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "article_id"
  ],
  "properties": {
    "article_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "include_html": {
      "type": "boolean",
      "default": false,
      "description": "Also return the full article body as HTML."
    }
  },
  "additionalProperties": false
}

get_autopilot

Show the workspace's content autopilot: its mode (off, draft_only, requires_approval, full_auto), weekly article quota, whether it is paused, the plan's quota ceiling, suggestions waiting for a decision, and the upcoming approval days.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_brief

Read one brief in full: title, topic, intent, target questions, outline, research notes, suggested sources, status, and the draft article once it exists.

read-only

Argument	Type	Description
brief_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "brief_id"
  ],
  "properties": {
    "brief_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

get_free_ai_audit_link

Get the link to Rankwise's free AI visibility audit for a domain. The audit checks AI crawler access and technical readiness, and runs live Perplexity queries to see whether the brand is cited. The user opens the link to run it; this tool does not run the audit.

read-only

Argument	Type	Description
domain*	string	The domain to audit, e.g. example.com

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to audit, e.g. example.com"
    }
  },
  "additionalProperties": false
}

get_plan_and_credits

Show the workspace's billing plan, its credit balance, what one approved brief costs in credits, and the plan limits (domains, questions, AI engines, monthly AI checks). Use it before a tool that spends credits or a plan allowance. A plan of 'free_trial' means the 3-day free trial: trial limits apply, and articles written in it carry a watermark and publish once the plan starts. A plan of 'paused' means the workspace has no active plan: it never started one, its trial or subscription was canceled, its billing is paused, or it took the 14-day money-back guarantee. Nothing is deleted, but checks and writing stay stopped until the workspace has an active plan again. Every plan has a 14-day money-back guarantee from the first payment, once per customer, refunded from the Billing page. pricing_url describes the plans.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_planner

Read the Content Planner: one card per publishing day with its title, keyword, article type, state (planned, writing, review, published, failed), and search volume and difficulty when measured. Defaults to the window the planner page shows; pass from and to (YYYY-MM-DD, at most 120 days apart) for another. Cards waiting for a day come back under unscheduled.

read-only

Argument	Type	Description
to	string
from	string

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "additionalProperties": false
}

get_scorecard

Read a domain's AI Visibility Scorecard: the composite score (0 to 100, null when nothing is measured yet) and the latest score, confidence and recommendations for each dimension.

read-only

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

get_search_console_summary

Read the site's Google Search Console numbers for the last 28 days: total clicks and impressions, and the best articles by clicks. connected is false until Search Console is connected and has synced once.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

get_share_of_voice

Read a domain's latest AI Share of Voice snapshot: the brand's share of AI answers, its own citations and mentions, the competitor leaderboard, and up to 12 earlier snapshots. Null when it was never measured.

read-only

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

get_workspace

Show the Rankwise workspace this connection acts in: its name, kind (personal or agency client), your role in it, and the permissions this connection has. Every other account tool works inside this one workspace.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_articles

List the articles in this workspace, newest first: title, status (generating, ready, published, failed), publish status and published URL. Experts see only the drafts assigned to them. Filter by status or title words.

read-only

Argument	Type	Description
page	integer
query	string	Words in the title
status	string	ready, generating, published, failed or unpublished
page_size	integer

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "default": 1,
      "maximum": 9007199254740991,
      "minimum": 1
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "description": "Words in the title"
    },
    "status": {
      "enum": [
        "ready",
        "generating",
        "published",
        "failed",
        "unpublished"
      ],
      "type": "string",
      "description": "ready, generating, published, failed or unpublished"
    },
    "page_size": {
      "type": "integer",
      "default": 20,
      "maximum": 50,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

list_briefs

List the workspace's content briefs, newest first: drafts waiting for approval (including ones Rankwise suggested), approved pieces being written, and finished ones. Filter by status. An expert sees only the briefs assigned to them.

read-only

Argument	Type	Description
limit	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 25,
      "maximum": 100,
      "minimum": 1
    },
    "status": {
      "enum": [
        "draft",
        "approved",
        "assigned",
        "in_progress",
        "completed",
        "archived"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

list_citations

For each tracked question and AI engine, show the latest real measurement: whether the engine cited the brand, at which position, which URLs it cited, and when. An engine that failed to answer is skipped rather than counted as not cited.

read-only

Argument	Type	Description
limit	integer	Maximum rows to return.
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 200,
      "maximum": 500,
      "minimum": 1,
      "description": "Maximum rows to return."
    },
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

list_domains

List the domains this workspace tracks for AI visibility, with each domain's id, composite visibility score (0 to 100, null when not scored yet), number of tracked questions, how many questions AI engines mention the brand for, and the last crawl time. Use the id with the other domain tools.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_fixes

List the on-page fixes Rankwise proposes for a domain (structured data, head tags, robots rules and similar), each with the page pattern it targets, the dimension it improves, why, and its status. Rankwise does not change the site; the user or their developer applies a fix.

read-only

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

list_keywords

List the keywords in the Content Planner, one per card, with the article title, its day, state, and search volume and difficulty when measured. Filter by state. To export them as CSV, call GET /api/v1/keywords?format=csv.

read-only

Argument	Type	Description
state	string	planned, writing, review, published or failed

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "state": {
      "enum": [
        "planned",
        "writing",
        "review",
        "published",
        "failed"
      ],
      "type": "string",
      "description": "planned, writing, review, published or failed"
    }
  },
  "additionalProperties": false
}

list_opportunities

List the workspace's ranked content opportunities: topics where AI engines answer questions the brand is not cited for, scored by demand, citation gap and feasibility. Dismissed topics are left out. Each item says whether a brief or article already covers it.

read-only

Argument	Type	Description
limit	integer

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 25,
      "maximum": 100,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

list_questions

List the questions tracked for a domain (the prompts Rankwise asks AI engines), each with its id, market locale, and the latest check result: cited, not_cited or error, the citation position and when it ran.

read-only

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

list_rankwise_sitemaps

List the sitemap URLs exposed by Rankwise so agents can enumerate indexable content.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_sites

List the site this connection reaches: its id (the workspace id), name, tracked domains, and whether automatic articles are on, how many a week, and whether they are paused. A connection reaches one site; connect again (or add a CLI profile) for another.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

list_visibility_events

List recent AI visibility events in the workspace, newest first: citations won and lost, fixes proposed, goals reached. Optionally only since a date or for one domain.

read-only

Argument	Type	Description
limit	integer
since	string	ISO 8601 date-time; only events after it.
domain_id	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 200,
      "minimum": 1
    },
    "since": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 date-time; only events after it."
    },
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

move_planner_card

Move a card that is not written yet to another publishing day. If another unwritten card holds that day, the two swap. A day held by an article that is being written or is published is refused. Free.

Argument	Type	Description
day*	string
card_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "card_id",
    "day"
  ],
  "properties": {
    "day": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "card_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

pause_site

Pause automatic articles for the site. While paused nothing runs on its own: no planner fill, no drafting, no publishing, no credits used. Manual actions still work. Resume with resume_site.

Argument	Type	Description
site_id	string	The site id from list_sites. Defaults to this connection's site.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "site_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The site id from list_sites. Defaults to this connection's site."
    }
  },
  "additionalProperties": false
}

preview_fixes

Show the exact change each proposed fix would make to the domain's pages, as a before and after diff. A dry run: it reads the live pages and changes nothing.

read-only

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

publish_article

Publish one article to the workspace's connected CMS (WordPress, WordPress.com, Shopify, Webflow, Wix, Ghost, Notion, Framer or a self-hosted site). This makes it live on the customer's website. A brief draft must be approved by its expert first. If the workspace has several CMS connections and no default destination, name one with integration_id. Pass publish_at (an ISO date-time) to schedule it, or "next_slot" for the workspace's next publish time.

destructive

Argument	Type	Description
article_id*	string
publish_at	any
integration_id	string
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "article_id",
    "idempotency_key"
  ],
  "properties": {
    "article_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "publish_at": {
      "anyOf": [
        {
          "type": "string",
          "const": "next_slot"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ]
    },
    "integration_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

recrawl_domain

Queue a fresh crawl and re-score of a tracked domain's pages. It runs in the background and takes a few minutes; read get_scorecard afterwards. Free: it uses no credits.

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

refresh_opportunities

Recompute the workspace's opportunity queue from its tracked questions and AI citation data, and look for new topics. Uses paid search and AI data, so it runs at most once every 10 minutes per workspace. Send a unique idempotency_key; retry with the same key.

destructive

Argument	Type	Description
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "idempotency_key"
  ],
  "properties": {
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

refresh_share_of_voice

Capture a fresh AI Share of Voice snapshot for a domain from DataForSEO LLM Mentions. A snapshot from the last 12 hours is returned instead of buying a new one, because the index lags by days. Send a unique idempotency_key, and the same one on a retry.

destructive

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id",
    "idempotency_key"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

remove_domain

Stop tracking a domain and permanently delete its questions, AI answers, scores and history. This cannot be undone.

destructive

Argument	Type	Description
domain_id*	string	The tracked domain's id, from list_domains.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain_id"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The tracked domain's id, from list_domains."
    }
  },
  "additionalProperties": false
}

remove_question

Stop tracking a question and delete its check history. This cannot be undone.

destructive

Argument	Type	Description
question_id*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "question_id"
  ],
  "properties": {
    "question_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "additionalProperties": false
}

replace_article

Replace an article's title, meta description, slug or full HTML body. Send only the fields to change. The slug must be unique in the workspace. Open tracked changes are dropped when the body changes. A published article's live post is not changed; publish it again to send the new version. Free.

destructive

Argument	Type	Description
html	string	The full article body as HTML. It is sanitised: scripts, styles, frames, forms and event handlers are removed.
slug	string
title	string
article_id*	string
meta_description	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "article_id"
  ],
  "properties": {
    "html": {
      "type": "string",
      "maxLength": 200001,
      "description": "The full article body as HTML. It is sanitised: scripts, styles, frames, forms and event handlers are removed."
    },
    "slug": {
      "type": "string",
      "maxLength": 400
    },
    "title": {
      "type": "string",
      "maxLength": 400
    },
    "article_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "meta_description": {
      "type": "string",
      "maxLength": 600
    }
  },
  "additionalProperties": false
}

resume_site

Resume automatic articles for the site after a pause. Cards left on days that passed move to the next free publishing days. Resuming is free.

Argument	Type	Description
site_id	string	The site id from list_sites. Defaults to this connection's site.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "site_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The site id from list_sites. Defaults to this connection's site."
    }
  },
  "additionalProperties": false
}

run_citation_check

Ask the plan's AI engines one tracked question now and record whether each cites the brand. Engines checked in the last few hours are served from that result at no cost. Uses the workspace's monthly on-demand check allowance. Send a unique idempotency_key, and the same one on a retry.

destructive

Argument	Type	Description
question_id*	string
idempotency_key*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "question_id",
    "idempotency_key"
  ],
  "properties": {
    "question_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}

score_ai_visibility

Score how ready a website's homepage is to be found and cited by AI search engines (crawler access, structured data, content signals). Returns a score, issues and quick wins. This is an on-page readiness check, not a measurement of real AI citations. Called without signing in, the result also carries a claim link: give it to the person who runs the site, and one sign-in opens a Rankwise workspace with that domain already added, ready once they start the 3-day free trial. A claim link works once and expires after 72 hours.

read-only

Argument	Type	Description
domain*	string	The domain to score, e.g. example.com

Input schema (JSON)

{
  "type": "object",
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to score, e.g. example.com"
    }
  },
  "additionalProperties": false
}

search_rankwise_content

Search Rankwise's public library: guides, glossary terms, comparisons, free SEO and AI visibility tools, the AI crawler directory (GPTBot, ClaudeBot and others) and the AI engine pages. Returns matching titles with canonical URLs.

read-only

Argument	Type	Description
limit	integer	Maximum number of results to return.
query*	string	Free-text search query matched against titles, descriptions, and topics.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 25,
      "minimum": 1,
      "description": "Maximum number of results to return."
    },
    "query": {
      "type": "string",
      "description": "Free-text search query matched against titles, descriptions, and topics."
    }
  }
}

set_autopilot

Change the workspace's content autopilot. mode: off, draft_only (only suggests briefs, spends nothing) or requires_approval (approves up to the weekly quota of suggested briefs, which spends credits, and holds every draft for review). weekly_quota is capped by the plan. paused pauses or resumes. Auto-publishing (full_auto) cannot be switched on here; do that in the Rankwise app.

destructive

Argument	Type	Description
mode	string	full_auto is refused: switch on auto-publishing in the app.
paused	boolean
weekly_quota	integer

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "mode": {
      "enum": [
        "off",
        "draft_only",
        "requires_approval",
        "full_auto"
      ],
      "type": "string",
      "description": "full_auto is refused: switch on auto-publishing in the app."
    },
    "paused": {
      "type": "boolean"
    },
    "weekly_quota": {
      "type": "integer",
      "maximum": 7,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

update_brief

Edit a draft brief before it is approved: title, topic, intent, target questions or outline. An approved brief cannot be edited; edit its draft article in the app instead.

destructive

Argument	Type	Description
title	string
topic	any
intent	any
outline	array
brief_id*	string
target_queries	array

Input schema (JSON)

{
  "type": "object",
  "required": [
    "brief_id"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "topic": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "outline": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 20
    },
    "brief_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "target_queries": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "maxItems": 50
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "keyword",
    "idempotency_key"
  ],
  "properties": {
    "tone": {
      "type": "string",
      "maxLength": 100
    },
    "length": {
      "enum": [
        "short",
        "medium",
        "long",
        "comprehensive"
      ],
      "type": "string",
      "description": "short 1,200-1,600 words, medium 1,600-2,400 (default), long 2,400-3,200, comprehensive 3,200-4,200"
    },
    "keyword": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The topic or search keyword"
    },
    "language": {
      "type": "string",
      "pattern": "^[a-z]{2}$"
    },
    "article_type": {
      "enum": [
        "auto",
        "how_to",
        "explainer",
        "comparison",
        "reference",
        "listicle"
      ],
      "type": "string",
      "description": "auto (default, chosen from the keyword), how_to, explainer, comparison, reference or listicle"
    },
    "integration_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "A connected CMS in this workspace, used for internal links and later publishing"
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200,
      "minLength": 8
    }
  },
  "additionalProperties": false
}