顺序思维工具API

SQ-MCP是一个基于Node.js/TypeScript的后端服务,用于管理顺序思维会话和思考过程。它支持三种强大的接口:STDIO(MCP工具)、SSE(服务器发送事件)和REST API,适用于本地工具/代理/CLI集成、实时流式输出以及标准HTTP请求/响应工作流。

  • by bta4935
  • 更新于
在 GitHub 查看 bta4935/SQ-MCP

使用说明

基本能力

产品定位

SQ-MCP是一个顺序思维管理工具,支持多种接口协议,适用于代理、LLM和Web客户端的集成。

核心功能

  1. STDIO (MCP工具): 通过stdin/stdout进行本地工具/代理/CLI集成,使用Model Context Protocol (MCP)。
  2. SSE (服务器发送事件): 支持实时、逐步输出的流式工具,适用于LLM、代理或Web客户端。
  3. REST API: 提供标准的HTTP请求/响应工作流。

适用场景

  1. 本地代理或CLI工具集成。
  2. 需要实时流式输出的LLM或代理应用。
  3. 标准HTTP请求/响应的Web应用。

使用教程

使用依赖

  1. 克隆仓库:
    git clone <your-repo-url>
    cd SQ
    
  2. 安装依赖:
    npm install
    

安装教程

  1. 使用ts-node(开发环境):
    npx ts-node src/api/httpServer.ts
    
  2. 使用npm脚本(如果可用):
    npm run dev
    
  3. 使用编译后的JavaScript:
    npx tsc
    node dist/main.js
    
  4. 使用Docker:
    docker build -t sq-mcp .
    docker run -p 3000:3000 sq-mcp
    

调试方式

  1. 启动服务器后,默认端口为3000,可以通过环境变量PORT指定其他端口。
  2. 使用curl测试REST API:
    curl -X POST http://localhost:3000/api/sessions -H "Content-Type: application/json" -d '{"thought":"This is my first thought.","thoughtNumber":1,"totalThoughts":3,"nextThoughtNeeded":true}'
    
  3. 使用EventSource测试SSE:
    const es = new EventSource('https://sq-mcp.onrender.com/api/sessions/12345/thoughts/stream');
    es.onmessage = e => console.log(JSON.parse(e.data));