swapped docs symlink

2026-08-07 21:07:23 -05:00
parent 5005cd7001
commit f240486a7e
92 changed files with 69 additions and 42 deletions
@@ -0,0 +1,48 @@
+---
+icon: lucide/rocket
+---
+
+# Personal MCP
+
+This project is a document library of software patterns, best practices, and structured references to external documentation. The same markdown files are published through two equivalent surfaces, so human-readable docs and MCP resources stay aligned.
+
+## MCP Server
+
+An [MCP server](https://modelcontextprotocol.io/docs/getting-started/intro) at `/mcp` provides context for AI systems. The markdown files are exposed as [resources](https://modelcontextprotocol.io/docs/learn/server-concepts#resources) and are structured to be easily consumed by [MCP clients](https://modelcontextprotocol.io/docs/learn/client-concepts), such as VS Code.
+
+## Docs
+
+A website at `/docs` for humans to read and review.
+
+## Quick start
+
+Install dependencies first:
+
+```bash
+uv sync
+```
+
+Run the app locally with the static docs rebuilt first, using [Uvicorn factory mode](https://www.uvicorn.org/settings/#application):
+
+```bash
+uv run zensical build && uv run uvicorn personal_mcp.main:create_app --factory --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)
+- [Contracts](./contracts/index.md)
+- [Content Contract](./contracts/index.md#content-contract)
+- [Frontmatter Contract](./contracts/frontmatter.md)
+- [URI Contract](./contracts/uris.md)
+- [Static Docs Hosting Pattern](./mcp_layout.md)
+- [Skill Usage Mechanics](./usage.md)
+- [Copilot MCP Mechanics](./copilot.md)