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

# Use Onsomble with VS Code

> Connect Onsomble to VS Code and GitHub Copilot by signing in, or with an API key stored per workspace.

Connect Onsomble to VS Code and you can ask Copilot's agent about your AI discoverability while you work: how a brand is showing up in AI answers, what the AI is saying, and what to fix.

The connection is one address:

```text theme={null}
https://mcp.onsomble.ai/mcp
```

You sign in to Onsomble the first time you connect, so no keys change hands. For a workspace config or a CI run, use an [API key](#api-keys-for-scripts-and-ci) instead.

## Add the server

<Steps>
  <Step title="Add the server">
    Open the command palette, run **MCP: Add Server**, choose **HTTP**, paste
    the address above, and name it **Onsomble**.
  </Step>

  <Step title="Sign in and approve">
    VS Code opens a browser window on first use. Sign in to Onsomble and approve
    access.
  </Step>
</Steps>

VS Code's own guide: [Use MCP servers in VS Code](https://code.visualstudio.com/docs/agent-customization/mcp-servers).

## Use it

Open Copilot Chat in agent mode, enable the Onsomble tools from the tools picker, then ask about one of your Sites. Name Onsomble in your first message and name the Site you mean. A few to start with are on the [overview](/developers/connect/overview).

To make the agent read the results like an analyst, install the [Onsomble skills](/developers/connect/skill) alongside the connection.

## API keys for scripts and CI

To store the connection in a workspace config or run it unattended, authenticate with an Onsomble API key instead of signing in. Create one in **Settings → Account → API Keys**: see the [API overview](/developers/quickstart). Keys start with `ons_` and are shown once at creation.

Add the server to `.vscode/mcp.json` in your workspace. The `inputs` block makes VS Code prompt for the key and store it securely, so nothing secret lands in the committed file:

```json theme={null}
{
  "inputs": [
    {
      "type": "promptString",
      "id": "onsomble-api-key",
      "description": "Onsomble API key",
      "password": true
    }
  ],
  "servers": {
    "onsomble": {
      "type": "http",
      "url": "https://mcp.onsomble.ai/mcp",
      "headers": {
        "Authorization": "Bearer ${input:onsomble-api-key}"
      }
    }
  }
}
```

VS Code prompts for the key the first time the server starts.

Onsomble MCP can read results and, with the required permissions, change Clients, Sites, scan configuration and schedules. Starting a Scan uses scan allowance. Review and approve changes and scan runs before your assistant carries them out. In automated setups, keep confirmation enabled for write actions.


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