Repository files navigation

Este é um servidor MCP (Model Context Protocol) que fornece ferramentas para interagir com a API do Chatwoot.

1. chatwoot_setup: Configura a conexão com o Chatwoot

   • Parâmetros:
     • baseUrl: URL base da sua instalação do Chatwoot
     • apiToken: Token de API do Chatwoot

2. chatwoot_list_inboxes: Lista todas as caixas de entrada

   • Sem parâmetros

3. chatwoot_list_conversations: Lista conversas

   • Parâmetros opcionais:
     • inbox_id: ID da caixa de entrada
     • status: Status das conversas ("open", "resolved", "pending")

4. chatwoot_send_message: Envia uma mensagem

   • Parâmetros:
     • conversation_id: ID da conversa
     • message: Conteúdo da mensagem
     • message_type: Tipo da mensagem ("incoming" ou "outgoing")

5. chatwoot_update_conversation: Atualiza o status de uma conversa

   • Parâmetros:
     • conversation_id: ID da conversa
     • status: Novo status ("open", "resolved", "pending")

1. Clone o repositório
2. Instale as dependências:

   npm install

3. Inicie o servidor de desenvolvimento:

   npm run start

1. Clone o repositório
2. Construa e inicie os containers:

   docker-compose up -d

O servidor estará disponível emhttp://localhost:8787/sse.

1. Conecte-se ao servidor usando a URL:http://seu-servidor:8787/sse
2. Configure o cliente usando a ferramentachatwoot_setup
3. Comece a usar as outras ferramentas disponíveis

// Configurar o clienteawaitmcp.invoke("chatwoot_setup",{baseUrl:"https://seu-chatwoot.com",apiToken:"seu-token-api"});// Listar caixas de entradaconstinboxes=awaitmcp.invoke("chatwoot_list_inboxes");// Listar conversas abertasconstconversations=awaitmcp.invoke("chatwoot_list_conversations",{status:"open"});// Enviar mensagemawaitmcp.invoke("chatwoot_send_message",{conversation_id:123,message:"Olá! Como posso ajudar?",message_type:"outgoing"});

To explore your new MCP api, you can use theMCP Inspector.

• Start it withnpx @modelcontextprotocol/inspector
• Within the inspector, switch the Transport Type toSSE and enterhttp://localhost:8787/sse as the URL of the MCP server to connect to, and click "Connect"
• You will navigate to a (mock) user/password login screen. Input any email and pass to login.
• You should be redirected back to the MCP Inspector and you can now list and call any defined tools!

The MCP inspector is great, but we really want to connect this to Claude! FollowAnthropic's Quickstart and within Claude Desktop go to Settings > Developer > Edit Config to find your configuration file.

Open the file in your text editor and replace it with this configuration:

{"mcpServers": {"chatwoot": {"description":"Servidor MCP para integração com Chatwoot","command":"npx","args": ["mcp-remote","https://mcp-chatwoot.stacklab.digital/sse"      ],"enabled":true    }  }}

This will run a local proxy and let Claude talk to your MCP server over HTTP

When you open Claude a browser window should open and allow you to login. You should see the tools available in the bottom right. Given the right prompt Claude should ask to call the tool.

1. npx wrangler kv namespace create OAUTH_KV
2. Follow the guidance to add the kv namespace ID towrangler.jsonc
3. npm run deploy

Just like you did above in "Develop locally", run the MCP inspector:

npx @modelcontextprotocol/inspector@latest

Then enter theworkers.dev URL (ex:worker-name.account-name.workers.dev/sse) of your Worker in the inspector as the URL of the MCP server to connect to, and click "Connect".

You've now connected to your MCP server from a remote MCP client.

Update the Claude configuration file to point to yourworkers.dev URL (ex:worker-name.account-name.workers.dev/sse) and restart Claude

{"mcpServers": {"chatwoot": {"description":"Servidor MCP para integração com Chatwoot","command":"npx","args": ["mcp-remote","https://mcp-chatwoot.stacklab.digital/sse"      ],"enabled":true    }  }}

Should anything go wrong it can be helpful to restart Claude, or to try connecting directly to yourMCP server on the command line with the following command.

npx mcp-remote https://mcp-chatwoot.stacklab.digital/sse

In some rare cases it may help to clear the files added to~/.mcp-auth

rm -rf~/.mcp-auth