Spotlightr MCP server
18 operations0 webhooks
Host and manage videos, projects and embed domains, run course access, and read view analytics.
Try Spotlightr with your agent
Connect Spotlightr, then paste this into Claude, ChatGPT or Cursor. For ideas from other apps, see the use cases.
Using Corsair, show me what you can do in Spotlightr on my account, then run one read-only example and show me the result.
Spotlightr tools and triggers
Tools are what your agent can do in Spotlightr through Corsair's MCP server. Triggers are the Spotlightr events a routine can start from.
Videos
- CreateWrite
Create a video from a hosted link or an uploaded file, optionally copying player settings from another video
videos.create
- DeleteDestructive
Delete one or more videos; there is no restore route
videos.delete
- ListRead-only
List videos (1000 a page), or one video by numeric ID, optionally narrowed to a project
videos.list
- List TopRead-only
List the most-watched videos over a window of days
videos.listTop
- MetricsRead-only
Read a video load, play, watch and share counts
videos.metrics
- Update SettingsWrite
Change individual player settings on a video
videos.updateSettings
- Update SourceDestructive
Point an existing video at a new source URL, replacing the old source
videos.updateSource
- ViewsRead-only
List a video views (30 a page), optionally for one known viewer or only those past one percent watched
videos.views
Access
- GetRead-only
Read a student access record for one course
access.get
- UpdateWrite
Expire a student access record
access.update
- Update CodeWrite
Expire a gallery access code
access.updateCode
Domains
- AddWrite
Allow one more domain to embed your videos
domains.add
- ListRead-only
List the domains a video may be embedded on
domains.list
Projects
- CreateWrite
Create a project to file videos under
projects.create
- ListRead-only
List the projects (video groups) on the account
projects.list
Assets
- UploadWrite
Upload an asset file to the account library
assets.upload
Search
- SearchRead-only
Search videos, projects and other objects on the account
search.search
Students
- CreateWrite
Create a course or gallery student with an access record
students.create
Connect Spotlightr to Claude, ChatGPT or Cursor
- 1
Connect Spotlightr in Corsair
Add your Spotlightr API key once in Corsair. Corsair stores the credential encrypted and makes the Spotlightr API calls for your agent, so it never goes into a prompt or a config file. Connect Spotlightr
If your link lets the agent add apps, you can skip this: it gives you a sign-in link the first time it needs Spotlightr. On a ChatGPT personal plan, connect Spotlightr here first.
- 2
Add Corsair's MCP server to your agent
Every client uses the same address:
https://mcp.corsair.dev/mcpOpen Customize → Connectors → Add custom connector, paste the address, then select Connect.Add a custom MCP server with the address and choose OAuth. Personal plans get read tools only.Add to CursorOr add this to~/.cursor/mcp.json. Cursor opens Corsair to sign in the first time it connects.{ "mcpServers": { "corsair": { "url": "https://mcp.corsair.dev/mcp" } } }Run this, then run/mcpin Claude Code to sign in.claude mcp add --transport http corsair https://mcp.corsair.dev/mcpCodex, Gemini CLI, VS Code, Zed and other clients with OAuth sign-in work the same way. Clients without it, such as GitHub Copilot's coding agent, use a link's own address and an API key. Setup for every client
- 3
Sign in and choose what needs your approval
Your client opens Corsair to sign in. Pick a link: the apps your agent can use and a mode that decides what it may do without asking. In the default Cautious mode, Spotlightr's read and write operations run right away and its 2 destructive operations wait for your approval. Strict mode asks before every write and refuses destructive operations, and Read mode allows reads only.
FAQ
Install corsair and @corsair-dev/spotlightr, add the Spotlightr plugin, and connect with an API key. Then call methods like corsair.spotlightr.api.access.get() from your app. Corsair keeps each tenant isolated.
Yes. Spotlightr requires an API key from your Spotlightr account or developer dashboard. Create credentials with access that matches what you automate, then paste them into Corsair or connect through managed auth in Hub.
Yes. One Corsair client can hit Spotlightr, GitHub, Notion, Stripe, and the rest. Trigger Spotlightr from a webhook, push updates to Slack, or chain actions across plugins. Same tenant context across integrations, plain TypeScript.
Teams use Corsair for host and manage videos, projects and embed domains, run course access, and read view analytics. Common builds include sync jobs, admin tooling, and agents that call Spotlightr APIs from your backend.
The SDK is open source. Self-host and you pay Corsair nothing for the integration layer. Hub bills for hosted auth and execution, not per Spotlightr API call. Hub has a generous free tier. For hobby projects you can probably run the whole thing on free. Paid plans start to matter with more tenants or heavier traffic.
We maintain @corsair-dev/spotlightr in the open repo. When Spotlightr ships API changes, upgrade the package. Your call sites stay typed. You should not need to rewrite the integration layer each time.
No. Corsair does not read your Spotlightr data or hold individual access credentials. Credentials stay in your database. API calls run on your instance. We do not store Spotlightr data on your behalf.
Yes. Add https://mcp.corsair.dev/mcp as a custom connector or MCP server in Claude, ChatGPT, Cursor, VS Code, Claude Code, Codex or any client that supports remote MCP servers with OAuth sign-in, then sign in to Corsair. On ChatGPT personal plans, custom servers currently get read tools only.
Yes. Put Spotlightr on a link in Strict mode and every write waits for your approval, while destructive actions are refused. The default Cautious mode asks only before the 2 destructive Spotlightr operations. You can change a link's mode at hub.corsair.dev/me.