项目简介
WithSeismic MCP Server 是一个生产就绪的 MCP 服务器模板,旨在帮助开发者轻松地托管和管理 AI 工具和 Prompt。它提供了远程服务器 (SSE) 和本地 stdio 两种运行模式,方便开发、测试和生产部署,让开发者专注于构建强大的 AI 工具和 Prompt,而无需担心基础设施的复杂性。
主要功能点
- 工具 (Tools): 支持注册和执行外部功能,例如调用 API、数据库操作等,供 LLM 客户端调用。
- Prompt 模板 (Prompts): 支持定义和管理 Prompt 模板,允许开发者定制与 LLM 的交互模式。
- 远程服务器模式 (SSE): 支持通过 Server-Sent Events (SSE) 协议提供远程访问,适用于生产环境和多客户端连接。
- 本地模式 (stdio): 支持本地标准输入输出 (stdio) 通信,方便本地开发、测试和调试。
- 自动发现: 工具和 Prompt 组件在导入时自动注册,简化配置和管理。
- 类型安全: 使用 TypeScript 开发,提供完善的类型定义和类型检查,提高开发效率和代码质量。
- 即时部署: 支持一键部署到 Railway 等平台,或本地快速启动。
安装步骤
- 确保已安装 Node.js (18.x 或更高版本) 和 pnpm (8.x 或更高版本) 包管理器。
- 克隆 GitHub 仓库到本地:'git clone https://github.com/dougwithseismic/withseismic-mcp.git'
- 进入项目根目录:'cd withseismic-mcp'
- 安装项目依赖:'pnpm install'
服务器配置
MCP 客户端需要配置以下服务器信息以连接到 WithSeismic MCP Server。以下是 SSE 远程服务器模式的配置示例,适用于需要远程访问和生产环境:
{ "serverName": "WithSeismic MCP Server (SSE)", "command": "pnpm", "args": ["start:sse"], "description": "启动 WithSeismic MCP 服务器的 SSE 远程服务器模式", "transport": "sse", "baseUrl": "http://localhost:3001/sse" }
配置说明:
- 'serverName': MCP 服务器的自定义名称,用于在客户端识别和管理连接。
- 'command': 启动服务器进程的命令,这里使用 'pnpm' 包管理器。
- 'args': 传递给启动命令的参数数组,'["start:sse"]' 表示执行 'pnpm start:sse' 脚本,启动 SSE 远程服务器模式。如果需要本地 stdio 模式,可以将 'args' 修改为 '["start"]',并相应修改 'transport' 配置。
- 'description': 对当前服务器配置的简要描述,方便用户区分不同的服务器配置。
- 'transport': 指定 MCP 客户端与服务器通信的传输协议,这里设置为 'sse',表示使用 Server-Sent Events 协议进行远程通信。
- 'baseUrl': 当 'transport' 设置为 'sse' 时,需要配置 'baseUrl',指向 SSE 服务器的地址。默认情况下,WithSeismic MCP Server 的 SSE 模式运行在 'http://localhost:3001/sse'。在生产环境中,请将 'localhost:3001' 替换为实际部署服务器的域名或 IP 地址和端口。
注意: 对于本地开发和调试,可以使用 stdio 模式,将 'transport' 设置为 'stdio',并使用 'pnpm start' 命令启动服务器。此时不需要配置 'baseUrl'。
基本使用方法
- 启动服务器: 根据需求选择运行模式。
- 本地 stdio 模式: 运行 'pnpm start' 命令启动本地服务器。
- 远程 SSE 模式: 运行 'pnpm start:sse' 命令启动远程服务器 (默认监听 'http://localhost:3001/sse')。
- 开发模式 (热重载): 可以使用 'pnpm dev' (stdio) 或 'pnpm dev:sse' (SSE) 命令启动开发服务器,支持代码热重载,方便开发调试。
- 配置 MCP 客户端: 在 MCP 客户端中,根据选择的服务器运行模式,配置相应的服务器连接信息,例如服务器名称、启动命令、传输协议和服务器地址等。
- 连接服务器: 启动 MCP 客户端,客户端将根据配置信息连接到 WithSeismic MCP Server。
- 发现和使用工具/Prompt: 客户端成功连接后,可以向服务器请求工具和 Prompt 列表,并根据需要调用注册的工具或获取 Prompt 模板,以实现与 LLM 的集成和功能扩展。
信息
分类
开发者工具