Skip to content

Commit 6eaf862

Browse files
committed
Update README.md to enhance project description, features, and installation instructions
1 parent 7130a77 commit 6eaf862

File tree

2 files changed

+477
-80
lines changed

2 files changed

+477
-80
lines changed

README.md

Lines changed: 81 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,82 @@
1-
# Sequential Thinking MCP Server 🧠
2-
3-
A powerful Model Context Protocol (MCP) server that helps break down complex problems into clear, sequential steps. This tool enhances structured problem-solving by managing thought sequences, allowing revisions, and supporting multiple solution paths.
4-
5-
## 🌟 Key Features
6-
7-
- **Sequential Problem Solving**: Break down complex problems step-by-step
8-
- **Full MCP Integration**: Seamless integration with Claude Desktop
9-
10-
## 🚀 Getting Started
11-
12-
### System Requirements
13-
- Python 3.10+
14-
- UV package manager (preferred) or pip
15-
- Claude Desktop application
16-
17-
### Step-by-Step Installation
18-
19-
1. **Set Up Environment**
20-
```bash
21-
# Create and activate virtual environment
22-
uv venv
23-
.venv\Scripts\activate # Windows
24-
source .venv/bin/activate # Unix/Mac
25-
```
26-
27-
2. **Install Package**
28-
```bash
29-
uv venv
30-
.venv\Scripts\activate
31-
uv pip install -e .
32-
```
33-
34-
3. **Launch Server**
35-
```bash
36-
mcp-sequential-thinking
37-
```
38-
39-
4. **Configure Claude Desktop**
40-
Add to `claude_desktop_config.json`:
41-
```json
42-
{
43-
"mcpServers": {
44-
"sequential-thinking": {
45-
"command": "C:\\path\\to\\your\\.venv\\Scripts\\mcp-sequential-thinking.exe"
46-
}
1+
# Sequential Thinking MCP Server
2+
3+
A Model Context Protocol (MCP) server that helps break down complex problems into clear, sequential steps. This tool enhances structured problem-solving by managing thought sequences, allowing revisions, and supporting multiple solution paths.
4+
5+
## Features
6+
7+
- 🧠 **Sequential Problem Solving**: Break down complex problems step-by-step
8+
- 🔄 **Thought Revisions**: Review and modify previous thinking steps
9+
- 🌿 **Branching Paths**: Explore multiple solution approaches
10+
- 📊 **Progress Tracking**: Monitor thought sequences and branches
11+
-**Rich Formatting**: Visual distinction between thoughts, revisions, and branches
12+
13+
## Prerequisites
14+
15+
- Python 3.11 or higher
16+
- UV package manager ([Install Guide](https://github.com/astral-sh/uv))
17+
18+
## Project Structure
19+
20+
```
21+
mcp-sequential-thinking/
22+
├── mcp_sequential_thinking/
23+
│ ├── server.py
24+
│ └── __init__.py
25+
├── README.md
26+
└── pyproject.toml
27+
```
28+
29+
## Quick Start
30+
31+
1. **Set Up Project**
32+
```bash
33+
# Create and activate virtual environment
34+
uv venv
35+
.venv\Scripts\activate # Windows
36+
source .venv/bin/activate # Unix
37+
38+
# Install package and dependencies
39+
uv pip install -e .
40+
```
41+
42+
## Claude Desktop Integration
43+
44+
Add to your Claude Desktop configuration (`%APPDATA%\Claude\claude_desktop_config.json` on Windows):
45+
46+
```json
47+
{
48+
"mcpServers": {
49+
"sequential-thinking": {
50+
"command": "uv",
51+
"args": [
52+
"--directory",
53+
"C:\\path\\to\\your\\mcp-sequential-thinking\\mcp_sequential_thinking",
54+
"run",
55+
"server.py"
56+
]
4757
}
4858
}
49-
```
59+
}
60+
```
5061

51-
## 🛠️ Core Parameters
62+
## Development
63+
64+
Test the server manually:
65+
```bash
66+
cd mcp_sequential_thinking
67+
uv run server.py
68+
```
69+
70+
## Troubleshooting
71+
72+
Common issues:
73+
74+
- **Server Connection Issues**
75+
- Verify paths in claude_desktop_config.json
76+
- Check Claude Desktop logs: `%APPDATA%\Claude\logs`
77+
- Test manual server start
78+
79+
## Parameters
5280

5381
| Parameter | Description | Required |
5482
|-----------|-------------|----------|
@@ -61,38 +89,11 @@ uv pip install -e .
6189
| `branch_from_thought` | Starting point for new branch | No |
6290
| `branch_id` | Unique branch identifier | No |
6391

64-
## 🔄 Response Format
65-
66-
The server returns JSON with:
67-
- `thoughtNumber`: Current step number
68-
- `totalThoughts`: Total steps estimated
69-
- `nextThoughtNeeded`: Whether more steps needed
70-
- `branches`: List of active branch IDs
71-
- `thoughtHistoryLength`: Total thoughts recorded
72-
73-
## 👩‍💻 Development Setup
74-
75-
1. Clone repository
76-
2. Create development environment:
77-
```bash
78-
uv venv
79-
source .venv/bin/activate # or `.venv\Scripts\activate` on Windows
80-
uv pip install -e .
81-
```
82-
83-
## 📝 Example Usage
84-
85-
To use with Claude:
86-
1. Start the server
87-
2. In Claude, begin with: "Use sequential thinking to solve this problem..."
88-
3. Enjoy
89-
90-
## 🤝 Contributing & Support
92+
## License
9193

92-
- Submit issues for bugs or suggestions
93-
- Pull requests are welcome
94-
- Follow coding standards in CONTRIBUTING.md
94+
MIT License
9595

96-
## 📄 License
96+
## Acknowledgments
9797

98-
This project is licensed under the [MIT License](LICENSE).
98+
- Model Context Protocol framework
99+
- Claude Desktop team

0 commit comments

Comments
 (0)