mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-01-30 06:22:04 +00:00
861005eeed
* fix: deprecate USE_FIXED_HTTP for SSE streaming support (Issue #524) The fixed HTTP implementation does not support SSE streaming required by clients like OpenAI Codex. This commit deprecates USE_FIXED_HTTP and makes SingleSessionHTTPServer the default. Changes: - Add deprecation warnings in src/mcp/index.ts and src/http-server.ts - Remove USE_FIXED_HTTP from docker-compose.yml and Dockerfile.railway - Update .env.example with deprecation notice - Rename npm script to start:http:fixed:deprecated - Update all documentation to remove USE_FIXED_HTTP references - Mark test case as deprecated Users should unset USE_FIXED_HTTP to use the modern SingleSessionHTTPServer which supports both JSON-RPC and SSE streaming. Closes #524 Concieved by Romuald Członkowski - www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * chore: bump version to 2.31.8 and add CHANGELOG entry - Fix comment inaccuracy: "deprecated" not "deprecated and removed" - Bump version from 2.31.7 to 2.31.8 - Add CHANGELOG entry documenting USE_FIXED_HTTP deprecation - Update all deprecation messages to reference v2.31.8 Concieved by Romuald Członkowski - www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Romuald Członkowski <romualdczlonkowski@MacBook-Pro-Romuald.local> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# n8n-MCP Documentation
|
|
|
|
Welcome to the n8n-MCP documentation. This directory contains comprehensive guides for installation, configuration, and troubleshooting.
|
|
|
|
## 📚 Documentation Index
|
|
|
|
### Getting Started
|
|
- **[Installation Guide](./INSTALLATION.md)** - Comprehensive installation guide covering all methods
|
|
- **[Claude Desktop Setup](./README_CLAUDE_SETUP.md)** - Step-by-step guide for Claude Desktop configuration
|
|
- **[Quick Start Tutorial](../README.md)** - Basic overview and quick start instructions
|
|
|
|
### Deployment
|
|
- **[HTTP Deployment Guide](./HTTP_DEPLOYMENT.md)** - Deploy n8n-MCP as an HTTP server for remote access
|
|
- **[Docker Deployment](./DOCKER_README.md)** - Complete Docker deployment and configuration guide
|
|
- **[Release Guide](./RELEASE_GUIDE.md)** - How to create releases and manage Docker tags
|
|
|
|
### Reference
|
|
- **[Troubleshooting Guide](./TROUBLESHOOTING.md)** - Solutions for common issues and errors
|
|
- **[HTTP Server Fix Documentation](./HTTP_SERVER_FINAL_FIX.md)** - Technical details of v2.3.2 HTTP server fixes
|
|
- **[Docker Optimization Guide](./DOCKER_OPTIMIZATION_GUIDE.md)** - Reference for optimized Docker builds (~150MB)
|
|
- **[Changelog](./CHANGELOG.md)** - Version history and release notes
|
|
|
|
## 🚀 Quick Links
|
|
|
|
### For Users
|
|
- [Install n8n-MCP](./INSTALLATION.md)
|
|
- [Configure Claude Desktop](./README_CLAUDE_SETUP.md)
|
|
- [Deploy with Docker](./DOCKER_README.md)
|
|
- [Troubleshoot Issues](./TROUBLESHOOTING.md)
|
|
|
|
### For Developers
|
|
- [HTTP Server Architecture](./HTTP_SERVER_FINAL_FIX.md)
|
|
- [Docker Build Optimization](./DOCKER_OPTIMIZATION_GUIDE.md)
|
|
- [Release Process](./RELEASE_GUIDE.md)
|
|
|
|
## 📋 Environment Variables
|
|
|
|
Key configuration options:
|
|
|
|
| Variable | Description | Default |
|
|
|----------|-------------|---------|
|
|
| `MCP_MODE` | Server mode: `stdio` or `http` | `stdio` |
|
|
| `AUTH_TOKEN` | Authentication token for HTTP mode | Required |
|
|
| `PORT` | HTTP server port | `3000` |
|
|
| `LOG_LEVEL` | Logging verbosity | `info` |
|
|
|
|
See [Installation Guide](./INSTALLATION.md#environment-configuration) for complete list.
|
|
|
|
## 🆘 Getting Help
|
|
|
|
1. Check the [Troubleshooting Guide](./TROUBLESHOOTING.md)
|
|
2. Review [HTTP Server Fix Documentation](./HTTP_SERVER_FINAL_FIX.md) for v2.3.2 issues
|
|
3. Open an issue on [GitHub](https://github.com/czlonkowski/n8n-mcp/issues)
|
|
|
|
## 📝 License
|
|
|
|
This project uses the Sustainable Use License. See [LICENSE](../LICENSE) for details. |