John Lancaster
35 lines
753 B
Markdown
35 lines
753 B
Markdown
---
|
|
icon: lucide/rocket
|
|
---
|
|
|
|
# Get started
|
|
|
|
## Quick start
|
|
|
|
Install dependencies first:
|
|
|
|
```bash
|
|
uv sync
|
|
```
|
|
|
|
Run the app locally with the static docs rebuilt first:
|
|
|
|
```bash
|
|
uv run zensical build && uv run uvicorn personal_mcp.main:app --host 127.0.0.1 --port 8765
|
|
```
|
|
|
|
Build and run the Docker image with the same exposed port:
|
|
|
|
```bash
|
|
docker build -t personal-mcp . && docker run --rm -p 8765:8765 personal-mcp
|
|
```
|
|
|
|
When the server is running, the health check is available at `/healthz` and the generated docs are available at `/docs/`.
|
|
|
|
## Architecture
|
|
|
|
- [Resource-First Pattern Module Architecture](./architecture.md)
|
|
- [Static Docs Hosting Pattern](./mcp_layout.md)
|
|
- [Skill Usage Mechanics](./usage.md)
|
|
- [Copilot MCP Mechanics](./copilot.md)
|