README
🚀 图灵区项目简介
Graphiti 是一款基于 Docker 和 GraphQL 的知识图谱构建工具。它能从文档、代码注释等多种来源轻松提取信息,构建语义网络。专为开发者打造,可助力他们快速搭建与管理知识图谱。
🚀 快速开始
克隆项目并配置环境
git clone https://github.com/rawr-ai/mcp-graphiti.git
cd mcp-graphiti
cp .env.example .env # 复制示例环境文件
⚠️ 重要提示
- 如果
NEO4J_PASSWORD设置为默认值'password',程序将拒绝启动,除非明确设置GRAPHITI_ENV=dev或GRAPHITI_ENV=development。- 除开发环境外,请确保为
NEO4J_PASSWORD配置强密码。
安装 CLI 工具
pipx install . --include-deps # 用户推荐安装方式
# 或者对于贡献者:
python -m venv .venv && source .venv/bin/activate && pip sync uv.lock && pip install -e .
启动服务
graphiti compose # 生成 docker-compose.yml 文件
graphiti up -d # 后台启动服务
创建项目
cd ~/code
graphiti init acme-support-bot # 在新项目根目录运行此命令
cd acme-support-bot
# 添加实体 YAML 文件到 ai/graph/entities/ 目录下
✨ 主要特性
- 知识图谱构建:从多种来源提取信息并自动构建语义网络。
- GraphQL 查询支持:通过 GraphQL 接口查询和检索知识图谱数据。
- 可扩展插件系统:支持自定义插件,方便扩展功能。
- 可视化界面:提供直观的图形化界面用于查看和管理知识图谱。
📦 安装指南
克隆项目并配置环境
git clone https://github.com/rawr-ai/mcp-graphiti.git
cd mcp-graphiti
cp .env.example .env # 复制示例环境文件
安装 CLI 工具
pipx install . --include-deps # 用户推荐安装方式
# 或者对于贡献者:
python -m venv .venv && source .venv/bin/activate && pip sync uv.lock && pip install -e .
启动服务
graphiti compose # 生成 docker-compose.yml 文件
graphiti up -d # 后台启动服务
创建项目
cd ~/code
graphiti init acme-support-bot # 在新项目根目录运行此命令
cd acme-support-bot
# 添加实体 YAML 文件到 ai/graph/entities/ 目录下
📚 详细文档
项目配置 (mcp-projects.yaml)
mcp-projects.yaml 文件用于定义和管理多个项目的配置,包含以下内容:
- 项目列表:列出所有需要构建的知识图谱。
- 数据源配置:指定每个项目的文档、代码注释等来源。
- 插件扩展:定义自定义插件的使用方式。
常见问题解答
Q: 如何扩展功能?
A: 通过编写自定义插件并将其添加到 mcp-projects.yaml 中即可实现功能扩展。
Q: 如何优化性能?
A: 可以通过以下方式优化:
- 配置合适的缓存策略。
- 使用高效的存储后端(如 Redis)。
- 并行处理数据提取任务。
未来发展计划
- 增强插件系统:提供更多内置插件并支持更灵活的扩展方式。
- 优化性能:提升大规模知识图谱的构建和查询效率。
- 完善文档:提供更详细的使用指南和技术文档,降低学习门槛。
🔧 安全提示
- 确保所有敏感信息(如 API 密钥、数据库凭证)不在代码中明文存储。
- 定期备份知识图谱数据,防止意外丢失。
危险区域
- 实验性功能:某些新功能可能尚未经过充分测试,使用前请谨慎评估风险。
- 数据清理:执行数据清理操作前,请确保已备份重要数据。
如需更多信息,请访问项目官网或查阅相关技术文档。
Scan to contact