Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.get-spotlight.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What is Spotlight MCP?

Spotlight exposes an MCP (Model Context Protocol) server so AI assistants — such as Cursor, Claude Desktop, or other MCP-compatible clients — can read and manage your organization’s Spotlight data using natural language. MCP wraps the same organization API you use for HTTP integrations. Your API key, rate limits, and permissions are identical whether you call REST endpoints directly or invoke MCP tools.

Connect a client

Set up Cursor, Claude Desktop, or another MCP client.

Tools reference

Full list of MCP tools and what each one does.

Best practices

How agents should work with prompts, quotas, and scheduling.

REST API

Prefer HTTP? Start with the REST API introduction.

​
Prerequisites

  1. API access enabled — MCP is available when API access is enabled for your organization. In the Spotlight app, go to Settings → API and turn on the API.
  2. API key — Copy your key from Settings → API. MCP uses the same key as REST calls.
  3. MCP endpoint — Find your MCP URL under Settings → MCP. The default is:
https://app.get-spotlight.com/api/mcp
MCP is currently in closed beta. If you do not see the API or MCP tabs in Settings, contact your Spotlight account team to request access.

​
What you can do with MCP

AreaExamples
DiscoveryList brands, fetch organization and brand context, read the built-in usage guide
Analysis dataPull run history, per-prompt results, run stats, sources, and content suggestions
PerceptionRead perception prompts and responses; add new perception prompts
Prompt managementCreate topics and prompts, batch-import prompt sets, delete prompts or whole topics
Typical workflows include asking an assistant to “summarize our latest run,” “add five consideration-stage prompts under a new topic,” or “export perception scores from the last report.”

​
How MCP relates to the REST API

Each MCP tool maps to one or more REST endpoints under https://app.get-spotlight.com/api. For example, list_brands calls GET /v1/brands, and get_run_stats calls GET /v1/runs/{runId}/stats. Agents should call get_organization_context once per session and get_brand_context before working with a specific brand. See Best practices for the recommended workflow.

​
Transport and protocol

  • Transport: HTTP (streamable HTTP MCP)
  • Authentication: x-spotlight-api-key header (same as the REST API)
  • Scope: One API key = one organization; all tools are scoped to that organization

​
Next steps

  1. Connect your MCP client
  2. Review available tools
  3. Follow agent best practices