Skip to content

Commit 31ce6f9

Browse files
author
LittleCoinCoin
committed
docs(README): rewrite
- Add detailed introduction explaining Hatch's core value proposition - Expand supported MCP hosts section with all platform targets - Enhance quick start with practical examples for environment and package creation - Add package-first deployment workflow with recommended best practices - Include direct configuration examples for advanced use cases - Reorganize documentation links for better discoverability - Add contributing quick start for developers - Improve getting help section with troubleshooting references
1 parent 09b7bcb commit 31ce6f9

File tree

1 file changed

+37
-31
lines changed

1 file changed

+37
-31
lines changed

README.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,33 @@
11
# Hatch
22

3-
![Hatch Logo](./docs/resources/images/Logo/hatch_wide_dark_bg_transparent.png)
3+
![Hatch Logo](https://raw.githubusercontent.com/CrackingShells/Hatch/refs/heads/main/docs/resources/images/Logo/hatch_wide_dark_bg_transparent.png)
44

5-
Hatch is the package manager for the Cracking Shells ecosystem, designed specifically for managing Model Context Protocol (MCP) servers. It handles complex dependency resolution across system packages, Python packages, Docker containers, and other Hatch packages — all in isolated environments.
5+
## Introduction
6+
7+
Hatch is the package manager for managing Model Context Protocol (MCP) servers with environment isolation, multi-type dependency resolution, and multi-host deployment. Deploy MCP servers to Claude Desktop, VS Code, Cursor, and other platforms with automatic dependency management.
68

79
The canonical documentation is at `docs/index.md` and published at <https://hatch.readthedocs.io/en/latest/>.
810

9-
## Quick start
11+
## Key Features
12+
13+
- **Environment Isolation** — Create separate, isolated workspaces for different projects without conflicts
14+
- **Multi-Type Dependency Resolution** — Automatically resolve and install system packages, Python packages, Docker containers, and Hatch packages
15+
- **Multi-Host Deployment** — Deploy MCP servers to Claude Desktop, Claude Code, VS Code, Cursor, LM Studio, and Google Gemini CLI
16+
- **Package Validation** — Ensure packages meet schema requirements before distribution
17+
- **Development-Focused** — Optimized for rapid development and testing of MCP server ecosystems
18+
19+
## Supported MCP Hosts
20+
21+
Hatch supports deployment to the following MCP host platforms:
22+
23+
- **Claude Desktop** — Anthropic's desktop application for Claude with native MCP support
24+
- **Claude Code** — Claude integration for VS Code with MCP capabilities
25+
- **VS Code** — Visual Studio Code with the MCP extension for tool integration
26+
- **Cursor** — AI-first code editor with built-in MCP server support
27+
- **LM Studio** — Local LLM inference platform with MCP server integration
28+
- **Google Gemini CLI** — Command-line interface for Google's Gemini model with MCP support
29+
30+
## Quick Start
1031

1132
### Install from PyPI
1233

@@ -46,41 +67,26 @@ hatch validate ./my_mcp_server
4667

4768
### Deploy MCP servers to your tools
4869

49-
Add a Hatch package and automatically configure it on Claude Desktop and Cursor:
70+
**Package-First Deployment (Recommended)**Add a Hatch package and automatically configure it on Claude Desktop and Cursor:
5071

5172
```bash
5273
hatch package add ./my_mcp_server --host claude-desktop,cursor
5374
```
5475

55-
Configure an arbitrary MCP server (non-Hatch package) on Claude Desktop:
76+
**Direct Configuration (Advanced)** — Configure arbitrary MCP servers on your hosts:
5677

5778
```bash
58-
# Local server with command and arguments
59-
hatch mcp configure my-weather-server --host claude-desktop \
60-
--command python --args weather_server.py \
61-
--env-var API_KEY=your_key
62-
63-
# Remote server with URL
64-
hatch mcp configure api-server --host gemini \
65-
--httpUrl https://api.example.com \
66-
--header Authorization="Bearer token"
79+
# Remote server example: GitHub MCP Server with authentication
80+
export GIT_PAT_TOKEN=your_github_personal_access_token
81+
hatch mcp configure github-mcp --host gemini \
82+
--httpUrl https://api.github.com/mcp \
83+
--header Authorization="Bearer $GIT_PAT_TOKEN"
84+
85+
# Local server example: Context7 via npx
86+
hatch mcp configure context7 --host vscode \
87+
--command npx --args "-y @upstash/context7-mcp"
6788
```
6889

69-
List configured servers and hosts:
70-
71-
```bash
72-
hatch mcp list servers
73-
hatch mcp list hosts --detailed
74-
```
75-
76-
## Key features
77-
78-
- **Environment isolation**: Create separate workspaces for different projects
79-
- **Multi-type dependencies**: Automatically resolve and install system packages, Python packages, Docker containers, and Hatch packages
80-
- **MCP host configuration**: Deploy MCP servers to Claude Desktop, Cursor, VSCode, and other platforms
81-
- **Package validation**: Ensure packages meet schema requirements before distribution
82-
- **Development-focused**: Optimized for rapid development and testing of MCP server ecosystems
83-
8490
## Documentation
8591

8692
- **[Full Documentation](https://hatch.readthedocs.io/en/latest/)** — Complete reference and guides
@@ -102,12 +108,12 @@ We welcome contributions! See the [How to Contribute](./docs/articles/devs/contr
102108
3. **Create a feature branch**: `git checkout -b feat/your-feature`
103109
4. **Make changes** and add tests
104110
5. **Use conventional commits**: `npm run commit` for guided commits
105-
6. **Run tests**: `python -m pytest tests/`
111+
6. **Run tests**: `wobble`
106112
7. **Create a pull request**
107113

108114
We use [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning. Use `npm run commit` for guided commit messages.
109115

110-
## Getting help
116+
## Getting Help
111117

112118
- Search existing [GitHub Issues](https://github.com/CrackingShells/Hatch/issues)
113119
- Read [Troubleshooting](./docs/articles/users/Troubleshooting/ReportIssues.md) for common problems

0 commit comments

Comments
 (0)