MCP tools reference
Seven tools, all scoped to the workspace that owns the API key. Page checks and llms.txt drafts are free (with a fair-use daily cap). A full audit costs 1 credit plus 1 per 3 AI-visibility questions; get_credits shows the cost for each site.
By Surfaced team · Updated
check_page#
Instant single-page SEO and AEO check. Pass `html` (the page you are building, e.g. rendered output or the component's markup) or a live `url`. Returns scores, key signals and a prioritised list of fixes. Free (fair-use daily limit).
| Input | Type | Description |
|---|---|---|
url | string | Live page URL to fetch and check. |
html | string | Raw HTML to check instead of fetching a URL (max 2 MB). |
page_url | string | Optional: the URL this HTML will live at, used for canonical and homepage checks. |
{ "html": "<!doctype html><html lang=\"en\"><head><title>Acme Dental | Implants in Andheri</title>…</head><body>…</body></html>",
"page_url": "https://acmedental.com/implants" }generate_llms_txt#
Crawl a site and draft an /llms.txt (a Markdown summary for LLMs and answer engines) from its own pages. Save the result to public/llms.txt. Free (fair-use daily limit).
| Input | Type | Description |
|---|---|---|
urlrequired | string | Site URL, e.g. https://example.com |
{ "url": "https://acmedental.com" }list_sites#
List the sites in this Surfaced workspace with their latest scores and schedule.
No inputs.
{}get_report#
Latest completed report for a site (site id, domain or URL). `section`: summary (default), issues, fixes (prioritised plan with code snippets), competitors, or full.
| Input | Type | Description |
|---|---|---|
siterequired | string | Site id, domain or URL. |
section | summary | issues | fixes | competitors | full |
{ "site": "acmedental.com", "section": "fixes" }run_audit#
Start a full Surfaced audit (crawl, technical SEO, Core Web Vitals, AEO, AI visibility, competitors, fix plan). Pass `url` for any site (created as on-demand if new) or `site` for an existing one. Costs 1 credit plus 1 per 3 AI-visibility questions (a new site asks up to 5, so usually 2 to 3 credits; call get_credits to see each site's cost). Returns an audit_id; poll get_audit until completed (usually 20 to 90 seconds).
| Input | Type | Description |
|---|---|---|
url | string | |
site | string | Existing site id or domain. |
name | string | Display name for a new site. |
competitors | string[] | Competitor URLs for a new site (max 5). |
email | boolean | Email the report to the site's recipients when done. |
{ "url": "https://acmedental.com", "competitors": ["https://smilestudio.in"] }get_audit#
Status and live progress of an audit started with run_audit. When status is completed, call get_report for the details.
| Input | Type | Description |
|---|---|---|
audit_idrequired | string |
{ "audit_id": "6aeb5c92fdf1d8f46628faf7" }get_credits#
Credit balance, the pricing rule, and what the next report costs for each site.
No inputs.
{}