使用说明

• 项目简介
  • Sardis 提供一个面向大语言模型的后端服务，采用 MCP（Model Context Protocol）规范来管理可供 LLM 使用的资源、工具和提示模板，并通过 JSON-RPC 与客户端通信，提供一致的上下文服务能力。
• 主要功能点
  • 资源管理：托管与访问可供 LLM 使用的数据与上下文资源（Resources）。
  • 工具注册与执行：注册外部工具，并允许 LLM 调用以实现对外部功能的访问。
  • 提示模板：定义、渲染与管理可定制的 Prompt 模板，支持多种交互场景。
  • JSON-RPC 通信：服务器端以 JSON-RPC 接收请求（读取资源、调用工具、获取 Prompt 等），返回标准化的响应或通知。
  • 会话与能力声明：对会话状态、可用能力等进行管理与披露。
  • 多传输协议支持：提供多种传输模式（如 stdio、SSE、WebSocket）以适配不同应用场景的集成需求。
• 安装步骤
  • 先确保你的环境具备 Node.js（用于 MCP 服务器）以及 npm/yarn。
  • 运行 MCP 服务器（ Claude Desktop / Cursor / ChatGPT 等客户端可通过 MCP 服务端接入）：
    • 快速启动命令（直接执行即可启动 MCP 服务器）：npx @sardis/mcp-server start
  • 服务器启动后，MCP 客户端即可通过配置连接到此 MCP 服务器，进行资源查询、工具调用与提示渲染。
• 服务器配置（客户端使用的连接配置，JSON 格式，包含 server name、command、args 等信息）
  • server_name: sardis-mcp
  • command: npx
  • args: ["@sardis/mcp-server", "start"]
  • 注释说明：这是 MCP 客户端启动服务器所需的命令信息，客户端据此能够自动化启动并连接到 MCP 服务器。
  • 传输选项（可选、按需配置）: ["stdio", "sse", "websocket"]
• 基本使用方法
  • 启动服务器后，确保客户端能通过 JSON-RPC 请求 MCP 服务器的接口来读取资源、执行工具、获取 Prompts 等。
  • 客户端可以通过标准的 JSON-RPC 调用完成资源读取、工具执行、模板渲染等工作流，服务器负责会话管理与能力声明。
  • 如需多传输模式，请根据客户端能力选择合适的传输方式（如 SSE/WebSocket），以实现实时通知与交互。