LDIMS MCP
Fornece uma interface MCP para o sistema de gerenciamento de documentos LDIMS.
Documentação
Ferramentas de Script do LDIMS MCP
Este diretório contém ferramentas de script utilitárias para o serviço LDIMS MCP.
🚀 Como Executar
Método 1: Modo MCP (Recomendado)
Chame via cliente MCP, com o Token configurado no cliente MCP:
# 编译
npm run build
# MCP客户端会自动调用 node dist/index.js
# Token通过MCP配置传递,不需要.env文件中的LDIMS_AUTH_TOKEN
Método 2: Modo HTTP (adequado para testes e integração)
Inicie um servidor HTTP independente, usando a configuração do arquivo .env:
# 确保.env文件中配置了LDIMS_AUTH_TOKEN
npm run http
# 或直接运行
node dist/http-server.js
🔐 Explicação do Modo de Token Duplo:
- Modo MCP: usa o Token da configuração do cliente MCP
- Modo HTTP: usa o
LDIMS_AUTH_TOKENdo arquivo.env - Os dois modos são configurados de forma independente, sem interferência entre si
🚀 Início Rápido
Fluxo de Implantação Completo
-
Gerar Token de Longa Duração
node scripts/get-long-term-token.js -
Compilar o Projeto
npm run build -
Testar a Conexão com a API
node scripts/test-api-connection.js -
Configurar a Ferramenta de IA - consulte a seção "Configuração de Registro do Serviço MCP" abaixo
-
Reiniciar a Ferramenta de IA - reinicie o Cursor ou o Claude Desktop para carregar a nova configuração
📋 Explicação dos Scripts
🔑 Scripts de Gerenciamento de Token
get-fresh-token.js
Gera um novo Token de autenticação (válido por 24 horas)
node scripts/get-fresh-token.js
get-long-term-token.js
Gera um Token de autenticação de longa duração (válido por aproximadamente 7,5 anos)
node scripts/get-long-term-token.js
update-env-token.js
Atualiza a configuração de Token no arquivo de ambiente
node scripts/update-env-token.js <new_token>
🧪 Scripts de Teste
test-api-connection.js
Testa de forma abrangente a conexão e as funcionalidades da API do LDIMS
node scripts/test-api-connection.js
Conteúdo do teste:
- ✅ Verificação de integridade
- ✅ Funcionalidade de busca de documentos
- ✅ Funcionalidade de obtenção de conteúdo de documentos
- ✅ Tempo de resposta da API e qualidade dos dados
🚀 Cenários de Uso
Implantação Inicial
- Execute o
get-long-term-token.jspara gerar um Token de longa duração - Execute o
test-api-connection.jspara verificar a conexão com a API - Registre o serviço MCP na ferramenta de IA (consulte as instruções de configuração abaixo)
Tratamento de Expiração de Token
- Execute o
get-fresh-token.jsou oget-long-term-token.jspara gerar um novo Token - Execute o
update-env-token.jspara atualizar o arquivo de configuração - Reinicie o serviço MCP
Teste de Funcionalidade
- Execute o
test-api-connection.jspara realizar um teste abrangente - Verifique os resultados do teste para garantir que todas as funcionalidades estejam normais
🔧 Configuração de Registro do Serviço MCP
Configuração no Cursor
Adicione a seguinte configuração ao arquivo de configuração MCP do Cursor:
Localização do arquivo de configuração:
- Windows:
%APPDATA%\Cursor\User\globalStorage\cursor.mcp\config.json - macOS:
~/Library/Application Support/Cursor/User/globalStorage/cursor.mcp/config.json - Linux:
~/.config/Cursor/User/globalStorage/cursor.mcp/config.json
{
"ldims": {
"command": "node",
"args": ["D:/DEV/LDIMS/backend_mcp/dist/index.js"],
"env": {
"LDIMS_API_BASE_URL": "http://localhost:3000",
"LDIMS_API_VERSION": "v1",
"LDIMS_AUTH_TOKEN": "your_long_term_token_here",
"NODE_ENV": "production"
}
}
}
Configuração no Claude Desktop
Localização do arquivo de configuração:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
Adicione o seguinte ao arquivo de configuração do Claude Desktop:
{
"mcpServers": {
"ldims": {
"command": "node",
"args": ["D:/DEV/LDIMS/backend_mcp/dist/index.js"],
"env": {
"LDIMS_API_BASE_URL": "http://localhost:3000",
"LDIMS_API_VERSION": "v1",
"LDIMS_AUTH_TOKEN": "your_long_term_token_here",
"NODE_ENV": "production"
}
}
}
}
Explicação da Configuração
- command: use o comando
nodepara executar o arquivo JavaScript compilado - args: aponte para o caminho absoluto do arquivo
dist/index.jscompilado - LDIMS_API_BASE_URL: use um endereço HTTP, não um caminho de arquivo (por exemplo:
http://localhost:3000) - LDIMS_AUTH_TOKEN: use o Token de longa duração gerado pelo
get-long-term-token.js - NODE_ENV: defina como
productionpara obter o melhor desempenho
⚠️ Lembrete importante:
- Os caminhos devem ser absolutos, ajuste conforme o local real da sua instalação
- Certifique-se de executar o
npm run buildprimeiro para compilar o projeto - Certifique-se de que o serviço de backend do LDIMS esteja em execução em
http://localhost:3000
⚠️ Observações
- Certifique-se de que o serviço de backend do LDIMS esteja em execução
- A geração de Token requer uma conexão válida com o banco de dados
- Os scripts de teste exigem o código compilado (execute o
npm run buildprimeiro) - Todos os scripts leem o arquivo
.envna raiz do projeto
📞 Solução de Problemas
Se a execução do script falhar:
- Verifique o status do serviço de backend do LDIMS
- Valide a conexão com o banco de dados
- Confirme a configuração das variáveis de ambiente
- Verifique as mensagens de erro no console
🔧 Notas de Desenvolvimento
Estes scripts são ferramentas essenciais do projeto; não os modifique sem necessidade. Para adicionar novos recursos, siga:
- O estilo de código existente
- Adicione tratamento de erros adequado
- Atualize este documento README