Persistent Terminal MCP Server

# Documentation Index This directory groups all documentation materials for the Persistent Terminal MCP Server. All links are relative to this file so you can browse them directly on GitHub. ## Quick Start - [README](../README.md) – Project overview and quick start - [README (中文)](../README.zh-CN.md) – 项目概览（中文版） - [CHANGELOG](../CHANGELOG.md) – Version history and updates ## Guides - [Usage Guide](guides/usage.md) – End-to-end workflow for the MCP tools - [Troubleshooting](guides/troubleshooting.md) – Common failure modes and fixes - [MCP Configuration](guides/mcp-config.md) – How to register the server with MCP clients - [Spinner Compaction](guides/spinner-compaction.md) – Animation compaction feature guide - [Quick Start: Spinner](guides/quick-start-spinner.md) – Quick guide for spinner feature ## Client-Specific Notes - [Claude Desktop / Claude Code Setup](clients/claude-code-setup.md) ## Reference - [Technical Details](reference/technical-details.md) – Architecture and implementation - [Tools Summary](reference/tools-summary.md) – Complete MCP tools reference - [Bug Fix Report](reference/bug-fixes.md) – Historical bug fixes - [Test Response](reference/test-response.md) – Test results and feedback - [Implementation Report](reference/IMPLEMENTATION_REPORT.md) – Detailed implementation notes - [Spinner Compaction Summary](reference/SPINNER_COMPACTION_SUMMARY.md) – Spinner feature summary ### Fixes Documentation - [**Fixes Index**](reference/fixes/README.md) – **Start here for all fixes** - [Fix Summary](reference/fixes/FIX_SUMMARY.md) – Complete fix overview - [Stdio Fix](reference/fixes/STDIO_FIX.md) – Cursor compatibility fix (technical) - [Cursor Fix Summary](reference/fixes/CURSOR_FIX_SUMMARY.md) – Cursor fix (Chinese) - [Quick Fix Guide](reference/fixes/QUICK_FIX_GUIDE.md) – 3-step quick fix - [Terminal Fixes](reference/fixes/TERMINAL_FIXES.md) – Terminal interaction fixes ## Project Meta - [Project Prompt](meta/project-prompt.md) – Original project requirements - [Project Status](meta/project-status.md) – Current status and roadmap ## 中文文档 - [快速开始](zh/quick-start.md) – Quick start guide (Chinese) - [使用提示词指南](zh/prompt-usage.md) – Prompt usage guide (Chinese) - [测试反馈总结](zh/test-feedback.md) – Test feedback (Chinese) - [项目概览（中文）](../README.zh-CN.md) – Project overview (Chinese) ## Testing - [Integration Tests](../tests/integration/README.md) – Integration test suite - Stdio purity test - Cursor scenario test - Terminal fixes test ## Contributing - [Contributing Guide](../CONTRIBUTING.md) – How to contribute - [License](../LICENSE) – MIT License --- ## Navigation by Topic ### 🚨 Having Issues? 1. [Quick Fix Guide](reference/fixes/QUICK_FIX_GUIDE.md) – Fast solutions 2. [Troubleshooting](guides/troubleshooting.md) – Common problems 3. [Fixes Index](reference/fixes/README.md) – All fixes ### 🎯 Getting Started 1. [README](../README.md) – Start here 2. [Usage Guide](guides/usage.md) – How to use 3. [MCP Configuration](guides/mcp-config.md) – Setup ### 🔧 For Developers 1. [Technical Details](reference/technical-details.md) – Architecture 2. [Fix Summary](reference/fixes/FIX_SUMMARY.md) – All fixes 3. [Integration Tests](../tests/integration/README.md) – Testing ### 📚 For Maintainers 1. [CHANGELOG](../CHANGELOG.md) – Version history 2. [Implementation Report](reference/IMPLEMENTATION_REPORT.md) – Details 3. [Project Status](meta/project-status.md) – Roadmap --- > **Note:** Documentation has been reorganized for better navigation. > All fix-related documents are now in `reference/fixes/`. > All integration tests are now in `tests/integration/`.