Channel.io

Integre com a API do Channel Talk para permitir que assistentes de IA acessem e utilizem informações de chat.

Documentação

Ferramentas MCP do Channel.io (mcp-channel-talk, mcp-channel-io)

Visão geral

Ferramenta MCP não oficial do Channel.io.

Este projeto utiliza a OPEN API do Channel.io para integrar com o Model Context Protocol (MCP). Por meio dele, assistentes de IA podem acessar e utilizar informações de chat do Channel.io.

NPM Version Smithery.ai Downloads

en

Descrição

Funcionalidades implementadas

  1. Consulta da lista de chats
  2. Consulta da lista de mensagens de cada chat (requisições paralelas)

Condições de consulta

  • Consulta por status do chat, tag, nome do administrador e prioridade (importância)
  • Consulta por nome, e-mail, empresa e telefone do solicitante
  • Ao consultar a lista de mensagens do chat, são retornadas apenas as 10 mensagens mais recentes

Detalhes

  • Apenas parte da OPEN API do Channel.io é fornecida
  • Quando a resposta é grande, a operação da IA pode não funcionar bem, então um mapeamento intermediário é usado para reduzir o tamanho da resposta. Portanto, a resposta final é tratada apenas com as informações necessárias.

Uso no cliente MCP

Ao usar em um cliente MCP (como Claude Desktop, etc.), configure da seguinte forma:

Usando npx (recomendado)

{
  "mcpServers": {
    "mcp-channel-io": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-channel-io",
        "--",
        "--access-key",
        "YOUR_ACCESS_KEY",
        "--secret-key",
        "YOUR_SECRET_KEY",
        "--ssl-off" // NODE_TLS_REJECT_UNAUTHORIZED
      ]
    }
  }
}
Usando smithery
{
  "mcpServers": {
    "channel-io": {
      "command": "npx",
      "args": [
        "-y",
        "@smithery/cli@latest",
        "run",
        "@scarfunk/mcp-channel-io",
        "--key",
        "your-smithery-key...",
        "--profile",
        "your-profile-name..."
      ]
    }
  }
}

Configuração de desenvolvimento local

Instalação

# 패키지 설치
npm install

# 빌드
npm run build
// 로컬서버로 .cursor/mcp.json 에 넣고 싶으면 아래 처럼 추가.
{
  "mcpServers": {
    "channel-io": {
      "command": "node",
      "args": [
        "/path/to/YOUR-PROJECT-DIR/build/index.js",
        "--access-key",
        "YOUR_ACCESS_KEY...",
        "--secret-key",
        "YOUR_SECRET_KEY..."
      ]
    }
  }
}

1. Executar com argumentos de CLI (recomendado)

# 빌드 후 실행
npm run build
node build/index.js --access-key YOUR_ACCESS_KEY --secret-key YOUR_SECRET_KEY

2. Desenvolvimento com variáveis de ambiente

Crie um arquivo .env na raiz do projeto e defina as chaves de API necessárias:

CHANNEL_TALK_X_ACCESS_KEY=your_access_key_here
CHANNEL_TALK_X_ACCESS_SECRET=your_access_secret_here

Depois, execute

npm start

ou

node build/index.js

Ambiente

Pré-requisitos

  • Node.js 18 ou superior
  • npm ou yarn

Pilha de tecnologia

  • TypeScript
  • Model Context Protocol SDK (@modelcontextprotocol/sdk)
  • Zod (validação)
  • dotenv (gerenciamento de variáveis de ambiente)

Como obter chaves de API

  1. Faça login no Console de desenvolvedores do Channel.io
  2. Crie um aplicativo e emita as chaves de API
  3. Guarde a Access Key e a Secret Key com segurança

Avisos de segurança

  • Não codifique chaves de API no código
  • Não faça commit do arquivo .env no git (já está incluído no .gitignore)
  • Em ambientes de produção, use argumentos de CLI ou variáveis de ambiente

Documentação de referência

Licença

ISC

Contribuição

Issues e pull requests são sempre bem-vindos.