使用说明
MCP 聊天室
MCP Chat是一个命令行应用程序，它通过OpenAI API实现与模型的交互式聊天。它支持文档检索、基于命令的提示以及通过MCP（模型控制协议）架构实现的可扩展工具。
要求
- Python 3.10+
- OpenAI API密钥
设置
步骤1：配置环境变量
- 创建或编辑
.env在项目根目录中创建文件，并确保定义了以下变量：
OPENAI_API_KEY="" # Your OpenAI key
OPENAI_MODEL="gpt-4o-mini" # Optional: default model
步骤2：安装依赖项
选项1：使用uv进行设置（推荐）
紫外线 是一个快速的Python包安装器和解析器。
- 如果你还没有安装 uv，请进行安装：
pip install uv
- 创建并激活虚拟环境：
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
- 安装依赖项：
uv pip install -e .
- 运行项目
uv run main.py
选项2：无紫外线设置
- 创建并激活一个虚拟环境：
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
- 安装依赖项：
pip install openai python-dotenv prompt-toolkit "mcp[cli]==1.8.0"
- 运行该项目
python main.py
使用方法
基本交互
输入您的信息并按回车键与模型聊天。
文档检索
在查询中包含文档内容时，请使用@符号后跟文档ID：
> Tell me about @deposition.md
命令
使用 / 前缀来执行在MCP服务器中定义的命令：
> /summarize deposition.md
命令支持按 Tab 键自动补全。
发展
添加新文档
编辑 mcp_server.py 向（某处）添加文档 docs 字典。
实现MCP功能
全面实施MCP：
- 完成其中的TODO任务
mcp_server.py - 实现缺失的功能
mcp_client.py
代码检查和类型检查
没有实现代码格式化检查或类型检查。
