绝地MCP
将技术文档网站转换为模型上下文协议(MCP)服务器。
概述
Jedi-MCP是一款Python CLI工具,可将技术文档网站转换为MCP服务器,使人工智能编码助手(Kiro、GitHub Copilot、Cursor、Windsurf等)能够在开发过程中访问详细的框架、库、API、SDK和语言文档。
特性
- 人工智能导航提取:使用Strands SDK智能识别文档链接
- 智能内容抓取:获取和提取主要内容,同时过滤掉导航和非内容元素
- 智能分组:使用AI的组相关文档页面
- 详细摘要:生成包含代码示例和API签名的全面降价摘要
- MCP服务器生成:将每个内容组作为人工智能编码助手的MCP工具公开
- 多种运输方式:支持stdio(用于MCP客户端)和SSE(用于HTTP/Inspector访问)
安装
选项1:直接使用uvx(推荐)
# Install UV if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Use directly with uvx from local directory
uvx --from . jedi-mcp generate --url https://docs.example.com --name example-docs
uvx --from . jedi-mcp serve --project example-docs
# Or once published to PyPI (coming soon):
# uvx jedi-mcp generate --url https://docs.example.com --name example-docs
# uvx jedi-mcp serve --project example-docs选项2:本地开发安装
# Clone the repository
git clone
cd jedi-mcp
# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
uv pip install -e ".[dev]"
# Gemini support is included by default
# For Bedrock support, install with: uv pip install -e ".[bedrock]"
# For all providers: uv pip install -e ".[all]"配置
模型提供者选择
Jedi MCP支持多个AI提供商进行导航提取和内容处理。您可以选择:
- 谷歌双子座 (默认)-快速且经济高效
- AWS基岩 -企业级,提供多种型号选择
使用Google Gemini(默认)
- 从获取API密钥 谷歌AI工作室
- 设置环境变量:
# On Linux/Mac
export JEDI_MODEL_PROVIDER=gemini
export GOOGLE_API_KEY="your-api-key-here"
# On Windows (PowerShell)
$env:JEDI_MODEL_PROVIDER="gemini"
$env:GOOGLE_API_KEY="your-api-key-here"
# On Windows (CMD)
set JEDI_MODEL_PROVIDER=gemini
set GOOGLE_API_KEY=your-api-key-here或者创建一个 .env 项目根目录中的文件:
JEDI_MODEL_PROVIDER=gemini
GOOGLE_API_KEY=your-api-key-here使用AWS基岩
- 配置AWS凭据(通过环境变量、凭据文件或IAM角色)
- 设置模型提供程序:
# On Linux/Mac
export JEDI_MODEL_PROVIDER=bedrock
export AWS_REGION=us-east-1
# On Windows (PowerShell)
$env:JEDI_MODEL_PROVIDER="bedrock"
$env:AWS_REGION="us-east-1"或在 .env:
JEDI_MODEL_PROVIDER=bedrock
AWS_REGION=us-east-1高级配置
您可以覆盖不同任务的特定模型ID:
# Navigation extraction model
export JEDI_NAVIGATION_MODEL=gemini-2.0-flash-exp # For Gemini
# or
export JEDI_NAVIGATION_MODEL=qwen.qwen3-coder-30b-a3b-v1:0 # For Bedrock
# Content processing model
export JEDI_CONTENT_MODEL=gemini-2.0-flash-exp # For Gemini
# or
export JEDI_CONTENT_MODEL=qwen.qwen3-coder-30b-a3b-v1:0 # For Bedrock默认型号:
- 双子座:
gemini-2.0-flash-exp用于导航和内容处理 - 基岩:
us.anthropic.claude-3-5-sonnet-20241022-v2:0对于这两项任务
用法
从文档生成MCP服务器
# Using uvx from local directory (recommended)
uvx --from . jedi-mcp generate --url https://docs.example.com --name example-docs
# Or using local installation
jedi-mcp generate --url https://docs.example.com --name example-docs
# Once published to PyPI:
# uvx jedi-mcp generate --url https://docs.example.com --name example-docs列出可用项目
# Using uvx from local directory
uvx --from . jedi-mcp list-projects
# Or using local installation
jedi-mcp list-projects
# Once published to PyPI:
# uvx jedi-mcp list-projects这将显示数据库中的所有项目及其元数据:
- 项目名称
- 根URL
- 内容组的数量
- 创建时间戳
运行MCP服务器
标准传输(适用于Kiro等MCP客户):
# Using uvx from local directory (recommended)
uvx --from . jedi-mcp serve --project example-docs
# Or using local installation
jedi-mcp serve --project example-docs
# Once published to PyPI:
# uvx jedi-mcp serve --project example-docsSSE传输(用于HTTP/localhost访问和MCP检查器):
# Using uvx from local directory
uvx --from . jedi-mcp serve --project example-docs --transport sse --port 8000
# Or using local installation
jedi-mcp serve --project example-docs --transport sse --port 8000
# Once published to PyPI:
# uvx jedi-mcp serve --project example-docs --transport sse --port 8000服务器将在以下时间可用 http://localhost:8000/sse
MCP检验员测试
MCP检查器是一个基于网络的工具,用于测试和调试您的MCP服务器。它允许您探索可用的工具,使用不同的输入对其进行测试,并查看响应。
方法1:直接连接(推荐)
使用SSE传输启动服务器并通过浏览器连接:
# Terminal 1: Start the MCP server with SSE transport
jedi-mcp serve --project example-docs --transport sse --port 8000
# Terminal 2: Launch MCP Inspector
npx @modelcontextprotocol/inspector然后在Inspector web界面中:
- 打开浏览器
http://localhost:5173(或检查员显示的URL) - 点击“连接到服务器”
- 输入服务器URL:
http://localhost:8000/sse - 点击“连接”
方法2:检查器自动启动
让Inspector自动启动您的服务器:
npx @modelcontextprotocol/inspector jedi-mcp serve --project example-docs这将启动检查器和服务器,自动连接它们。
使用检查器
连接后,您可以:
- 查看工具:查看所有可用的文档工具(每个内容组一个)
- 测试工具:单击任何工具调用它并查看markdown文档
- 检查响应:查看每个工具返回的完整降价内容
- 调试问题:检查连接状态和错误消息
工作流程示例:
- 使用上述方法之一连接到服务器
- 浏览可用工具的列表(例如。,
getting_started,api_reference等等) - 单击工具名称以调用它
- 查看返回的降价文档
- 测试不同的工具以验证所有内容组是否可访问
在Kiro IDE中配置
要与Kiro一起使用,请添加到 .kiro/settings/mcp.json:
选项1:从本地目录直接使用uvx:
{
"mcpServers": {
"jedi-mcp": {
"command": "uvx",
"args": ["--from", "/path/to/jedi-mcp", "jedi-mcp", "serve", "--project", "example-docs"],
"disabled": false,
"autoApprove": []
}
}
}选项1b:直接使用uvx(一旦发布到PyPI):
{
"mcpServers": {
"jedi-mcp": {
"command": "uvx",
"args": ["jedi-mcp", "serve", "--project", "example-docs"],
"disabled": false,
"autoApprove": []
}
}
}选项2:本地安装:
{
"mcpServers": {
"jedi-mcp": {
"command": "jedi-mcp",
"args": ["serve", "--project", "example-docs"],
"disabled": false,
"autoApprove": []
}
}
}选项3:HTTP/SSE传输:
{
"mcpServers": {
"jedi-mcp": {
"url": "http://localhost:8000/sse",
"transport": "http"
}
}
}命令选项
生成命令:
--url:文档网站URL(必填)--name:项目名称(必填)--rate-limit:请求之间的延迟(秒)(默认值:0.5)--max-retries:失败请求的最大重试次数(默认值:3)--timeout:请求超时(秒)(默认值:30)--db-path:自定义数据库路径(默认:~/.jedi mcp/jedi mcp.db)
列出项目命令:
--db-path:自定义数据库路径(默认:~/.jedi mcp/jedi mcp.db)
服务命令:
--project:服务项目名称(必填)--transport:运输类型-stdio或sse(默认值:stdio)--host:绑定用于SSE传输的主机(默认:localhost)--port:SSE传输端口(默认值:8000)--db-path:自定义数据库路径(默认:~/.jedi mcp/jedi mcp.db)
需求
- Python 3.10或更高版本
- UV包管理器
发展
# Install development dependencies
uv pip install -e ".[dev]"
# Run tests
pytest
# Run property-based tests
pytest tests/property/出版
要发布到PyPI以便于uvx使用,请执行以下操作:
# Build the package
uv build
# Publish to PyPI (requires PyPI account and API token)
uv publish
# Or publish to TestPyPI first
uv publish --repository testpypi一旦发布,用户可以直接将其与uvx一起使用:
uvx jedi-mcp generate --url https://docs.example.com --name example-docs
uvx jedi-mcp serve --project example-docs许可证
麻省理工学院
