Sequential Thinking Tool API

순차적 사고 도구 API

Zod를 통한 강력한 입력 검증과 간단한 메모리 내 세션 저장소를 특징으로 하는 순차적 사고 세션과 생각을 관리하기 위한 Node.js/TypeScript 백엔드입니다.

목차

• 설치
• 서버 실행
• API 엔드포인트
  • 세션 생성
  • 포스트 생각
• 확인
• curl 명령 예시
• 개발

설치

1. 저장소를 복제합니다.지엑스피1
2. 종속성 설치:
   npm install

서버 실행

ts-node 사용(개발)

npm 스크립트 사용(사용 가능한 경우)

컴파일된 JavaScript 사용

서버는 기본적으로 포트 3000 에서 시작하거나 PORT 환경 변수에 지정된 포트에서 시작합니다.

API 엔드포인트

1. 첫 번째 생각으로 세션 만들기

• 엔드포인트: POST /api/sessions
• 설명: 새 세션을 생성하고 제공된 생각을 해당 세션의 첫 번째 생각으로 저장합니다. 새 세션 ID와 처리된 생각 정보를 반환합니다.
• 요청 본문:
  { "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 엔드포인트는 SSE(Server-Sent Events)를 사용하여 서버 이벤트를 클라이언트로 실시간 단방향 스트리밍할 수 있도록 합니다. 이는 서버를 폴링하지 않고도 세션 또는 사고 처리에 대한 업데이트를 실시간으로 수신하려는 클라이언트에게 유용합니다.

엔드포인트

• GET /api/mcp/sse
• 설명: 지속적인 SSE 연결을 설정합니다. 서버는 이벤트가 발생하면 클라이언트에 이벤트를 푸시합니다.
• 응답:
  • 콘텐츠 유형: text/event-stream
  • 이벤트는 data: 로 시작하는 줄로 전송되며, 그 뒤에 JSON으로 인코딩된 이벤트 객체가 옵니다.

curl 명령 예시

이벤트 응답 예시

사용 참고 사항

• 이벤트 수신을 계속하려면 연결을 열어 두세요.
• 각 이벤트는 JSON 객체입니다. 클라이언트 측에 이벤트가 도착하면 처리하세요.
• 특정 세션에 대한 이벤트를 수신해야 하는 경우 구현에서 지원하는 쿼리 매개변수를 포함합니다(예: /api/mcp/sse?sessionId=... ).

확인

/thoughts 에 대한 모든 POST 요청은 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 에 있습니다.

특허

MIT