Servidor MCP QuickerSpot
Este repositório contém o Servidor MCP (Model Context Protocol) oficial do QuickerSpot. Ele permite que assistentes e agentes de IA (como Claude Desktop, Antigravity e Cursor) interajam programaticamente com a plataforma QuickerSpot para criar campanhas comerciais, gerar roteiros via IA, sintetizar áudios TTS e disparar recados instantâneos.
🚀 Requisitos
- Python 3.10 ou superior
- Backend do QuickerSpot rodando e acessível (ex:
http://localhost:8000) - Uma API Key M2M válida gerada no backend (
QUICKERSPOT_M2M_API_KEY)
📦 Instalação
- Clone o repositório e navegue até a pasta do servidor MCP:
cd mcp-server
- Crie e ative um ambiente virtual Python:
python -m venv venv
# No Windows PowerShell:
.\venv\Scripts\activate
# No Linux/macOS:
source venv/bin/activate
- Instale as dependências:
pip install -e .
⚙️ Configuração
Copie o arquivo .env.example para .env e ajuste os valores:
cp .env.example .env
Configurações disponíveis:
| Variável | Descrição | Valor Padrão |
|---|---|---|
QUICKERSPOT_API_URL |
URL base do backend FastAPI | http://localhost:8000 |
QUICKERSPOT_M2M_API_KEY |
Chave de API Machine-to-Machine | sua-chave-api-m2m-aqui |
💻 Configuração em Clientes MCP
Configuração para Claude Desktop / Antigravity
Adicione o servidor no seu arquivo de configuração do Claude Desktop (claude_desktop_config.json) ou Antigravity (mcp.json):
{
"mcpServers": {
"quickerspot": {
"command": "python",
"args": ["-m", "src.server"],
"cwd": "/caminho/para/narrador-comercial/mcp-server",
"env": {
"QUICKERSPOT_API_URL": "http://localhost:8000",
"QUICKERSPOT_M2M_API_KEY": "sua-chave-api-m2m-aqui"
}
}
}
}
🛠️ Ferramentas MCP Disponíveis (tools)
list_voices— Retorna o catálogo de vozes comerciais disponíveis.create_campaign— Cria uma nova campanha com lista de produtos e gera o roteiro síncrono via IA.approve_script— Aprova (ou edita) o roteiro de uma campanha e dispara a produção de áudio em background.get_campaign_status— Consulta o status (PENDING,PROCESSING,COMPLETED,FAILED), roteiro e URLs de áudio de uma campanha.list_campaigns— Lista todas as campanhas ativas do usuário.create_recado— Gera áudio instantâneo de recado curto (fast-lane TTS com vinheta, sem HITL).
🧪 Guia de Teste Local e Validação Passo a Passo
Você pode validar o funcionamento do Servidor MCP QuickerSpot no seu ambiente local seguindo o passo a passo abaixo:
Passo 1: Iniciar o Backend FastAPI
- No arquivo
backend/.env, garanta que as variáveis M2M estejam configuradas:QUICKERSPOT_M2M_API_KEY=sua-chave-m2m-local QUICKERSPOT_M2M_USER_ID=m2m_test_user
- Inicie o servidor FastAPI:
cd backend python main.py
O backend ficará acessível emhttp://localhost:8000.
Passo 2: Executar a Suíte de Testes Automatizados (E2E e Unitários)
No diretório mcp-server/, execute a suíte de testes que valida todos os endpoints M2M e as ferramentas do MCP:
cd mcp-server
pytest tests/ -v
Você deverá ver todos os 20 testes passarem (20 passed).
Passo 3: Testar com o MCP Inspector (Interface Visual de Debug)
O MCP Inspector é uma ferramenta oficial do Model Context Protocol que permite testar visualmente todas as ferramentas e respostas via navegador web.
- No terminal da pasta
mcp-server, execute:npx @modelcontextprotocol/inspector python -m src.server
- Defina as variáveis de ambiente na interface ou no terminal:
QUICKERSPOT_API_URL:http://localhost:8000QUICKERSPOT_M2M_API_KEY:sua-chave-m2m-local
- Acesse a URL informada (ex:
http://localhost:5173) para testar chamadas comolist_voices,create_campaign,create_recado, etc.
Passo 4: Validar no Antigravity / Claude Desktop
- Adicione a configuração do servidor MCP no seu cliente (veja a seção Configuração em Clientes MCP acima).
- Abra uma conversa e peça ao assistente de IA:
- "Liste as vozes disponíveis na QuickerSpot."
- "Crie uma campanha de oferta de café para supermercado."
- "Gere um recado instantâneo: 'Atenção clientes, loja fechando em 15 minutos'."
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quickerspot_mcp-0.1.0.tar.gz.
File metadata
- Download URL: quickerspot_mcp-0.1.0.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
050524b83db3d51c3490a867a9450d7a09f573cf44fea3e843c86600b58a7467
|
|
| MD5 |
236937f819e5d684f190cd2126ff7853
|
|
| BLAKE2b-256 |
909b04b9154705c0adc40219f62b9e8c218c8fca173bc7ce30daeae0c05f5a51
|
File details
Details for the file quickerspot_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: quickerspot_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b916adf533b3b512e791056761937272cbae42f45d375c8d6dc2bb5180e39b9
|
|
| MD5 |
af209cfbb38f2b53e79722f15c4bae6d
|
|
| BLAKE2b-256 |
9e123d4b649abdafd5843a719f466a848b27539882b61979929f569a9e93875a
|