使用说明(Markdown 格式)

  • 项目简介 NetMCP 是一个基于 Python 的 MCP 服务器实现,利用 FastMCP 框架构建后端服务。它通过统一的接口向 MCP 客户端提供资源、工具与提示模板的管理与执行能力,能够在网络优化与系统命令执行等场景下为 LLM 提供结构化上下文与功能调用入口。

  • 主要功能点

    • 资源管理:注册并暴露策略配置卡等资源,支持读取与查询。
    • 工具注册与执行:提供多种工具用于发现、规划、执行和验证网络优化方案,以及对危险操作的自我保护(如 sudo 管理、审计日志)。
    • 渲染与执行计划:将优化计划渲染为可执行命令/脚本,支持分步执行和回滚。
    • MCP 安全与审计:实现命令允许列表、Sudo 授权、审计日志记录等安全机制,确保操作可追溯。
    • 会话与兼容性:通过 MCP 协议处理请求和响应,支持与不同类型的客户端进行对接,且具备会话管理能力。
    • 伺服端实现:服务端直接运行,提供 MCP 服务端入口,便于在云端或本地部署。
  • 安装步骤(简化版)

    1. 安装依赖的 Python 版本,建议使用 Python 3.10 及以上。
    2. 获取代码并进入项目目录。
    3. 在虚拟环境中安装依赖(如 requirements.txt,若仓库未包含则参考 README 中的依赖列表安装)。
    4. 启动服务器: 通过直接运行模块的方式启动:python -m server.main 或在云端/容器环境中通过 FastMCP Cloud 启动方式将服务器暴露为 MCP 服务端。
    5. 配置客户端连接:MCP 客户端需要通过一个配置条目指向服务器的启动命令和工作目录,确保能通过 MCP 客户端与本服务器建立连接。
  • 服务器配置(MCP 客户端的启动信息,JSON 描述,不是客户端代码) 说明:该 JSON 是为了帮助 MCP 客户端了解如何启动并连接到 NetMCP 服务器。请将具体的 cwd 路径替换为实际部署路径。配置字段包括服务器名称、启动命令以及参数等信息,MCP 客户端本身不需要此代码,而是读取配置以启动与 MCP 服务器的对话。

    服务器配置示例(JSON 结构,非代码块展示,供参考): { "server_name": "NetMCP", "description": "MCP 服务器:资源、工具、渲染与执行能力的后端服务", "command": "python", "args": ["-m", "server.main"], "cwd": "/path/to/NetMCP", "notes": "请将 cwd 替换为实际部署路径,确保服务器文件可被访问。客户端不需要该配置代码。" }

  • 基本使用方法

    • 连接与对话:将 MCP 客户端连接到 NetMCP 服务器后,通过 MCP 协议的请求向服务器请求资源、调用工具、获取与渲染提示模板等。
    • 资源与工具的调用顺序:先查询可用资源,再调用相应工具执行计划的渲染与执行,必要时进行回滚与审计,确保操作可审计。
    • 安全与审计:在生产环境使用时,请确保已经正确配置 sudo 授权、命令白名单,以及按需开启审计日志,便于追踪执行过程与结果。
    • 维护与扩展:可以新增资源、工具、以及优化配置卡,按照 MCP 的扩展机制注册到服务器中,保持系统的可扩展性。

信息

分类

AI与计算