Jane - 人工智能团队的知识管理

Jane 是一个模型上下文协议（MCP）服务器，它将你的团队文档转换成AI可访问的知识库。Jane 使用 TypeScript 和官方 MCP SDK 构建，允许 Claude 和其他兼容 MCP 的客户端搜索、访问和管理标准库文档和项目规范，具有 SQLite 提供的性能。

非常适合希望实现以下目标的开发团队：

• 📚 让文档能够被AI助手即时搜索
• 🔍 快速找到API、编码标准和架构决策
• 📝 使项目规范和需求易于访问
• 🚀 通过可搜索的知识更快地让新成员加入团队

预备条件

• Node.js 18+ 和 npm 8+
• 兼容MCP的客户端：Claude Desktop、Claude Code 或自定义MCP客户端
• 5分钟 完成设置并进行首次成功查询

快速开始

在三步内启动 Jane 并完成首次成功查询：

1. 安装和构建

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

2. 测试服务器

npm start

✅ 你应该看到："Jane MCP 服务器正在运行并准备好连接"
当你看到此消息时，按 Ctrl+C 停止。

3. 连接到 Claude Desktop

将 Jane 添加到你的 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": ["/绝对路径/to/jane-mcp-server/dist/index.js"]
    }
  }
}

重要提示：用实际的绝对路径替换 /绝对路径/to/jane-mcp-server/dist/index.js。

重启 Claude Desktop，并查找输入字段中的 📎 图标以访问 Jane 的工具。

主要特性

• 🔍 智能文档搜索：使用 SQLite 提供全文搜索，智能索引仅处理新的或修改过的文档
• 🤖 AI原生集成：无缝与 Claude Desktop、Claude Code 和自定义 MCP 客户端工作
• 📊 性能优化：通过高效的 SQLite 数据库存储保持上下文窗口
• 📁 灵活组织：支持标准库文档和项目规范
• ⚡ 零配置：开箱即用，带有合理的默认设置和自动设置

使用示例

对于开发团队

API 文档管理：

"搜索我们的API文档中的身份验证端点"
→ Jane 查找并返回相关的REST API 规范

团队知识共享：

"展示我们TypeScript的编码标准"
→ Jane 检索特定团队的开发指南

技术规格：

"查找用户服务的数据库模式要求"
→ Jane 搜索项目规范并返回架构细节

Jane 管理的文档类型

• 标准库文档 (stdlib)：语言特定的文档（JavaScript、TypeScript、Python 等）
• 项目规范 (specs)：需求、架构文档、API 规范、团队指南

MCP 工具

Jane 提供了7个MCP工具用于全面的文档管理：

发现工具

• list_stdlibs - 浏览可用的编程语言及其文档
• list_specs - 探索你的项目规范和技术文档
• search - 在所有文档中进行全文搜索，带过滤选项

文档访问

• get_stdlib - 获取特定的标准库文档
• get_spec - 访问项目规范和技术文档

内容管理

• create_document - 添加带有结构化元数据的新文档
• update_document - 修改现有文档及其元数据

集成指南

Claude Desktop 设置

1. 构建 Jane（如果尚未完成）：

   npm run build
   

2. 找到你的绝对路径：

   pwd
   # 复制输出，你需要：/那个路径/dist/index.js
   

3. 更新 Claude Desktop 配置 使用上面的 JSON

4. 完全重启 Claude Desktop（退出并重新打开）

5. 测试集成：

   • 查找输入区域中的 📎 图标
   • 从 MCP 服务器下拉菜单中选择 "jane"
   • 尝试："列出可用的标准库"

Claude Code 集成

将 Jane 作为MCP服务器添加到 Claude Code 中：

# 将 Jane MCP 服务器添加到 Claude Code
claude mcp add jane node /绝对路径/to/jane-mcp-server/dist/index.js

# 启动 Claude Code 交互会话
claude

验证连接：

# 列出已配置的 MCP 服务器
claude mcp list

# 测试 Jane 集成
> /mcp
# 从交互式菜单中选择 "jane" 来验证连接

配置

文档结构

Jane 以清晰的层次结构组织文档：

Jane/
├── stdlib/              # 标准库文档
│   ├── javascript/      # 语言特定的文件夹
│   ├── typescript/
│   └── python/
└── specs/               # 项目规范
    ├── project1/        # 项目特定的文件夹
    └── project2/

SQLite 数据库

• 位置：./document-index.db（自动创建）
• 技术：SQLite FTS5 全文搜索
• 智能索引：仅在启动时处理新的或修改过的文档
• 性能：维护文档元数据和内容以实现快速查询

文档格式

所有文档都使用带有 YAML 前置信息的 Markdown：

---
title: "文档标题"
description: "简短描述"
author: "作者姓名"
tags: ["标签1", "标签2"]
---

# 文档内容

在这里写你的 Markdown 内容...

使用符号链接进行文档管理

对于希望将文档保持私有且独立于MCP服务器仓库的团队：

设置私有文档存储

# 创建你的私有 Jane 文档目录
mkdir -p ~/Documents/Jane/{stdlib,specs}

# 删除默认的 Jane 目录（如果存在）
rm -rf ~/dev/jane-mcp-server/Jane

# 从 MCP 服务器到你的私有文档创建符号链接
ln -s ~/Documents/Jane ~/dev/jane-mcp-server/Jane

优点

• 隐私：将文档与开源MCP服务器分开
• 备份：独立于服务器代码备份文档
• 团队分享：私下分享文档同时使用相同的服务器设置
• Git 清洁度：避免将敏感文档提交到MCP服务器仓库

使用

设置符号链接后，Jane 将自动使用 ~/Documents/Jane 中的私有文档，而服务器通过符号链接访问它们。你可以为 Jane/ 添加 .gitignore 条目，以防意外提交私有文档。

开发

# 开发模式，热重载
npm run dev

# 运行测试
npm test

# 检查代码
npm run lint

# 检查 SQLite 数据库
sqlite3 document-index.db "SELECT COUNT(*) FROM documents;"

故障排除

常见问题

🚫 "Jane 服务器未出现在MCP列表中"

• 验证 Claude Desktop 配置中的绝对路径
• 确保 Node.js 可用：node --version
• 完全重启 Claude Desktop
• 检查服务器是否成功构建：npm run build

🚫 "未找到文档"

• 验证 Jane 目录是否存在：ls -la Jane/
• 检查文件权限是否可读
• 运行诊断：npx tsx tests/jane-diagnostics.ts

🚫 "SQLite 数据库错误"

• 检查项目目录中的数据库权限
• 重置数据库：rm document-index.db && npm start
• 验证磁盘空间可用性

🚫 "文档出现在搜索中但无法检索"

• 文档存在于 SQLite 索引中但在文件系统中不存在
• 运行：npm start 以重新同步数据库与文件系统
• 检查文件权限问题

诊断命令

# 测试服务器启动
timeout 10s npm start
echo $? # 应该是 1 24（超时）表示成功启动

# 运行综合诊断
npx tsx tests/jane-diagnostics.ts

# 检查 SQLite 数据库
sqlite3 document-index.db ".tables"
sqlite3 document-index.db "SELECT type, path, title FROM documents LIMIT 10;"

# 检查文档结构
find Jane/ -name "*.md" | head -5

获取帮助

• 集成问题：检查特定 MCP 客户端的集成指南
• 性能问题：审查 SQLite 配置和文档索引
• 文档管理：参阅 MCP 工具参考和使用示例

许可

MIT