docs: prepare v1 milestone release

This commit is contained in:
2026-06-16 10:58:31 +01:00
parent 5a078bb108
commit f4fa1cdbf6
9 changed files with 1089 additions and 166 deletions
+58 -9
View File
@@ -56,17 +56,19 @@ Prompt Builder
Provider Factory (createChatProvider)
OpenAI Provider OpenAI Responses API
OpenAI Provider OpenAI Responses API
Manual Provider → Copy-ready prompt output
Ollama Provider → Ollama /api/chat
Advisory Response
```
The provider layer is configurable via `CHATGPT_MCP_PROVIDER` env var. Three providers are available:
The provider layer is configurable via `CHATGPT_MCP_PROVIDER` env var (defaults to `"openai"`). Three providers are available:
| Value | Description | Use case |
| -------- | -------------------------------------------------------------- | ------------------------------------------- |
| `openai` | Default — calls ChatGPT via OpenAI API | Automated second-opinion queries |
| `manual` | Copy-paste — wraps prompts in a ready-to-copy format | Manual ChatGPT Web/Business as advisor |
| Value | Description | Use case |
| -------- | ---------------------------------------------------------------- | ------------------------------------------- |
| `openai` | Default — calls ChatGPT via OpenAI API | Automated second-opinion queries |
| `manual` | Copy-paste — wraps prompts in a ready-to-copy format | Manual ChatGPT Web/Business as advisor |
| `ollama` | Local AI — uses Ollama `/api/chat` with Qwen3 model | Offline/local second-opinion via local LLM |
For the **manual** provider, set `CHATGPT_MCP_PROVIDER=manual`. Each tool call returns a copy-ready prompt block you can paste into ChatGPT Web or ChatGPT Business. This turns Claude Code into an orchestrator: it builds the perfect prompt and formats it for you to hand off to ChatGPT as a second-opinion advisor — all without API calls, quotas, or cost.
@@ -132,7 +134,7 @@ All responses are advisory only.
### Testing
- 644 automated tests across 21 files
- 706 automated tests across 22 files
- Unit-tested utilities
- Prompt builder coverage
- OpenAI integration coverage
@@ -144,12 +146,29 @@ All responses are advisory only.
## Requirements
- Node.js 20+
- Node.js 22+
- OpenAI API key **OR** Ollama (with `qwen3:latest` model pulled) **OR** use `manual` provider for zero-API workflow
- Claude Code (or another MCP-compatible client)
---
## Quick Start
For the fastest onboarding, use the interactive setup helper:
```bash
npm install
npm run setup # Choose a provider and configure .env (interactive)
npm test # Verify everything works
npm start # Start the MCP server
```
The setup helper guides you through choosing between `openai`, `manual`, or `ollama` providers, then creates your `.env` and optionally `.claude/settings.local.json`.
See [docs/SETUP.md](./docs/SETUP.md) for full documentation.
---
## Installation
Install dependencies:
@@ -234,6 +253,35 @@ After opening the project in Claude Code, the server should be automatically dis
---
## V1 Milestone
**Status: V1 Complete**
### Implemented
- OpenAI provider (GPT-5.1 via Responses API)
- Manual Export provider (copy-paste-ready prompts for ChatGPT Web)
- Ollama provider (local AI via `qwen3.6:35b-a3b`)
- Provider abstraction layer with factory pattern
- Context budget enforcement and secret redaction
- 5 MCP review tools (`ask_chatgpt`, `review_plan`, `review_code`, `debug_issue`, `architecture_review`)
- Interactive local setup helper (`npm run setup`)
- 706 automated tests across 22 test files
### Capabilities
The ChatGPT MCP Server provides structured second-opinion workflows for:
- General questions and alternative viewpoints
- Implementation plan reviews
- Code reviews
- Debugging investigations
- Architecture reviews
All responses are advisory-only. Claude Code remains the primary coding agent.
---
## Current Status
### MVP Complete
@@ -250,7 +298,8 @@ Implemented:
- MCP stdio server
- Registration of all five MCP tools
- Claude Code integration documentation
- Comprehensive automated test suite (644 tests across 21 files)
- Comprehensive automated test suite (701 tests across 22 files)
- Interactive local setup helper (`npm run setup`)
### Next Steps