使用说明
项目简介
Tribal 是一个基于 Model Context Protocol (MCP) 的知识服务,旨在帮助开发者和大型语言模型 (LLM) 更好地管理和利用编程错误知识。它通过存储和检索错误记录,并提供语义相似性搜索功能,使得 Claude 等 LLM 能够记住并学习编程错误,从而提高问题解决效率。Tribal 提供 REST API 和原生 MCP 接口,方便与各种工具集成。
主要功能点
- 错误记录存储与检索: 存储包含完整上下文的错误记录,方便日后查阅。
- 语义相似性搜索: 使用 ChromaDB 实现向量相似性搜索,快速找到相似的错误和解决方案。
- 双接口支持: 同时提供 REST API (FastAPI) 和原生 MCP 接口,灵活集成各种应用。
- API 密钥认证: 使用 JWT 进行 API 密钥认证,保障数据安全。
- 本地和云存储: 支持本地 ChromaDB 存储以及 AWS 集成,满足不同部署需求。
- Docker 部署: 提供 Docker-compose 部署方案,简化部署流程。
- CLI 客户端: 提供命令行客户端工具,方便用户与服务交互。
- Claude 集成: 特别为 Claude 设计,无需额外导入即可通过 MCP 协议自动集成。
安装步骤
-
环境准备:
- 确保已安装 Python 3.12+ 和 uv 包管理器(推荐)。
-
下载代码:
- 克隆 GitHub 仓库到本地:
git clone https://github.com/agentience/tribal_mcp_server.git cd tribal_mcp_server
- 克隆 GitHub 仓库到本地:
-
安装 Tribal:
- 使用 uv 包管理器进行安装(选择任一方式):
- 直接安装:
uv pip install . - 开发模式安装: (用于开发调试,修改代码后立即生效)
uv pip install -e . - 构建包安装: (先构建 wheel 包再安装)
uv pip install build python -m build uv pip install dist/tribal-0.1.0-py3-none-any.whl - 作为工具安装:
uv tool install . # 全局安装 uv tool install -e . # 开发模式全局安装
- 直接安装:
- 使用 uv 包管理器进行安装(选择任一方式):
-
验证安装:
which tribal # 检查 tribal 命令是否安装 tribal version # 检查 tribal 版本
服务器配置
Tribal MCP 服务器需要配置启动命令 (command) 及其参数 (args) 才能与 MCP 客户端(如 Claude)建立连接。以下是配置信息,请添加到 MCP 客户端的配置文件中:
{ "servers": [ { "name": "tribal", "command": "tribal", "args": ["server"] } ] }
配置参数说明:
- 'name': 服务器名称,可以自定义,例如 "tribal"。
- 'command': 启动 Tribal MCP 服务器的命令,这里设置为 "tribal"。
- 'args': 传递给启动命令的参数,'["server"]' 表示运行 MCP 服务器模式。
高级配置 (可选):
您还可以通过修改 'args' 数组来自定义服务器端口等参数,例如:
{ "servers": [ { "name": "tribal", "command": "tribal", "args": ["server", "--port", "5001"] } ] }
其他可选参数:
- '--host': 指定服务器绑定的主机地址,默认为 '0.0.0.0'。
- '--reload': 开启自动重载模式,适用于开发环境。
- '--auto-port': 自动查找可用端口,如果指定端口被占用。
基本使用方法
-
启动服务器:
- 在终端中运行 'tribal server' 命令启动 MCP 服务器。
- 或者运行 'python -m mcp_server_tribal.mcp_app server' 命令。
-
集成到 Claude (以 Claude Code 为例):
- 使用 Claude 的 MCP 管理命令添加 Tribal 服务器:
或者,如果使用 Docker 部署,可以指定服务器 URL:claude mcp add tribal --launch "tribal server"claude mcp add tribal http://localhost:5000
- 使用 Claude 的 MCP 管理命令添加 Tribal 服务器:
-
使用 MCP 工具:
- Tribal 提供了以下 MCP 工具,可以在 Claude 中调用:
- 'track_error': 记录新的错误信息。
- 'find_similar_errors': 搜索相似的错误。
- 'search_errors': 根据条件搜索错误。
- 'get_error_by_id': 根据 ID 获取错误信息。
- 'get_api_status': 获取 API 状态。
- Tribal 提供了以下 MCP 工具,可以在 Claude 中调用:
-
示例对话 (在 Claude 中):
- "记录这个错误,类型是 'ImportError',信息是 'No module named requests',解决方案是安装 'requests' 包。" (Claude 将调用 'track_error' 工具)
- "帮我找找有没有类似的 'ModuleNotFoundError' 错误。" (Claude 将调用 'find_similar_errors' 工具)
更多信息
- 请参考仓库的 README.md 文件获取更详细的介绍和使用方法。
- API 文档 (REST API) 位于 'http://localhost:8000/docs' (假设您使用默认端口 8000 启动 REST API 服务器)。
- MCP 服务器默认端口为 '5000'。
信息
分类
开发者工具