Sequential Thinking Tool API

API de la herramienta de pensamiento secuencial

Un backend de Node.js/TypeScript para gestionar sesiones de pensamiento y pensamientos secuenciales, con validación de entrada robusta con Zod y un simple almacenamiento de sesiones en memoria.

Tabla de contenido

• Instalación
• Ejecución del servidor
• Puntos finales de API
  • Crear sesión
  • Pensamiento posterior
• Validación
• Ejemplos de comandos curl
• Desarrollo

Instalación

1. Clonar el repositorio:
   git clone <your-repo-url> cd SQ
2. Instalar dependencias:
   npm install

Ejecución del servidor

Uso de ts-node (desarrollo)

Usando el script npm (si está disponible)

Usando JavaScript compilado

El servidor se iniciará en el puerto 3000 de forma predeterminada o en el puerto especificado en su variable de entorno PORT .

Puntos finales de API

1. Crear una sesión con el primer pensamiento

• Punto final: POST /api/sessions
• Descripción: Crea una nueva sesión y almacena el pensamiento proporcionado como el primero de esa sesión. Devuelve el ID de la nueva sesión y la información del pensamiento procesado.
• Cuerpo de la solicitud:
  { "thought": "string (required)", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "isRevision": false, // optional "revisesThought": 2, // optional "branchFromThought": 1, // optional "branchId": "string", // optional "needsMoreThoughts": false // optional }
• Respuesta:
  { "sessionId": "<uuid>", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 1, "processedThought": "This is my first thought." }

2. Publicar un pensamiento adicional

• Punto final: POST /api/sessions/:sessionId/thoughts
• Descripción: Añade un pensamiento a la sesión especificada. La entrada se valida mediante Zod.
• Cuerpo de la solicitud:
  { "thought": "string (required)", "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true, "isRevision": false, // optional "revisesThought": 1, // optional "branchFromThought": 1, // optional "branchId": "string", // optional "needsMoreThoughts": false // optional }
• Respuesta:
  { "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 2, "processedThought": "This is my second thought." }

MCP SSE (Eventos enviados por el servidor)

Descripción general

El punto final MCP SSE permite la transmisión unidireccional en tiempo real de eventos del servidor a los clientes mediante Eventos Enviados por el Servidor (SSE). Esto resulta útil para los clientes que desean recibir actualizaciones sobre la sesión o el procesamiento de pensamientos a medida que ocurren, sin consultar el servidor.

Punto final

• OBTENER /api/mcp/sse
• Descripción: Establece una conexión SSE persistente. El servidor enviará eventos al cliente conforme ocurran.
• Respuesta:
  • Tipo de contenido: text/event-stream
  • Los eventos se envían como líneas que comienzan con data: , seguido de un objeto de evento codificado en JSON.

Ejemplo de comando curl

Ejemplo de respuesta a un evento

Notas de uso

• Mantenga la conexión abierta para continuar recibiendo eventos.
• Cada evento es un objeto JSON. Gestione cada evento conforme llega al cliente.
• Si necesita escuchar eventos para una sesión específica, incluya parámetros de consulta compatibles con su implementación (por ejemplo, /api/mcp/sse?sessionId=... ).

Validación

Todas las solicitudes POST a /thoughts se validan con Zod. Las solicitudes no válidas devolverán un estado 400 y una lista de errores de validación.

Flujo de usuario: Sesión creada a primera vista

1. El usuario envía su primer pensamiento a /api/sessions
   • El servidor crea una nueva sesión y almacena el primer pensamiento.
   • Devuelve el nuevo sessionId y la información del pensamiento procesado.

   Ejemplo de rizo:

   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 }'

   Ejemplo de respuesta:

   { "sessionId": "abc123", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 1, "processedThought": "This is my first thought." }
2. El usuario envía pensamientos adicionales a /api/sessions/:sessionId/thoughts
   • El servidor agrega el pensamiento a la sesión existente.

   Ejemplo de rizo:

   curl -X POST http://localhost:3000/api/sessions/abc123/thoughts \ -H "Content-Type: application/json" \ -d '{ "thought": "This is my second thought.", "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true }'

   Ejemplo de respuesta:

   { "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 2, "processedThought": "This is my second thought." }

Ejemplo de respuesta de error (entrada no válida)

Desarrollo

• La configuración de TypeScript está en tsconfig.json .
• Los esquemas Zod están en src/types.ts .
• El middleware de validación está en src/api/validationMiddleware.ts .
• La lógica del servidor principal está en src/api/httpServer.ts .

Licencia

Instituto Tecnológico de Massachusetts (MIT)