Void MCP Server

Void MCP 服务

本项目提供一个用于存储和检索大模型上下文数据的模型上下文协议（MCP）服务。它包含用于运行轻量级 Hugging Face 模型的 run_local.py，以及用于提供简易 Streamlit 界面的 app.py。

快速开始

1. 安装前置条件

   • Node.js 和 npm
   • Python 3.11
   • PostgreSQL（确保服务正在运行）

2. 安装依赖

   npm install          # Node packages
   pip install -r requirements.txt
   

3. 配置数据库

   在项目根目录中创建 .env 文件，并至少设置以下变量：

   DATABASE_HOST=localhost
   DATABASE_PORT=5432
   DATABASE_NAME=llm_context_db
   DATABASE_USER=your_db_user
   DATABASE_PASSWORD=your_db_password  # must be a string
   PORT=3000
   JWT_SECRET=change-me-in-production-min-32-chars
   

   如果缺少 DATABASE_PASSWORD，你会看到以下错误： SASL: SCRAM-SERVER-FIRST-MESSAGE: client password must be a string。

4. 构建服务

   npm run build
   

5. 运行所有服务

   python start.py
   

   MCP API 将在 http://localhost:3000 提供服务，本地模型服务将在 http://localhost:8000 提供服务。按 Ctrl+C 停止它们。

6. 可选：启动 Streamlit 界面

   streamlit run app.py
   

开发提示

• 使用 pytest 和 npm test 运行测试。

• 仅启动本地模型：python run_local.py --model sshleifer/tiny-gpt2 --port 8000。

• 使用 pre-commit run --all-files 格式化并检查代码。

• 如果需要交互式数据库设置，可使用 setup.sh。

• 安装依赖

  • Node：npm install
  • Python：pip install -r requirements.txt

• 构建：npm run build

• 测试：Node 使用 npm test，Python 使用 pytest

• 运行本地模型：python run_local.py --model sshleifer/tiny-gpt2 --port 8000

• Streamlit 界面：streamlit run app.py

一键启动

如需一步启动 MCP 服务和本地模型服务，请运行：

python start.py

start.py 脚本支持跨平台运行，会安装缺失的 Node 和 Python 依赖，在必要时构建 TypeScript 服务，然后同时启动 MCP 服务和本地模型服务。在类 Unix 系统上，你也可以使用 ./start.sh。

该脚本会安装缺失的 Node 依赖，在需要时构建服务，然后启动 MCP 服务和本地模型服务。连接详情会输出到终端，方便与 IDE 和工具集成。

IDE 集成

如需将 IDE 的上下文功能连接到 MCP 服务，请提供类似 ide_config.json 的配置文件，并将其指向本仓库中的 start.py。

将 /path/to/Void-MCP-Server/start.py 替换为系统上的绝对路径：

{
  "context_servers": {
    "my-mcp-server": {
      "command": {
        "path": "python",
        "args": [
          "/path/to/Void-MCP-Server/start.py"
        ],
        "env": {}
      },
      "settings": {}
    }
  }
}

运行 python start.py --help，查看 --model、--port 和 --model-port 等可用选项，以自定义服务。