docs: update documentation for v2.3.2 and remove legacy files

Major documentation cleanup and updates:

Updates:
- Add USE_FIXED_HTTP=true to all Docker and HTTP deployment examples
- Update main README with v2.3.2 release notes and version badges
- Add HTTP server troubleshooting section for stream errors
- Update CHANGELOG with v2.3.1 and v2.3.2 entries
- Update all configuration examples (.env.example, docker-compose.yml)
- Add clear instructions for using the fixed HTTP implementation

Removed legacy documentation (11 files):
- Implementation plans that have been completed
- Architecture analysis documents
- Intermediate fix documentation
- Planning documents for features now implemented
- Duplicate SETUP.md (content merged into INSTALLATION.md)

The documentation now accurately reflects the current v2.3.2 state
with the complete HTTP server fix using USE_FIXED_HTTP=true.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-06-14 18:52:25 +02:00
parent baf5293cb8
commit 63ef011aec
21 changed files with 191 additions and 3632 deletions

View File

@@ -4,6 +4,7 @@ This guide helps resolve common issues with n8n-MCP.
## Table of Contents
- [HTTP Server Issues](#http-server-issues)
- [Docker Issues](#docker-issues)
- [Installation Issues](#installation-issues)
- [Runtime Errors](#runtime-errors)
@@ -12,6 +13,73 @@ This guide helps resolve common issues with n8n-MCP.
- [Network and Authentication](#network-and-authentication)
- [Performance Issues](#performance-issues)
## HTTP Server Issues
### "Stream is not readable" Error
#### Symptoms
- Error: `InternalServerError: stream is not readable`
- HTTP 400 Bad Request responses
- Server works locally but fails in HTTP mode
#### Solution (v2.3.2+)
This issue has been fixed in v2.3.2. Ensure you're using the fixed implementation:
```bash
# Set the environment variable
export USE_FIXED_HTTP=true
# Or in your .env file
USE_FIXED_HTTP=true
```
#### Technical Details
- **Cause**: Express.json() middleware was consuming the request stream
- **Fix**: Removed body parsing middleware for MCP endpoints
- **See**: [HTTP Server Fix Documentation](./HTTP_SERVER_FINAL_FIX.md)
### "Server not initialized" Error
#### Symptoms
- Error: `Bad Request: Server not initialized`
- Error code: -32000
- Occurs when using StreamableHTTPServerTransport
#### Solution
Use the fixed HTTP implementation (v2.3.2+):
```bash
# Use the fixed server
MCP_MODE=http USE_FIXED_HTTP=true npm start
# Or with Docker
docker run -e MCP_MODE=http -e USE_FIXED_HTTP=true ...
```
### Authentication Failed
#### Symptoms
- 401 Unauthorized responses
- "Authentication failed" in logs
#### Solutions
1. **Check AUTH_TOKEN format:**
```bash
# Should be at least 32 characters
echo -n "$AUTH_TOKEN" | wc -c
```
2. **Verify token in requests:**
```bash
curl -H "Authorization: Bearer $AUTH_TOKEN" ...
```
3. **Check .env file:**
```bash
# No quotes needed in .env
AUTH_TOKEN=your-token-here
```
## Docker Issues
### Container Won't Start