README Documentation
TPC Server
A Node.js/Express API for AI-human collaboration, starting with JSON file storage for thoughts and plans.
Setup and Usage
- Install dependencies:
npm install - Start the server:
node server.js - The server runs on
http://localhost:3000
Changelog
See CHANGELOG.md for detailed release notes.
Testing
Run npm test to execute Jest tests verifying the endpoint functionality.
Run npx playwright test for E2E UI tests.
Project Structure
server.js: Main Express server with modular structure (db/, routes/, middleware/).data/tpc.db: SQLite database for persistent storage of thoughts and plans.thoughts.test.jsandplans.test.js: Core unit tests using Supertest for API endpoints.v1.0.test.jsthroughv2.7.test.js: Version-specific unit tests covering endpoints, validation, persistence, schema migrations, and regressions.e2e/v2.0.test.jsthroughe2e/v2.7.test.js: Playwright E2E tests for UI interactions, including search, tagging, and dynamic rendering.package.json: Dependencies and scripts (includessqlite3for DB,jestfor unit testing,playwrightfor E2E,markedfor Markdown rendering).public/index.html,public/index.js,public/style.css: Static single-page UI for viewing, searching, and editing plans/thoughts with AI collaboration focus.routes/search.js: Dedicated route for full-text search across plans and thoughts.
Usage Examples
- Retrieve all thoughts:
curl http://localhost:3000/thoughts - Retrieve all plans:
curl http://localhost:3000/plans - Create a thought:
curl -X POST http://localhost:3000/thoughts -H "Content-Type: application/json" -d '{"content": "My thought"}' - Create a plan:
curl -X POST http://localhost:3000/plans -H "Content-Type: application/json" -d '{"title": "My Plan", "description": "Plan details"}' - Update plan status:
curl -X PATCH http://localhost:3000/plans/1 -H "Content-Type: application/json" -d '{"status": "in_progress"}' - Search across plans/thoughts:
curl "http://localhost:3000/search?q=AI&type=plans&tags=urgent&limit=5" - Add tags to a plan:
curl -X PATCH http://localhost:3000/plans/1/tags -H "Content-Type: application/json" -d '{"tag": "ai"}'(appends) or{"tags": ["ai", "urgent"]}(replaces) - Filter plans by tags:
curl "http://localhost:3000/plans?tags=ai,urgent" - View UI: Visit http://localhost:3000/index.html after starting the server. Use the search input for queries, edit tags in detail views, and filter lists by tags.
When editing plans, use Markdown syntax in descriptions for formatting (e.g., bold text). Search and tag functionality enhances organization for AI-human collaboration workflows.
Features
- Modular server architecture: Organized into db/, routes/, and middleware/ for maintainable API development.
- SQLite persistence: Single
data/tpc.dbfor thoughts and plans with idempotent schema migrations. - Comprehensive testing: Jest for unit tests (endpoints, validation, integrations) and Playwright for E2E UI tests (rendering, interactions).
- AI collaboration focus: Endpoints like
/contextaggregate data for agent memory; supports human edits with review flags. - Rich text support: Plan descriptions accept and display Markdown formatting (bold, lists, etc.) in the UI using marked.js.
- Search and organization: Full-text search API (
/search?q=) with type/tags/limit filters; UI search input and tag-based filtering/editing. - Tagging system: Add/edit/filter tags on plans/thoughts via API/UI for better categorization (e.g., ['ai', 'urgent']).
v2.7 - Search and Organization
Features Implemented
- Full-text search endpoint (
GET /search?q=<query>) with optional?type=plans|thoughts,?tags=tag1,tag2,?limit=Nfor targeted results. - Tagging system:
tagscolumn (JSON array) on plans/thoughts tables; manage viaPOST/PUT/PATCH /plans/:id/tags(and for thoughts). - Tag filtering:
?tags=ai,urgent(AND logic) on list endpoints (/plans,/thoughts,/search). - Enhanced
/contextwith?search=<query>to filter aggregated data. - UI: Global search input, tag editing in details, tag filtering dropdowns in lists.
Usage
- API search:
curl "http://localhost:3000/search?q=collaboration&type=plans&tags=ai" - Tag a plan:
curl -X PATCH http://localhost:3000/plans/1/tags -H "Content-Type: application/json" -d '{"tags": ["ai", "urgent"]}'(replace) or{"tag": "new"}(append). - Filter by tags:
curl "http://localhost:3000/plans?tags=ai,urgent" - UI: Enter query in search box; click tags to edit/filter in plan/thought views.
Notable Changes
- Schema addition:
tagsTEXT column (default '[]') to plans/thoughts tables; backward compatible migration with backfill. - New route:
/searchfor unified querying. - Builds on v2.6 Markdown support and modular structure.
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source