> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crakseo.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For SEO data and indexing, start with /seo-mcp/overview.md and /seo-mcp/connect.md, then read the focused server reference.
> The documentation search MCP at https://docs.crakseo.com/mcp searches documentation only. Product tools use https://crakseo.com/mcp/<server>.
> Check tool availability and API credit balance before paid calls. Request owner approval for paid indexing. Never invent prices, indexing guarantees or directory approval.

# VS Code and GitHub Copilot SEO MCP quickstart

> Add CrakSEO's SEO MCP and Search Console MCP to VS Code for GitHub Copilot agent mode, make the first call and check the output.

Put the file in `.vscode/mcp.json` for one workspace, or run **MCP: Open User Configuration** from the Command Palette to use the same servers everywhere.

## 1. Add the servers

**Sign in with OAuth (recommended)**

```json .vscode/mcp.json theme={null}
{
  "servers": {
    "crakseo-seo": {
      "type": "http",
      "url": "https://crakseo.com/mcp/seo"
    },
    "crakseo-search-console": {
      "type": "http",
      "url": "https://crakseo.com/mcp/search-console"
    }
  }
}
```

Open the file and click **Start** above each server. VS Code asks you to sign in to CrakSEO, then the tools appear in Copilot Chat agent mode.

**Use an API key**

```json .vscode/mcp.json theme={null}
{
  "inputs": [
    {
      "type": "promptString",
      "id": "crakseo-api-key",
      "description": "CrakSEO API key",
      "password": true
    }
  ],
  "servers": {
    "crakseo-seo": {
      "type": "http",
      "url": "https://crakseo.com/mcp/seo",
      "headers": {
        "Authorization": "Bearer ${input:crakseo-api-key}"
      }
    },
    "crakseo-search-console": {
      "type": "http",
      "url": "https://crakseo.com/mcp/search-console",
      "headers": {
        "Authorization": "Bearer ${input:crakseo-api-key}"
      }
    }
  }
}
```

VS Code prompts for the key once and stores it in its secret storage.

Or add a server from the command line:

```bash theme={null}
code --add-mcp '{"name":"crakseo-seo","type":"http","url":"https://crakseo.com/mcp/seo"}'
code --add-mcp '{"name":"crakseo-search-console","type":"http","url":"https://crakseo.com/mcp/search-console"}'
```

Create API keys at [crakseo.com/app/settings/keys](https://crakseo.com/app/settings/keys). Never commit a real key.

## 2. Check the connection

Run **MCP: List Servers** from the Command Palette. Each CrakSEO server shows **Running**. In Copilot Chat, switch to **Agent** mode and open the tools picker; the CrakSEO tools are listed under each server name.

## 3. Make the first call

First verify the SEO data connection with a free call:

```text theme={null}
Use CrakSEO get_api_credit_balance to report my balance and dataCallsEnabled.
Do not purchase credits or make a paid call.
```

If `dataCallsEnabled` is false, paid data calls are unavailable; adding credits does not enable them. Continue with the free Search Console tools instead. If enabled, review current pricing and get permission before the research call below.

Ask your AI:

```text theme={null}
Use CrakSEO to get the monthly Google search volume and CPC for "seo mcp" in the United States.
```

The client asks permission to call `get_keyword_search_volume` with arguments like these:

```json theme={null}
{
  "keywords": [
    "seo mcp"
  ],
  "country": "US"
}
```

**Expected output** when your account has API credits (the shape is exact; the numbers here are placeholders):

```json theme={null}
{
  "result": {
    "keywords": [
      {
        "keyword": "seo mcp",
        "searchVolume": 0,
        "cpc": 0,
        "competition": 0,
        "keywordDifficulty": 0,
        "intent": "commercial",
        "trend": [
          {
            "month": "2026-09",
            "searchVolume": 0
          }
        ]
      }
    ]
  },
  "billing": {
    "channel": "credits",
    "chargedMicros": 0,
    "chargedUsd": 0,
    "cacheHit": false,
    "balanceMicros": 0
  }
}
```

**Expected output** on a new account with no credits: a tool error with `isError: true` whose text is the JSON below. You aren't charged, and the AI should send you to [crakseo.com/app/indexing/credits](https://crakseo.com/app/indexing/credits) instead of retrying:

```json theme={null}
{
  "code": "insufficient_credits",
  "message": "This call needs up to $X.XXXX in API credits. Add credits in the API account."
}
```

For a free first call, connect the Search Console server instead and ask: "List my Search Console properties, then show my top 10 queries for the last 28 days."

## Copilot CLI

In GitHub Copilot CLI, run `/mcp add`, choose **HTTP**, and enter the server name and URL from the table below.

## Add more servers

> **All CrakSEO MCP servers**
>
> | Server | Endpoint | Tools | Billing |
> | - | - | - | - |
> | [SEO MCP](https://docs.crakseo.com/mcp-servers/seo.md) | `https://crakseo.com/mcp/seo` | 20 | Pay as you go (API credits) |
> | [Google SERP API MCP](https://docs.crakseo.com/mcp-servers/serp-api.md) | `https://crakseo.com/mcp/serp-api` | 6 | Pay as you go (API credits) |
> | [Keyword Research MCP](https://docs.crakseo.com/mcp-servers/keyword-research.md) | `https://crakseo.com/mcp/keyword-research` | 5 | Pay as you go (API credits) |
> | [Backlink Checker MCP](https://docs.crakseo.com/mcp-servers/backlinks.md) | `https://crakseo.com/mcp/backlinks` | 4 | Pay as you go (API credits) |
> | [Google Rank Tracker MCP](https://docs.crakseo.com/mcp-servers/rank-tracker.md) | `https://crakseo.com/mcp/rank-tracker` | 5 | Pay as you go (API credits) |
> | [SEO Site Audit MCP](https://docs.crakseo.com/mcp-servers/site-audit.md) | `https://crakseo.com/mcp/site-audit` | 3 | Pay as you go (API credits) |
> | [Local SEO MCP](https://docs.crakseo.com/mcp-servers/local-seo.md) | `https://crakseo.com/mcp/local-seo` | 3 | Pay as you go (API credits) |
> | [AI Search Visibility MCP](https://docs.crakseo.com/mcp-servers/ai-visibility.md) | `https://crakseo.com/mcp/ai-visibility` | 4 | Pay as you go (API credits) |
> | [URL Indexing MCP](https://docs.crakseo.com/mcp-servers/url-indexing.md) | `https://crakseo.com/mcp/url-indexing` | 5 | Free IndexNow and Bing; paid Google submission |
> | [Google Search Console MCP](https://docs.crakseo.com/mcp-servers/search-console.md) | `https://crakseo.com/mcp/search-console` | 8 | Free |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.