Skip to content

scope3data/activation-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scope3 Campaign API MCP Server

Model Context Protocol (MCP) server for programmatic advertising campaign management

This is an MCP server that provides AI agents with tools for creating and managing programmatic advertising campaigns through the Scope3 platform.

Quick Start

Prerequisites

Installation

# Install dependencies
npm install

# Start development server
npm run dev

The MCP server runs on http://localhost:3001/mcp by default.

Authentication

Include your Scope3 API key in requests:

curl -H "x-scope3-api-key: your_api_key" http://localhost:3001/mcp

Development

Available Scripts

# Development with hot reload
npm run dev

# Production build
npm run build

# Start production server
npm start

# Run tests
npm test

# Run local CI validation (build + lint + test)
npm run ci:local

# Documentation development
npm run docs:dev

# Validate documentation links
npm run docs:validate:links

BigQuery Setup (Optional)

For backend development with BigQuery integration:

# Create BigQuery tables
bq query --project_id=bok-playground --use_legacy_sql=false < scripts/create-bigquery-tables.sql

# Seed demo data
tsx scripts/seed-bigquery-data.ts

# Test BigQuery integration
tsx scripts/test-bigquery-integration.ts

Project Structure

├── src/                 # MCP server implementation
├── mintlify/            # User documentation (Mintlify)
├── docs/                # Developer documentation
├── scripts/             # Build and validation scripts
└── openapi.yaml         # Auto-generated API specification

MCP Integration

This server implements the Model Context Protocol for AI agent integration:

With Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "scope3-campaign-api": {
      "command": "npm",
      "args": ["start"],
      "cwd": "/path/to/scope3-campaign-api",
      "env": {
        "SCOPE3_API_KEY": "your-api-key"
      }
    }
  }
}

With Other MCP Clients

Connect to the server endpoint with proper authentication headers.

Documentation

For Users: Visit the complete documentation for API usage, examples, and guides.

For Developers: See the /docs directory for implementation details.

Core Capabilities

  • Brand Agent Management - Create advertiser accounts
  • Campaign Management - Launch and optimize campaigns (BigQuery backend)
  • Creative Management - Upload and manage ad creatives with automated sync (BigQuery backend)
  • Creative Sync System - Automatic creative distribution to sales agents with smart format matching
  • Tactic Management - Configure targeting and budget allocation with auto-sync integration
  • Product Discovery - Distributed inventory via MCP agent network
  • Notification Framework - Real-time campaign health and sync status alerts
  • Reporting & Analytics - Campaign performance insights with sync health tracking

Support

  • API Issues: Check your API key and server logs
  • Documentation: Visit docs.agentic.scope3.com
  • Feature Requests: Submit GitHub issues

Built for AI-powered advertising workflows

About

A simple MCP server built using FastMCP, TypeScript, ESLint, and Prettier.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 82.8%
  • MDX 14.1%
  • JavaScript 2.9%
  • Other 0.2%