SageFs MCP Server

使用说明(Markdown 格式)

  • 项目简介

    • SageFs 是一个面向 MCP 的后端服务器,负责向 MCP 客户端提供可访问的上下文信息、资源数据、可执行工具以及可渲染的提示模板。它通过 JSON-RPC/SSE 等协议与客户端通信,支持多会话、资源/工具管理和提示渲染等核心能力。
  • 主要功能点

    • 资源管理:托管和访问资源数据,供 LLM 客户端读取与分析。
    • 工具注册与执行:注册外部工具,允许 MCP 客户端执行外部功能。
    • 提示模板:定义和渲染 Prompt 模板,支持自定义的 LLM 交互模式。
    • 会话与能力声明:会话管理、并发访问控制与能力声明。
    • 多传输协议:SSE、Stdio、WebSocket 等传输方式,适配不同客户端。
    • 健康与监控:提供健康状态、端点信息和仪表盘入口。
  • 安装步骤(本地运行)

    • 确保开发环境中安装了 .NET 10 SDK。
    • 获取代码后,在仓库根目录执行构建/打包(如存在的构建脚本或工作流所述流程)。
    • 以任意目录启动 SageFs 守护进程(daemon)。通常使用类似 sagefs 命令启动:
      • sagefs
    • 启动后,服务会暴露 MCP 端点和 Dashboard 的访问地址,示例:
      • MCP 端点(用于 MCP 客户端连接):http://localhost:37749/sse
      • Dashboard: http://localhost:37750/dashboard
  • 服务器配置(MCP 客户端用的配置信息,JSON 格式,包含 server name、command、args 等)

    • 注意:以下配置信息面向 MCP 客户端的连接说明,实际配置需在客户端侧使用。示例仅供参考并尽量贴合仓库信息:
    • 服务器名称(server name):SageFs MCP Server
    • 启动命令(command):sagefs
    • 启动参数(args):[ "--mcp-port", "37749" ]
    • 说明:端口与地址需与 daemon 启动时暴露的 MCP 端点一致。客户端通过该配置建立与 MCP 服务器的连接,并使用 SSE/HTTP 等传输实现 JSON-RPC 请求/响应。
  • 基本使用方法

    • 启动后,通过 MCP 客户端连接到 SageFs 提供的 MCP 端点,进行资源读取、工具调用、Prompts 获取等操作。
    • MCP 客户端可以使用相应的 JSON-RPC 请求来读取资源、执行工具、获取 Prompt 模板等。
    • 服务器将处理请求、返回 JSON-RPC 响应,或通过通知向客户端推送状态变化。
  • 额外信息

    • 官方端点示例:
      • MCP 端点(SSE): http://localhost:37749/sse
      • Dashboard: http://localhost:37750/dashboard
    • 客户端集成时,请参考 SageFs 提供的 MCP 参考工具、工具集、以及示例。

服务器信息