Jane-人工智能团队的知识管理
Jane是一个模型上下文协议(MCP)服务器,可以将团队的文档转换为AI可访问的知识库。Jane使用TypeScript和官方MCP SDK构建,允许Claude和其他MCP兼容客户端搜索、访问和管理您的标准库文档和项目规范,并具有SQLite支持的性能。
非常适合想要:
- 📚 使他们的文档可由AI助手立即搜索
- 🔍 快速查找API、编码标准和架构决策
- 📝 保持项目规范和要求的可访问性
- 🚀 通过可搜索的知识更快地招募新团队成员
先决条件
- Node.js 18+ 和 npm 8+
- MCP兼容客户端:克劳德桌面、克劳德代码或自定义MCP客户端
- 5分钟 用于设置和首次成功查询
快速开始
通过3个步骤让Jane运行您的第一个成功查询:
1.安装和构建
git clone
cd jane-mcp-server
npm install
npm run build2.测试服务器
npm start✅ 您应该看到: "Jane MCP server is running and ready for connections"\ 按 Ctrl+C 当您看到此消息时停止。
3.连接到克劳德桌面
将Jane添加到您的Claude Desktop配置中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json\ 窗户: %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"]
}
}
}重要提示: 替换 /absolute/path/to/jane-mcp-server/dist/index.js 你的实际绝对路径。
重新启动Claude Desktop并查找📎 输入字段中的(附件)图标,用于访问Jane的工具。
主要特点
- 🔍 智能文档搜索:SQLite支持的全文搜索,具有智能索引,仅处理新的/修改的文档
- 🤖 AI原生集成:与Claude Desktop、Claude Code和自定义MCP客户端无缝协作
- 📊 性能优化:通过高效的SQLite数据库存储保存上下文窗口
- 📁 灵活的组织:支持标准库文档和项目规范
- ⚡ 零配置:开箱即用,具有合理的默认值和自动设置
使用示例
对于开发团队
API文件管理:
"Search for authentication endpoints in our API docs"
→ Jane finds and returns relevant REST API specifications团队知识共享:
"Show me our coding standards for TypeScript"
→ Jane retrieves team-specific development guidelines技术规格:
"Find the database schema requirements for the user service"
→ Jane searches project specs and returns architecture detailsJane管理的文档类型
- 标准库文档 (
stdlib):特定语言的文档(JavaScript、TypeScript、Python等) - 项目规范 (
specs):需求、架构文档、API规范、团队指南
MCP工具
Jane提供了7个MCP工具用于全面的文档管理:
发现工具
list_stdlibs-浏览可用的编程语言及其文档list_specs-探索您的项目规范和技术文档search-使用筛选选项对所有文档进行全文搜索
文档访问
get_stdlib-检索特定的标准库文档get_spec-访问项目规范和技术文件
内容管理
create_document-添加具有结构化元数据的新文档update_document-修改现有文档及其元数据
集成指南
Claude桌面设置
- 塑造简 (如果尚未完成):
npm run build- 找到你的绝对路径:
pwd
# Copy the output, you'll need: /that/path/dist/index.js- 更新Claude桌面配置 上面的JSON
- 完全重新启动克劳德桌面 (退出并重新打开)
- 测试集成:
- 寻找📎 输入区域中的图标 - 从MCP服务器下拉列表中选择“jane” - 尝试:“列出可用的标准库”
Claude代码集成
将Jane添加为Claude Code的MCP服务器:
# 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验证连接:
# List configured MCP servers
claude mcp list
# Test Jane integration
> /mcp
# Select "jane" from the interactive menu to verify connection配置
文档结构
Jane以清晰的层次结构组织文档:
Jane/
├── stdlib/ # Standard library documentation
│ ├── javascript/ # Language-specific folders
│ ├── typescript/
│ └── python/
└── specs/ # Project specifications
├── project1/ # Project-specific folders
└── project2/SQLite数据库
- 位置:
./document-index.db(自动创建) - 技术:SQLite FTS5用于全文搜索
- 智能索引:仅在启动时处理新的/修改的文档
- 演出:维护文档元数据和内容以实现快速查询
文件格式
所有文档都使用Markdown和YAML frontmatter:
---
title: "Document Title"
description: "Brief description"
author: "Author Name"
tags: ["tag1", "tag2"]
---
# Document Content
Your markdown content here...使用Symlinks进行文档管理
对于希望将文档保密并与MCP服务器存储库分开的团队:
设置私人文档存储
# 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益处
- 隐私:将您的文档与开源MCP服务器分开
- 备份:独立于服务器代码备份文档
- 团队共享:使用相同的服务器设置时私下共享文档
- Git清洁度:避免将敏感文档提交到MCP服务器仓库
用法
设置符号链接后,Jane将自动使用您的私人文档 ~/Documents/Jane 而服务器通过符号链接访问它们。您可以添加 .gitignore 入口为 Jane/ 以防止意外提交您的私人文档。
发展
# 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;"故障排除
常见问题
🚫 “简服务器未出现在MCP列表中”
- 验证Claude Desktop配置中的绝对路径
- 确保Node.js可访问:
node --version - 完全重新启动克劳德桌面
- 检查服务器构建是否成功:
npm run build
🚫 “未找到文档”
- 验证Jane目录是否存在:
ls -la Jane/ - 检查文件权限是否可读
- 运行诊断程序:
npx tsx tests/jane-diagnostics.ts
🚫 “SQLite数据库错误”
- 检查项目目录中的数据库权限
- 重置数据库:
rm document-index.db && npm start - 验证磁盘空间可用性
🚫 “文档出现在搜索中,但无法检索”
- 文档存在于SQLite索引中,但不在文件系统上
- 运行:
npm start将数据库与文件系统重新同步 - 检查文件权限问题
诊断命令
# 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获取帮助
- 整合问题:查看特定MCP客户端的集成指南
- 性能问题:查看SQLite配置和文档索引
- 文档管理:请参阅MCP工具参考和使用示例
许可证
麻省理工学院
