-
项目简介: SinglePageStartup (SPS) 是一个模块化Web开发框架,旨在快速构建MVP和全功能业务平台。SPS MCP服务器是该框架的一个组成部分,专门用于通过Model Context Protocol (MCP) 向大型语言模型(LLM)客户端提供标准化上下文信息和功能,例如查询模块中的“Widgets”资源或调用相关工具。它充当LLM客户端与SPS后端服务之间的桥梁。
-
主要功能点:
- 资源托管与访问: 允许LLM客户端通过统一接口访问SPS框架中定义的各种“资源”,例如获取指定模块中Widget的详细预览信息。
- 工具注册与执行: 提供可供LLM调用的外部“工具”,这些工具可以执行特定业务逻辑,如获取Widget预览。
- 标准化通信: 使用JSON-RPC协议与LLM客户端通信,确保数据交换的规范性和互操作性。
- 上下文提供: 以结构化的方式向LLM客户端提供业务实体(如Widget)的上下文,辅助LLM理解并生成相关内容。
-
安装步骤:
- 安装前置条件: 确保您的系统已安装Node.js (版本 ^20.x), Bun (版本 ^1.2.3), 以及Docker和Docker Compose。
- 安装依赖: 在项目根目录运行 'npm install'。
- 创建环境变量并启动服务: 运行 './up.sh' 脚本以创建所有必要的环境变量并启动Docker服务(包括Postgres和Redis)。
- 数据库迁移: 运行 './migrate.sh' 脚本来执行数据库迁移。
- (可选) 填充基础数据: 如果需要预设数据,运行 'npx nx run api:db:seed'。
- 启动API服务: 运行 'npm run api:dev'。
- 启动Host服务: 运行 'npm run host:dev'。 MCP服务器作为独立进程通过Bun运行,并在上述步骤完成后即可被MCP客户端发现和连接。
-
服务器配置(供MCP客户端使用): MCP服务器本身无需额外手动配置即可运行。对于MCP客户端而言,连接到此MCP服务器通常需要提供MCP服务器的启动命令。以下是MCP客户端连接此服务器可能需要的配置示例:
{ "servers": [ { "name": "singlepagestartup-mcp", "command": "bun", "args": [ "run", "apps/mcp/server.ts" ], "description": "连接到SinglePageStartup框架的MCP服务器,提供业务模块资源和工具。" } ] }- 'name': MCP服务器的唯一标识符,本示例中为 'singlepagestartup-mcp'。
- 'command': 用于启动MCP服务器的执行器,例如 'bun'。
- 'args': 传递给 'command' 的参数。这里指示 'bun' 运行 'apps/mcp/server.ts' 文件。
- 'description': 服务器的简要说明。
-
基本使用方法: 一旦MCP服务器启动并运行,LLM客户端可以通过JSON-RPC协议与它通信。例如,LLM客户端可以发起请求来:
- 读取资源: 请求获取特定模块中Widget的预览信息。例如,客户端可以发送一个JSON-RPC请求,调用一个内部指令来读取URI为 'mcp://singlepagestartup-mcp/widget-preview?module=blog&widgetId=some_id' 的资源。
- 调用工具: 调用 'get-widget-preview' 工具,并传入 'module' 和 'widgetId' 参数来获取Widget的详细预览。LLM客户端可以根据自己的上下文生成这样的工具调用。 通过这些交互,LLM客户端能够安全且标准化地访问和利用SinglePageStartup框架提供的后端数据和功能。
信息
分类
AI与计算