Sequential Thinking Tool API

API инструмента последовательного мышления

Бэкэнд Node.js/TypeScript для управления последовательными сеансами мышления и мыслями, включающий надежную проверку входных данных с помощью Zod и простое хранилище сеансов в памяти.

Оглавление

• Установка
• Запуск сервера
• Конечные точки API
  • Создать сессию
  • Пост Мысль
• Проверка
• Примеры команд curl
• Разработка

Установка

1. Клонируйте репозиторий:
   git clone <your-repo-url> cd SQ
2. Установить зависимости:
   npm install

Запуск сервера

Использование ts-node (разработка)

Использование скрипта npm (если доступно)

Использование скомпилированного JavaScript

По умолчанию сервер запустится на порту 3000 или на порте, указанном в переменной среды PORT .

Конечные точки API

1. Создайте сеанс с First Thought

• Конечная точка: POST /api/sessions
• Описание: Создает новый сеанс и сохраняет предоставленную мысль как первую мысль в этом сеансе. Возвращает новый идентификатор сеанса и обработанную информацию о мысли.
• Текст запроса:
  { "thought": "string (required)", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "isRevision": false, // optional "revisesThought": 2, // optional "branchFromThought": 1, // optional "branchId": "string", // optional "needsMoreThoughts": false // optional }
• Ответ:
  { "sessionId": "<uuid>", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 1, "processedThought": "This is my first thought." }

2. Опубликуйте дополнительную мысль

• Конечная точка: POST /api/sessions/:sessionId/thoughts
• Описание: Добавляет мысль в указанный сеанс. Ввод проверяется с помощью Zod.
• Текст запроса:
  { "thought": "string (required)", "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true, "isRevision": false, // optional "revisesThought": 1, // optional "branchFromThought": 1, // optional "branchId": "string", // optional "needsMoreThoughts": false // optional }
• Ответ:
  { "thoughtNumber": 2, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 2, "processedThought": "This is my second thought." }

MCP SSE (события, отправленные сервером)

Обзор

Конечная точка MCP SSE обеспечивает одностороннюю потоковую передачу событий сервера клиентам в режиме реального времени с использованием Server-Sent Events (SSE). Это полезно для клиентов, которые хотят получать обновления о сеансе или обработке мыслей по мере их возникновения, без опроса сервера.

Конечная точка

• ПОЛУЧИТЬ /api/mcp/sse
• Описание: Устанавливает постоянное соединение SSE. Сервер будет отправлять события клиенту по мере их возникновения.
• Ответ:
  • Тип содержимого: text/event-stream
  • События отправляются в виде строк, начинающихся с data: за которыми следует объект события в кодировке JSON.

Пример команды curl

Пример ответа на событие

Заметки об использовании

• Оставьте соединение открытым, чтобы продолжить получать события.
• Каждое событие — это объект JSON. Обрабатывайте каждое событие по мере его поступления на клиентскую сторону.
• Если вам необходимо прослушивать события для определенного сеанса, включите параметры запроса, поддерживаемые вашей реализацией (например, /api/mcp/sse?sessionId=... ).

Проверка

Все запросы POST к /thoughts проверяются с помощью Zod. Недействительные запросы вернут статус 400 и список ошибок проверки.

Поток пользователя: сеанс создан по первой мысли

1. Пользователь отправляет свою первую мысль в /api/sessions
   • Сервер создает новый сеанс и сохраняет первую мысль.
   • Возвращает новый sessionId и обработанную информацию о мысли.

   Пример завитка:

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

   Пример ответа:

   { "sessionId": "abc123", "thoughtNumber": 1, "totalThoughts": 3, "nextThoughtNeeded": true, "branches": [], "thoughtHistoryLength": 1, "processedThought": "This is my first thought." }
2. Пользователь отправляет дополнительные мысли в /api/sessions/:sessionId/thoughts
   • Сервер добавляет мысль в существующий сеанс.

   Пример завитка:

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

   Пример ответа:

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

Пример ответа об ошибке (неверный ввод)

Разработка

• Конфигурация TypeScript находится в tsconfig.json .
• Схемы Zod находятся в src/types.ts .
• Промежуточное программное обеспечение проверки находится в src/api/validationMiddleware.ts .
• Основная логика сервера находится в src/api/httpServer.ts .

Лицензия

Массачусетский технологический институт