Model Context Protocol

Use domscout as agent tools

The @domscout/mcp package exposes this API as MCP tools, so an agent platform can read pages, capture images, extract structured data, and run bounded crawls without you writing an HTTP client. Every tool is the same route documented in the API guide, with the same plan gates, the same credit weights, and the same safety controls.

01 · Connect

Point a client at the server

Create a key in the dashboard, then add the server to your MCP client configuration. The package is run with npx, so there is nothing to install.

mcp client configuration

{
  "mcpServers": {
    "domscout": {
      "command": "npx",
      "args": ["-y", "@domscout/mcp"],
      "env": {
        "DOMSCOUT_API_KEY": "ds_your_key_here"
      }
    }
  }
}

Variable	Required	Purpose
DOMSCOUT_API_KEY	Yes	Your API key.
DOMSCOUT_BASE_URL	No	Overrides the production gateway for an intentionally separate deployment.

The default target is https://api.domscout.io.

02 · Tools

What the agent can call

Tool	Credits	What it does
domscout_check_credits	free	Balance, quota, rate limit, and the price list
domscout_extract_markdown	1	Read a page as clean Markdown (fast:true skips the browser)
domscout_capture_screenshot	1–3	Capture PNG, JPEG, WebP, or PDF
domscout_extract_data	2	Extract named fields as typed JSON
domscout_inspect_page	2	Read the accessibility tree and interactive elements
domscout_automate_page	1–2	Run allowed actions and capture the result
domscout_crawl_site	1/page	Run a bounded, allowlisted, robots-respecting crawl
domscout_get_job	free	Poll a durable job, batch, or crawl
domscout_cancel_job	free	Cancel one durable job
domscout_send_feedback	free	Send product feedback

Costs come back with the result

No request exceeds 10 credits, and every tool result carries what it cost and what remains, so an agent can budget without a second call.

Plan gates still apply

A tool is usable when its plan and the deployment state allow the underlying route. Trusted browser-side JavaScript has a separate account entitlement. domscout_check_credits reports which capabilities this key can actually use.

Web search is not among them. POST /search is withheld while no provider is configured, so no MCP tool wraps it.

03 · Resources

Documentation the agent can read directly

domscout://docs	The full API reference.
domscout://openapi	The OpenAPI 3.1 contract, which is the authoritative wire description.

04 · Keys

Where the key lives

The server sends an x-api-key to the API host and reads the response. It holds no browser, database, or billing credential. Keep the key in your MCP client's environment block — never commit it, and never paste it into a prompt, because prompt text is frequently logged by the platform running the agent.

Continue with jobs & webhooks orthe API guide.