README
🚀 Julia 文档 MCP 服务器
这是一个高效的 MCP 服务器,主要用于向 Claude Desktop 提供关于 Julia 文档和源代码的上下文,为用户在处理 Julia 相关内容时提供便利。
🚀 快速开始
若要使用此服务器,需先满足以下要求,再进行相应配置,最后启动服务器。
✨ 主要特性
- 可获取 Julia 包、模块、类型、函数和方法的文档。
- 能查看 Julia 函数、类型和方法的源代码。
- 内置缓存机制(5 分钟 TTL),提升访问效率。
- 可正确处理 Julia 特定错误。
🛠️ 工具
get-doc
用于获取 Julia 文档,适用于包、模块、类型、函数或方法。
- 参数:
path(字符串) - 到 Julia 对象的路径(例如 'Base.sort','AbstractArray')
get-source
用于获取 Julia 源代码,适用于函数、类型或方法。
- 参数:
path(字符串) - 到 Julia 对象的路径(例如 'Base.sort','AbstractArray')
📋 要求
- 需安装 Node.js 16 或更高版本。
- 安装了 Julia 1.9 或更高版本,并且可从 PATH 访问。
- 需使用 Claude Desktop。
⚙️ 配置
将以下内容添加到您的 Claude Desktop 配置文件 (~/Library/Application Support/Claude/claude_desktop_config.json) 中:
{
"mcpServers": {
"juliadoc": {
"command": "npx",
"args": [
"-y",
"@jonathanfischer97/server-juliadoc"
],
"env": {
"JULIA_PROJECT": "/path/to/your/julia/project"
}
}
}
}
服务器将按照以下规则运行:
- 若
JULIA_PROJECT在配置中设置,将使用您指定的 Julia 项目。 - 若未指定项目,将使用默认全局 Julia 环境。
- 会使用您系统上的默认 Julia 安装(必须可从 PATH 访问)。
💻 开发
# 克隆仓库
git clone https://github.com/jonathanfischer97/juliadoc-mcp.git
cd juliadoc-mcp
# 安装依赖项
npm install
# 构建
npm run build
# 本地启动服务器
npm start
🤝 贡献
欢迎大家贡献代码!请随意提交 Pull Request。
此项目受到 mrjoshuak/godoc-mcp 的启发。
📄 许可证
本项目采用 MIT License,详情请参阅 LICENSE 文件。
Scan to join WeChat group