# How to integrate Spotlightr MCP with OpenAI Agents SDK

```json
{
  "title": "How to integrate Spotlightr MCP with OpenAI Agents SDK",
  "toolkit": "Spotlightr",
  "toolkit_slug": "spotlightr",
  "framework": "OpenAI Agents SDK",
  "framework_slug": "open-ai-agents-sdk",
  "url": "https://composio.dev/toolkits/spotlightr/framework/open-ai-agents-sdk",
  "markdown_url": "https://composio.dev/toolkits/spotlightr/framework/open-ai-agents-sdk.md",
  "updated_at": "2026-05-12T10:26:57.888Z"
}
```

## Introduction

This guide walks you through connecting Spotlightr to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Spotlightr agent that can show me your top 5 most viewed videos, get viewer engagement stats for video id 1234, list videos with highest watch time this week through natural language commands.
This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Spotlightr account through Composio's Spotlightr MCP server.
Before we dive in, let's take a quick look at the key ideas and tools involved.

## Also integrate Spotlightr with

- [Claude Agent SDK](https://composio.dev/toolkits/spotlightr/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/spotlightr/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/spotlightr/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/spotlightr/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/spotlightr/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/spotlightr/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/spotlightr/framework/cli)
- [Google ADK](https://composio.dev/toolkits/spotlightr/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/spotlightr/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/spotlightr/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/spotlightr/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/spotlightr/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/spotlightr/framework/crew-ai)

## TL;DR

Here's what you'll learn:
- Get and set up your OpenAI and Composio API keys
- Install the necessary dependencies
- Initialize Composio and create a Tool Router session for Spotlightr
- Configure an AI agent that can use Spotlightr as a tool
- Run a live chat session where you can ask the agent to perform Spotlightr operations

## What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.
Key features include:
- Hosted MCP Tools: Connect to external services through hosted MCP endpoints
- SQLite Sessions: Persist conversation history across interactions
- Simple API: Clean interface with Agent, Runner, and tool configuration
- Streaming Support: Real-time response streaming for interactive applications

## What is the Spotlightr MCP server, and what's possible with it?

The Spotlightr MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Spotlightr account. It provides structured and secure access to your video content and analytics, so your agent can perform actions like retrieving top-performing videos, accessing detailed video metrics, and surfacing engagement insights automatically on your behalf.
- Top video discovery and listing: Instantly ask your agent to fetch and list your most viewed or highest performing Spotlightr videos.
- Video analytics and metrics retrieval: Have your agent pull comprehensive analytics for a specific video, including views, engagement rates, unique viewers, and total watch time.
- Engagement insight extraction: Let the agent surface actionable insights about viewer engagement for any video, making it easy to spot trends and opportunities.
- Automated reporting support: Your agent can collect and summarize video performance data, making regular reporting and decision-making faster and more data-driven.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `SPOTLIGHTR_ADD_DOMAIN` | Add Domain | Tool to add a whitelisted domain for embedding Spotlightr videos. Use when you need to whitelist a new domain for video embedding. |
| `SPOTLIGHTR_CREATE_GROUP` | Create Group | Tool to create a new project (group) in Spotlightr. Use when you need to organize videos into a new project or group. |
| `SPOTLIGHTR_CREATE_VIDEO` | Create Video | Tool to create a video in Spotlightr by uploading a file or linking from an external source. Use when you need to add a new video from YouTube, Google Drive, Vimeo, or other sources. |
| `SPOTLIGHTR_DELETE_VIDEO` | Delete Video | Tool to delete or remove videos from Spotlightr projects. Use when you need to permanently delete one or more videos by their IDs. |
| `SPOTLIGHTR_GET_DOMAINS` | Get Domains | Tool to retrieve whitelisted domains for a Spotlightr account. Use when you need to list all domains approved for embedding videos. |
| `SPOTLIGHTR_GET_TOP_VIDEOS` | Get Top Videos | Tool to retrieve the top videos from a Spotlightr account. Use when you need to list the most viewed videos. |
| `SPOTLIGHTR_GET_VIDEO_METRICS` | Get Video Metrics | Tool to retrieve analytics metrics for a specified video. Use when you have a video ID and need its metrics (loads, plays, playRate, completionRate, shares, etc.). |
| `SPOTLIGHTR_GET_VIDEO_SOURCE` | Get Video Source | Tool to get or replace the video source for an existing video in Spotlightr. Use when you need to update a video's source URL. |
| `SPOTLIGHTR_GET_VIDEO_VIEWS` | Get Video Views | Tool to retrieve video view data with optional filtering by viewer ID and watch status. Use when you need detailed view records for a specific video. |
| `SPOTLIGHTR_LIST_GROUPS` | List Groups | Tool to retrieve all projects (groups) in a Spotlightr account. Use when you need to list all available projects or groups. |
| `SPOTLIGHTR_LIST_VIDEOS` | List Videos | Tool to retrieve videos from a Spotlightr account. Use when you need to list all videos or filter by specific video ID or project. |
| `SPOTLIGHTR_SEARCH_GLOBAL` | Search Global | Tool to perform account-wide search across all videos and content in Spotlightr. Use when you need to find specific videos, projects, or content by name or keyword. |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The Spotlightr MCP server is an implementation of the Model Context Protocol that connects your AI agent to Spotlightr. It provides structured and secure access so your agent can perform Spotlightr operations on your behalf through a secure, permission-based interface.
With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster.

## Step-by-step Guide

### 1. Prerequisites

Before starting, make sure you have:
- Composio API Key and OpenAI API Key
- Primary know-how of OpenAI Agents SDK
- A live Spotlightr project
- Some knowledge of Python or Typescript

### 1. Getting API Keys for OpenAI and Composio

OpenAI API Key
- Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. You'll need credits to use the models, or you can connect to another model provider.
- Keep the API key safe.
Composio API Key
- Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs).
- Go to Settings and copy your API key.

### 2. Install dependencies

Install the Composio SDK and the OpenAI Agents SDK.
```python
pip install composio_openai_agents openai-agents python-dotenv
```

```typescript
npm install @composio/openai-agents @openai/agents dotenv
```

### 3. Set up environment variables

Create a .env file and add your OpenAI and Composio API keys.
```bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com
```

### 4. Import dependencies

What's happening:
- You're importing all necessary libraries.
- The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Spotlightr.
```python
import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
```

```typescript
import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
```

### 5. Set up the Composio instance

No description provided.
```python
load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
```

```typescript
dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
```

### 6. Create a Tool Router session

What is happening:
- You give the Tool Router the user id and the toolkits you want available. Here, it is only spotlightr.
- The router checks the user's Spotlightr connection and prepares the MCP endpoint.
- The returned session.mcp.url is the MCP URL that your agent will use to access Spotlightr.
- This approach keeps things lightweight and lets the agent request Spotlightr tools only when needed during the conversation.
```python
# Create a Spotlightr Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["spotlightr"]
)

mcp_url = session.mcp.url
```

```typescript
// Create Tool Router session for Spotlightr
const session = await composio.create(userId as string, {
  toolkits: ['spotlightr'],
});
const mcpUrl = session.mcp.url;
```

### 7. Configure the agent

No description provided.
```python
# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Spotlightr. "
        "Help users perform Spotlightr operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)
```

```typescript
// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Spotlightr. Help users perform Spotlightr operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
```

### 8. Start chat loop and handle conversation

No description provided.
```python
print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
```

```typescript
// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
```

## Complete Code

```python
import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["spotlightr"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Spotlightr. "
        "Help users perform Spotlightr operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
```

```typescript
import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['spotlightr'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Spotlightr. Help users perform Spotlightr operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});
```

## Conclusion

This was a starter code for integrating Spotlightr MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Spotlightr.
Key features:
- Hosted MCP tool integration through Composio's Tool Router
- SQLite session persistence for conversation history
- Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

## How to build Spotlightr MCP Agent with another framework

- [Claude Agent SDK](https://composio.dev/toolkits/spotlightr/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/spotlightr/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/spotlightr/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/spotlightr/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/spotlightr/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/spotlightr/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/spotlightr/framework/cli)
- [Google ADK](https://composio.dev/toolkits/spotlightr/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/spotlightr/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/spotlightr/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/spotlightr/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/spotlightr/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/spotlightr/framework/crew-ai)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Spotlightr MCP?

With a standalone Spotlightr MCP server, the agents and LLMs can only access a fixed set of Spotlightr tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Spotlightr and many other apps based on the task at hand, all through a single MCP endpoint.

### Can I use Tool Router MCP with OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Spotlightr tools.

### Can I manage the permissions and scopes for Spotlightr while using Tool Router?

Yes, absolutely. You can configure which Spotlightr scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

### How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Spotlightr data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)