AIVAX

Esta página foi traduzida automaticamente do inglês e pode estar desatualizada. Leia o original

Coleções MCP

O Collections MCP expõe uma ou mais coleções AIVAX RAG como ferramentas para clientes MCP compatíveis. Use-o quando um modelo externo, agente, IDE ou assistente de desktop deve decidir quando pesquisar uma base de conhecimento AIVAX.

Para informações sobre como criar coleções, preparar documentos e melhorar a qualidade da recuperação, veja Collections and Documents e Semantic Search.

Endpoint #

TEXT
https://inference.aivax.net/v1/mcp/collections

Headers #

HeaderDescriptionDefault
AuthorizationToken Bearer da sua chave de API.Required
X-Mcp-Collection-IdUm ou mais IDs de coleção. Use vírgulas para múltiplas coleções.Required
X-Mcp-Collection-NameNome da coleção usado para gerar nomes de ferramentas.collection
X-Mcp-RerankerSeleciona o ranqueador usado para ordenar os resultados da pesquisa. Use um @provider/name canônico, lexical, rrf, smart ou none.@aivax/reflex-v1
X-Mcp-Top-KNúmero máximo de resultados a retornar.5
X-Mcp-Min-ScorePontuação mínima de relevância maior que 0 e até 1.0.0.4
X-Mcp-Use-ReferencesDefina como none para habilitar referências nos resultados da pesquisa; omita o cabeçalho para desativá‑las.disabled
X-Mcp-Allow-WriteUse yes para expor ferramentas de escrita e exclusão de documentos.disabled
X-Mcp-Naming-ConventionControla como as ferramentas geradas são nomeadas. Use default ou agent.default

Exemplo de configuração #

Visual Studio Code:

JSON
{
  "servers": {
    "my-rag-collection-mcp": {
      "type": "http",
      "url": "https://inference.aivax.net/v1/mcp/collections",
      "headers": {
        "Authorization": "Bearer <AIVAX_API_KEY>",
        "X-Mcp-Collection-Id": "<COLLECTION_ID>",
        "X-Mcp-Collection-Name": "my_collection",
        "X-Mcp-Top-K": "5",
        "X-Mcp-Min-Score": "0.4",
        // Habilita referências nos resultados da pesquisa.
        "X-Mcp-Use-References": "none"
      }
    }
  }
}

Ferramentas geradas #

Com a convenção de nomeação padrão, a ferramenta de leitura recebe o nome:

TEXT
{collection_name}_search

Ela aceita:

  • search_terms (string[]): um ou mais termos de pesquisa.

A ferramenta de leitura MCP impõe dois limites de model de requisição:

  • No máximo 10 termos de pesquisa por chamada.
  • No máximo 500 caracteres no total em todos os termos de pesquisa.

Quando X-Mcp-Allow-Write está desativado, apenas a ferramenta de pesquisa é exposta. Este é o modo recomendado para assistentes que precisam apenas ler uma base de conhecimento.

Quando X-Mcp-Allow-Write: yes é enviado, o servidor também expõe ferramentas de criação/atualização e exclusão de documentos. Habilite isso apenas para clientes confiáveis, pois um modelo com acesso de escrita pode alterar o conteúdo da coleção.

Use Collections MCP quando um modelo externo ou cliente MCP deve decidir quando pesquisar. Para um cliente de chat típico da AIVAX, costuma ser mais simples anexar a coleção diretamente a um AI Gateway e deixar que o pipeline RAG do gateway recupere os documentos automaticamente.

Digite para pesquisar na documentação.