Ragie

IMPORTANTE!

Este projeto não é mais necessário. Ragie agora suporta MCP nativamente como um servidor HTTP transmissível. Veja a documentação aqui: [https://docs.ragie.ai/docs/mcp-overview]

Se você quiser que usuários da sua empresa possam acessar sua base de conhecimento em aplicativos como Claude ou ChatGPT, talvez você precise do MCP Bridge

Servidor de Protocolo de Contexto de Modelo Ragie

Um servidor de Protocolo de Contexto de Modelo (MCP) que fornece acesso aos recursos de recuperação da base de conhecimento Ragie.

Descrição

Este servidor implementa o Model Context Protocol para permitir que modelos de IA recuperem informações de uma base de conhecimento Ragie. Ele fornece uma única ferramenta chamada "retrieve" que permite consultar a base de conhecimento em busca de informações relevantes.

Pré-requisitos

• Node.js >= 18
• Uma chave de API Ragie

Instalação

O servidor requer a seguinte variável de ambiente:

• RAGIE_API_KEY (obrigatório): Sua chave de autenticação da API Ragie

O servidor iniciará e escutará em stdio por mensagens do protocolo MCP.

Instale e execute o servidor com npx:

RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server

Opções de Linha de Comando

O servidor suporta as seguintes opções de linha de comando:

• --description, -d <text>: Substitua a descrição padrão da ferramenta por texto personalizado
• --partition, -p <id>: Especifique o ID da partição Ragie para consultar

Exemplos:

# With custom description
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base for information"

# With partition specified
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

# Using both options
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base" --partition your_partition_id

Configuração do Cursor

Para usar este servidor MCP com o Cursor:

Opção 1: Crie um arquivo de configuração MCP

1. Salve um arquivo chamado mcp.json

• Para ferramentas específicas de um projeto, crie um arquivo .cursor/mcp.json no diretório do seu projeto. Isso permite definir servidores MCP que estão disponíveis apenas nesse projeto específico.
• Para ferramentas que você deseja usar em todos os projetos, crie um arquivo ~/.cursor/mcp.json no seu diretório pessoal. Isso torna os servidores MCP disponíveis em todos os seus espaços de trabalho do Cursor.

Exemplo de mcp.json:

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

Opção 2: Use um script de shell

1. Salve um arquivo chamado ragie-mcp.sh no seu sistema:

#!/usr/bin/env bash

export RAGIE_API_KEY="your_api_key"

npx -y @ragieai/mcp-server --partition optional_partition_id

2. Dê permissões de execução ao arquivo: chmod +x ragie-mcp.sh

3. Adicione o script do servidor MCP indo em Configurações -> Configurações do Cursor -> Servidores MCP na interface do Cursor.

Substitua your_api_key pela sua chave de API Ragie real e, opcionalmente, defina o ID da partição se necessário.

Configuração do Claude Desktop

Para usar este servidor MCP com o Claude desktop:

1. Crie o arquivo de configuração MCP claude_desktop_config.json:

• Para MacOS: Use ~/Library/Application Support/Claude/claude_desktop_config.json
• Para Windows: Use %APPDATA%/Claude/claude_desktop_config.json

Exemplo de claude_desktop_config.json:

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

Substitua your_api_key pela sua chave de API Ragie real e, opcionalmente, defina o ID da partição se necessário.

2. Reinicie o Claude desktop para que as alterações tenham efeito.

A ferramenta de recuperação Ragie agora estará disponível nas suas conversas do Claude desktop.

Recursos

Ferramenta Retrieve

O servidor fornece uma ferramenta retrieve que pode ser usada para pesquisar na base de conhecimento. Ela aceita os seguintes parâmetros:

• query (string): A consulta de pesquisa para encontrar informações relevantes
• topK (número, opcional, padrão: 8): O número máximo de resultados a retornar
• rerank (booleano, opcional, padrão: true): Se deve tentar encontrar apenas as informações mais relevantes
• recencyBias (booleano, opcional, padrão: false): Se deve favorecer resultados para informações mais recentes

A ferramenta retorna:

• Uma matriz de blocos de conteúdo contendo texto correspondente da base de conhecimento

Desenvolvimento

Este projeto é escrito em TypeScript e usa as seguintes dependências principais:

• @modelcontextprotocol/sdk: Para implementar o servidor MCP
• ragie: Para interagir com a API Ragie
• zod: Para validação de tipos em tempo de execução

Configuração de desenvolvimento

Executando o servidor em modo de desenvolvimento:

RAGIE_API_KEY=your_api_key npm run dev -- --partition optional_partition_id

Compilando o projeto:

npm run build

Licença

Licença MIT - Consulte LICENSE.txt para obter detalhes.