Skip to content

Commit fbcbd14

Browse files
author
LittleCoinCoin
committed
docs(README): Updating
1 parent 1676af0 commit fbcbd14

File tree

1 file changed

+75
-34
lines changed

1 file changed

+75
-34
lines changed

README.md

Lines changed: 75 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,23 @@
22

33
![Hatch Logo](./docs/resources/images/Logo/hatch_wide_dark_bg_transparent.png)
44

5-
Hatch is the package manager for the Cracking Shells ecosystem. The documentation in `docs/index.md` is the canonical, up-to-date entry point for users and contributors — this README is a short pointer to those resources.
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.
66

7-
## Quick links
7+
The canonical documentation is at `docs/index.md` and published at <https://hatch.readthedocs.io/en/latest/>.
88

9-
The major documentation entry points are:
9+
## Quick start
1010

11-
- Documentation (canonical): `docs/index.md`
12-
- Getting started (users): `docs/articles/users/GettingStarted.md`
13-
- CLI reference: `docs/articles/users/CLIReference.md`
14-
- Developer docs and architecture: `docs/articles/devs/index.md`
11+
### Install from PyPI
1512

16-
But, really, just look at the site: <https://crackingshells.github.io/Hatch/>
13+
```bash
14+
pip install hatch-xclam
15+
```
1716

18-
## Quick start
17+
Verify installation:
18+
19+
```bash
20+
hatch --version
21+
```
1922

2023
### Install from source
2124

@@ -25,52 +28,90 @@ cd Hatch
2528
pip install -e .
2629
```
2730

28-
Verify installation:
31+
### Create your first environment and *Hatch!* MCP server package
2932

3033
```bash
31-
hatch --version
34+
# Create an isolated environment
35+
hatch env create my_project
36+
37+
# Switch to it
38+
hatch env use my_project
39+
40+
# Create a package template
41+
hatch create my_mcp_server --description "My MCP server"
42+
43+
# Validate the package
44+
hatch validate ./my_mcp_server
3245
```
3346

34-
### Create a package template
47+
### Deploy MCP servers to your tools
48+
49+
Add a Hatch package and automatically configure it on Claude Desktop and Cursor:
3550

3651
```bash
37-
hatch create my_package --description "My MCP server package"
52+
hatch package add ./my_mcp_server --host claude-desktop,cursor
3853
```
3954

55+
Configure an arbitrary MCP server (non-Hatch package) on Claude Desktop:
56+
57+
```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"
67+
```
68+
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+
84+
## Documentation
85+
86+
- **[Full Documentation](https://hatch.readthedocs.io/en/latest/)** — Complete reference and guides
87+
- **[Getting Started](./docs/articles/users/GettingStarted.md)** — Quick start for users
88+
- **[CLI Reference](./docs/articles/users/CLIReference.md)** — All commands and options
89+
- **[Tutorials](./docs/articles/users/tutorials/)** — Step-by-step guides from installation to package authoring
90+
- **[MCP Host Configuration](./docs/articles/users/MCPHostConfiguration.md)** — Deploy to multiple platforms
91+
- **[Developer Docs](./docs/articles/devs/)** — Architecture, implementation guides, and contribution guidelines
92+
- **[Troubleshooting](./docs/articles/users/Troubleshooting/ReportIssues.md)** — Common issues and solutions
93+
4094
## Contributing
4195

42-
We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
96+
We welcome contributions! See the [How to Contribute](./docs/articles/devs/contribution_guides/how_to_contribute.md) guide for details.
4397

44-
### Quick Start
98+
### Quick start for developers
4599

46100
1. **Fork and clone** the repository
47101
2. **Install dependencies**: `pip install -e .` and `npm install`
48102
3. **Create a feature branch**: `git checkout -b feat/your-feature`
49103
4. **Make changes** and add tests
50104
5. **Use conventional commits**: `npm run commit` for guided commits
51-
6. **Run tests**: `python -c "import hatch; print('Hatch package imports successfully')"`
105+
6. **Run tests**: `python -m pytest tests/`
52106
7. **Create a pull request**
53107

54-
### Commit Messages
55-
56-
We use [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning:
57-
58-
```bash
59-
feat: add new feature
60-
fix: resolve bug
61-
docs: update documentation
62-
test: add tests
63-
chore: maintenance tasks
64-
```
65-
66-
Use `npm run commit` for guided commit messages.
67-
68-
For detailed guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).
108+
We use [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning. Use `npm run commit` for guided commit messages.
69109

70-
## Getting Help
110+
## Getting help
71111

72-
- Read developer onboarding and contribution guides in `docs/articles/devs/`
73-
- Report issues or feature requests on the GitHub repository: <https://github.com/CrackingShells/Hatch/issues>
112+
- Search existing [GitHub Issues](https://github.com/CrackingShells/Hatch/issues)
113+
- Read [Troubleshooting](./docs/articles/users/Troubleshooting/ReportIssues.md) for common problems
114+
- Check [Developer Onboarding](./docs/articles/devs/development_processes/developer_onboarding.md) for setup help
74115

75116
## License
76117

0 commit comments

Comments
 (0)