Jane

Um servidor de gerenciamento de conhecimento para documentos de stdlib e especificações, com um caminho de armazenamento configurável.

GitHub
3
Experimente este MCPPatrocinado

Documentação

Jane - Gerenciamento de Conhecimento para Equipes de IA

Jane é um servidor Model Context Protocol (MCP) que transforma a documentação da sua equipe em uma base de conhecimento acessível por IA. Construído com TypeScript e o SDK oficial do MCP, o Jane permite que o Claude e outros clientes compatíveis com MCP pesquisem, acessem e gerenciem sua documentação de biblioteca padrão e especificações de projeto com desempenho alimentado por SQLite.

Perfeito para equipes de desenvolvimento que desejam:

  • 📚 Tornar sua documentação instantaneamente pesquisável por assistentes de IA
  • 🔍 Encontrar rapidamente APIs, padrões de codificação e decisões arquiteturais
  • 📝 Manter especificações e requisitos de projeto acessíveis
  • 🚀 Integrar novos membros da equipe mais rapidamente com conhecimento pesquisável

Pré-requisitos

  • Node.js 18+ e npm 8+
  • Cliente compatível com MCP: Claude Desktop, Claude Code ou cliente MCP personalizado
  • 5 minutos para configuração e primeira consulta bem-sucedida

Início Rápido

Coloque o Jane em funcionamento com sua primeira consulta bem-sucedida em 3 etapas:

1. Instalar e Compilar

git clone <repository-url>
cd jane-mcp-server
npm install
npm run build

2. Testar o Servidor

npm start

✅ Você deve ver: "Jane MCP server is running and ready for connections"
Pressione Ctrl+C para parar quando vir esta mensagem.

3. Conectar ao Claude Desktop

Adicione o Jane à sua configuração do Claude Desktop:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "jane": {
      "command": "node",
      "args": ["/absolute/path/to/jane-mcp-server/dist/index.js"]
    }
  }
}

Importante: Substitua /absolute/path/to/jane-mcp-server/dist/index.js pelo seu caminho absoluto real.

Reinicie o Claude Desktop e procure o ícone 📎 (anexo) no campo de entrada para acessar as ferramentas do Jane.

Principais Recursos

  • 🔍 Busca Inteligente de Documentos: busca em texto completo alimentada por SQLite com indexação inteligente que processa apenas documentos novos/modificados
  • 🤖 Integração Nativa com IA: funciona perfeitamente com Claude Desktop, Claude Code e clientes MCP personalizados
  • 📊 Desempenho Otimizado: preservação da janela de contexto por meio de armazenamento eficiente em banco de dados SQLite
  • 📁 Organização Flexível: suporta tanto documentação de biblioteca padrão quanto especificações de projeto
  • ⚡ Zero Configuração: funciona imediatamente com padrões sensatos e configuração automática

Exemplos de Uso

Para Equipes de Desenvolvimento

Gerenciamento de Documentação de API:

"Search for authentication endpoints in our API docs"
→ Jane finds and returns relevant REST API specifications

Compartilhamento de Conhecimento da Equipe:

"Show me our coding standards for TypeScript"
→ Jane retrieves team-specific development guidelines

Especificações Técnicas:

"Find the database schema requirements for the user service"
→ Jane searches project specs and returns architecture details

Tipos de Documentos que o Jane Gerencia

  • Documentação de Biblioteca Padrão (stdlib): documentação específica de linguagem (JavaScript, TypeScript, Python, etc.)
  • Especificações de Projeto (specs): requisitos, documentos de arquitetura, especificações de API, diretrizes da equipe

Ferramentas MCP

O Jane fornece 7 ferramentas MCP para gerenciamento abrangente de documentos:

Ferramentas de Descoberta

  • list_stdlibs - Navegue pelas linguagens de programação disponíveis e sua documentação
  • list_specs - Explore suas especificações de projeto e documentos técnicos
  • search - Busca em texto completo em todos os documentos com opções de filtro

Acesso a Documentos

  • get_stdlib - Recupere documentação específica da biblioteca padrão
  • get_spec - Acesse especificações de projeto e documentos técnicos

Gerenciamento de Conteúdo

  • create_document - Adicione nova documentação com metadados estruturados
  • update_document - Modifique documentos existentes e seus metadados

Guias de Integração

Configuração do Claude Desktop

  1. Compile o Jane (se ainda não o fez):

    npm run build

  2. Encontre seu caminho absoluto:

    pwd
# Copy the output, you'll need: /that/path/dist/index.js

  3. Atualize a configuração do Claude Desktop com o JSON acima

  4. Reinicie o Claude Desktop completamente (saia e reabra)

  5. Teste a integração:

    • Procure o ícone 📎 na área de entrada
    • Selecione "jane" no menu suspenso de servidores MCP
    • Tente: "Listar bibliotecas padrão disponíveis"

Integração com Claude Code

Adicione o Jane como servidor MCP ao Claude Code:

# Add Jane MCP server to Claude Code
claude mcp add jane node /absolute/path/to/jane-mcp-server/dist/index.js

# Start Claude Code interactive session
claude

Verifique a conexão:

# List configured MCP servers
claude mcp list

# Test Jane integration
> /mcp
# Select "jane" from the interactive menu to verify connection

Configuração

Estrutura de Documentos

O Jane organiza documentos em uma hierarquia clara:

Jane/
├── stdlib/              # Standard library documentation
│   ├── javascript/      # Language-specific folders
│   ├── typescript/
│   └── python/
└── specs/               # Project specifications
    ├── project1/        # Project-specific folders
    └── project2/

Banco de Dados SQLite

  • Localização: ./document-index.db (criado automaticamente)
  • Tecnologia: SQLite FTS5 para busca em texto completo
  • Indexação Inteligente: processa apenas documentos novos/modificados na inicialização
  • Desempenho: mantém metadados e conteúdo de documentos para consultas rápidas

Formato de Documento

Todos os documentos usam Markdown com frontmatter YAML:

---
title: "Document Title"
description: "Brief description"
author: "Author Name"
tags: ["tag1", "tag2"]
---

# Document Content

Your markdown content here...

Gerenciamento de Documentos com Symlinks

Para equipes que desejam manter sua documentação privada e separada do repositório do servidor MCP:

Configurar Armazenamento Privado de Documentos

# Create your private Jane documents directory
mkdir -p ~/Documents/Jane/{stdlib,specs}

# Remove default Jane directory (if it exists)
rm -rf ~/dev/jane-mcp-server/Jane

# Create symlink from MCP server to your private docs
ln -s ~/Documents/Jane ~/dev/jane-mcp-server/Jane

Benefícios

  • Privacidade: mantenha seus documentos separados do servidor MCP de código aberto
  • Backup: faça backup dos documentos independentemente do código do servidor
  • Compartilhamento em Equipe: compartilhe documentos de forma privada usando a mesma configuração de servidor
  • Limpeza do Git: evite enviar documentação sensível para o repositório do servidor MCP

Uso

Após configurar o symlink, o Jane usará automaticamente seus documentos privados de ~/Documents/Jane enquanto o servidor os acessa por meio do symlink. Você pode adicionar a entrada .gitignore para Jane/ para evitar o envio acidental de seus documentos privados.

Desenvolvimento

# Development mode with hot reload
npm run dev

# Run tests
npm test

# Lint code
npm run lint

# Check SQLite database
sqlite3 document-index.db "SELECT COUNT(*) FROM documents;"

Solução de Problemas

Problemas Comuns

🚫 "Servidor Jane não aparece na lista MCP"

  • Verifique o caminho absoluto na sua configuração do Claude Desktop
  • Garanta que o Node.js esteja acessível: node --version
  • Reinicie o Claude Desktop completamente
  • Verifique se o servidor compila com sucesso: npm run build

🚫 "Nenhum documento encontrado"

  • Verifique se o diretório do Jane existe: ls -la Jane/
  • Verifique se as permissões de arquivo são legíveis
  • Execute diagnósticos: npx tsx tests/jane-diagnostics.ts

🚫 "Erros no banco de dados SQLite"

  • Verifique as permissões do banco de dados no diretório do projeto
  • Redefina o banco de dados: rm document-index.db && npm start
  • Verifique a disponibilidade de espaço em disco

🚫 "Documento aparece na busca, mas não pode ser recuperado"

  • O documento existe no índice SQLite, mas não no sistema de arquivos
  • Execute: npm start para ressincronizar o banco de dados com o sistema de arquivos
  • Verifique problemas de permissão de arquivo

Comandos de Diagnóstico

# Test server startup
timeout 10s npm start
echo $? # Should be 124 (timeout) for successful startup

# Run comprehensive diagnostics
npx tsx tests/jane-diagnostics.ts

# Inspect SQLite database
sqlite3 document-index.db ".tables"
sqlite3 document-index.db "SELECT type, path, title FROM documents LIMIT 10;"

# Check document structure
find Jane/ -name "*.md" | head -5

Obtendo Ajuda

  • Problemas de Integração: consulte o guia de integração para seu cliente MCP específico
  • Problemas de Desempenho: revise a configuração do SQLite e a indexação de documentos
  • Gerenciamento de Documentos: consulte a referência das ferramentas MCP e exemplos de uso

Licença

MIT