Skip to content

Commit f2add50

Browse files
CopilotBlackDadd77
andcommitted
Add QUICKSTART.md for rapid onboarding
Co-authored-by: BlackDadd77 <179016248+BlackDadd77@users.noreply.github.com>
1 parent 3b4f3f7 commit f2add50

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

QUICKSTART.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# MCP Python SDK - Quick Start
2+
3+
**Status**: ✅ **READY FOR DEVELOPMENT**
4+
5+
## Setup (2 minutes)
6+
7+
```bash
8+
# 1. Install uv
9+
pip install uv
10+
11+
# 2. Sync dependencies
12+
uv sync
13+
14+
# 3. Verify setup
15+
uv run --frozen ruff check .
16+
PYTEST_DISABLE_PLUGIN_AUTOLOAD="" uv run --frozen pytest -x
17+
```
18+
19+
## Daily Development
20+
21+
```bash
22+
# Format code
23+
uv run --frozen ruff format .
24+
25+
# Run tests
26+
PYTEST_DISABLE_PLUGIN_AUTOLOAD="" uv run --frozen pytest
27+
28+
# Type check
29+
uv run --frozen pyright
30+
31+
# Build
32+
uv build
33+
```
34+
35+
## Project Resources
36+
37+
- **📖 Full Setup Guide**: `SETUP.md`
38+
- **📊 Status Report**: `PROJECT_STATUS.md`
39+
- **👥 Contributing**: `CONTRIBUTING.md`
40+
- **💻 Development Rules**: `CLAUDE.md`
41+
- **📚 Main Docs**: `README.md`
42+
43+
## Test Results
44+
45+
✅ 678 tests passing
46+
✅ All linting checks pass
47+
✅ Type checking passes
48+
✅ Build successful
49+
50+
## Ready to Go!
51+
52+
The project is fully configured. See `SETUP.md` for detailed instructions.

0 commit comments

Comments
 (0)