Jane

Jane

Jane is an MCP server that transforms team documentation and project specifications into a searchable, SQLite-powered knowledge base for AI assistants. It enables users to index, search, and manage standard library documentation and technical requirements through full-text search and structured document retrieval.

Category
访问服务器

README

Jane - Knowledge Management for AI Teams

Jane is a Model Context Protocol (MCP) server that transforms your team's documentation into an AI-accessible knowledge base. Built with TypeScript and the official MCP SDK, Jane allows Claude and other MCP-compatible clients to search, access, and manage your standard library documentation and project specifications with SQLite-powered performance.

Perfect for development teams who want to:

  • 📚 Make their documentation instantly searchable by AI assistants
  • 🔍 Quickly find APIs, coding standards, and architectural decisions
  • 📝 Keep project specifications and requirements accessible
  • 🚀 Onboard new team members faster with searchable knowledge

Prerequisites

  • Node.js 18+ and npm 8+
  • MCP-compatible client: Claude Desktop, Claude Code, or custom MCP client
  • 5 minutes for setup and first successful query

Quick Start

Get Jane running with your first successful query in 3 steps:

1. Install and Build

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

2. Test the Server

npm start

You should see: "Jane MCP server is running and ready for connections"
Press Ctrl+C to stop when you see this message.

3. Connect to Claude Desktop

Add Jane to your Claude Desktop configuration:

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"]
    }
  }
}

Important: Replace /absolute/path/to/jane-mcp-server/dist/index.js with your actual absolute path.

Restart Claude Desktop and look for the 📎 (attachment) icon in the input field to access Jane's tools.

Key Features

  • 🔍 Smart Document Search: SQLite-powered full-text search with intelligent indexing that only processes new/modified documents
  • 🤖 AI-Native Integration: Seamlessly works with Claude Desktop, Claude Code, and custom MCP clients
  • 📊 Performance Optimized: Context window preservation through efficient SQLite database storage
  • 📁 Flexible Organization: Supports both standard library docs and project specifications
  • ⚡ Zero Configuration: Works out of the box with sensible defaults and automatic setup

Usage Examples

For Development Teams

API Documentation Management:

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

Team Knowledge Sharing:

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

Technical Specifications:

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

Document Types Jane Manages

  • Standard Library Docs (stdlib): Language-specific documentation (JavaScript, TypeScript, Python, etc.)
  • Project Specifications (specs): Requirements, architecture docs, API specs, team guidelines

MCP Tools

Jane provides 7 MCP tools for comprehensive document management:

Discovery Tools

  • list_stdlibs - Browse available programming languages and their documentation
  • list_specs - Explore your project specifications and technical docs
  • search - Full-text search across all documents with filtering options

Document Access

  • get_stdlib - Retrieve specific standard library documentation
  • get_spec - Access project specifications and technical documents

Content Management

  • create_document - Add new documentation with structured metadata
  • update_document - Modify existing documents and their metadata

Integration Guides

Claude Desktop Setup

  1. Build Jane (if not done already):

    npm run build
    
  2. Find your absolute path:

    pwd
    # Copy the output, you'll need: /that/path/dist/index.js
    
  3. Update Claude Desktop config with the JSON above

  4. Restart Claude Desktop completely (quit and reopen)

  5. Test the integration:

    • Look for the 📎 icon in the input area
    • Select "jane" from the MCP servers dropdown
    • Try: "List available standard libraries"

Claude Code Integration

Add Jane as an MCP server to 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

Verify the connection:

# List configured MCP servers
claude mcp list

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

Configuration

Document Structure

Jane organizes documents in a clear hierarchy:

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

SQLite Database

  • Location: ./document-index.db (automatically created)
  • Technology: SQLite FTS5 for full-text search
  • Smart Indexing: Only processes new/modified documents on startup
  • Performance: Maintains document metadata and content for fast queries

Document Format

All documents use Markdown with YAML frontmatter:

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

# Document Content

Your markdown content here...

Document Management with Symlinks

For teams who want to keep their documentation private and separate from the MCP server repository:

Setup Private Document Storage

# 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

Benefits

  • Privacy: Keep your docs separate from the open-source MCP server
  • Backup: Back up docs independently from the server code
  • Team Sharing: Share docs privately while using the same server setup
  • Git Cleanliness: Avoid committing sensitive documentation to the MCP server repo

Usage

After setting up the symlink, Jane will automatically use your private documents from ~/Documents/Jane while the server accesses them through the symlink. You can add .gitignore entry for Jane/ to prevent accidentally committing your private docs.

Development

# 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;"

Troubleshooting

Common Issues

🚫 "Jane server not appearing in MCP list"

  • Verify the absolute path in your Claude Desktop config
  • Ensure Node.js is accessible: node --version
  • Restart Claude Desktop completely
  • Check server builds successfully: npm run build

🚫 "No documents found"

  • Verify Jane directory exists: ls -la Jane/
  • Check file permissions are readable
  • Run diagnostics: npx tsx tests/jane-diagnostics.ts

🚫 "SQLite database errors"

  • Check database permissions in project directory
  • Reset database: rm document-index.db && npm start
  • Verify disk space availability

🚫 "Document appears in search but not retrievable"

  • Document exists in SQLite index but not on filesystem
  • Run: npm start to resync database with filesystem
  • Check for file permission issues

Diagnostic Commands

# 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

Getting Help

  • Integration Issues: Check the integration guide for your specific MCP client
  • Performance Problems: Review the SQLite configuration and document indexing
  • Document Management: See the MCP tools reference and usage examples

License

MIT

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选