返回 MCP 目录
public公开dns本地运行

Brest-mcp-server

Brest MCP Server 是一个基于模型上下文协议(MCP)的服务器实现,专为Brest地区设计,提供MCP交互管理和调试工具。

article

README

🚀 Brest MCP 服务器

Brest MCP 服务器 是 Brest 区域的模型上下文协议(MCP)的服务器实现。它提供了强大的基础设施来管理基于 MCP 的交互,还包含一个 MCP 检查工具,可用于调试和监控。该项目旨在简化并可靠地部署和管理 MCP 服务。

🚀 快速开始

要快速体验 Brest MCP 服务器,需完成安装并启动本地服务器,具体步骤如下:

安装

要在本地安装并配置 Brest MCP 服务器,请按照以下步骤操作:

  1. 安装 uv(如果尚未安装):

    • 在 Linux/macOS 上:
      curl -LsSf https://astral.sh/uv/install.sh | sh
      
    • 在 Windows 上:
      powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
      
  2. 克隆仓库:

    git clone https://github.com/Nijal-AI/Brest-mcp-server.git
    cd Brest-mcp-server
    
  3. 创建并激活虚拟环境:

    uv venv
    source .venv/bin/activate  # 在 Windows 上:.venv\Scripts\activate
    
  4. 安装依赖项:

    uv sync
    

启动本地服务器

  1. 确保虚拟环境已激活:

    source .venv/bin/activate  # 在 Windows 上:.venv\Scripts\activate
    
  2. 使用 MCP 检查工具启动服务器:

    npx @modelcontextprotocol/inspector uv run brest-mcp
    
  3. 在浏览器中访问 MCP 检查工具:

    • 代理:http://localhost:3000
    • 网页界面:http://localhost:5173

示例输出:

正在启动 MCP 检查工具...
代理服务器在端口 3000 监听
🔍 MCP 检查工具已运行在 http://localhost:5173 🚀

✨ 主要特性

  • 提供强大的基础设施,用于管理基于 MCP 的交互。
  • 包含 MCP 检查工具,可用于调试和监控。
  • 目标是简化并可靠地部署和管理 MCP 服务。

📦 安装指南

要在本地安装并配置 Brest MCP 服务器,请按照以下步骤操作:

  1. 安装 uv(如果尚未安装):

    • 在 Linux/macOS 上:
      curl -LsSf https://astral.sh/uv/install.sh | sh
      
    • 在 Windows 上:
      powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
      
  2. 克隆仓库:

    git clone https://github.com/Nijal-AI/Brest-mcp-server.git
    cd Brest-mcp-server
    
  3. 创建并激活虚拟环境:

    uv venv
    source .venv/bin/activate  # 在 Windows 上:.venv\Scripts\activate
    
  4. 安装依赖项:

    uv sync
    

💻 使用示例

基础用法

如果你想使用 Brest MCP 服务器与 AI 代理进行对话,可以在 tools 文件夹中使用提供的客户端:

uv run python tools/client.py src/server.py

📚 详细文档

技术

| 属性 | 详情 | |------|------| | 语言 | Python 3.12.3 或兼容版本 | | 依赖管理 | uv | | 检查工具 | 通过 Node.js 的 MCP 检查工具(npx) | | 环境 | 由 uv 管理的虚拟环境 | | Node.js | 用于 MCP 检查工具 |

开发

对于希望贡献或开发高级功能的开发者,请遵循以下额外步骤:

  1. 确保已设置虚拟环境,并安装了依赖项:

    uv venv
    uv sync
    
  2. 使用 MCP 检查工具进行调试和监控:

    npx @modelcontextprotocol/inspector uv run brest-mcp
    
  3. 参考 pyproject.toml 文件以获取有关依赖项和配置的详细信息。

贡献

欢迎贡献!要提出更改,请参考 CONTRIBUTING.md 文件。

许可证

该项目在 MIT 许可证下发布。有关详细信息,请参阅 LICENSE 文件。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端