Compare commits
44
Commits
c6817a074e
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d13ecd6718 | ||
|
|
5cefca852d | ||
|
|
78a489c690 | ||
|
|
9312784c2f | ||
|
|
09d2a4bcaf | ||
|
|
86c7d54244 | ||
|
|
f75b24705e | ||
|
|
b87b1df642 | ||
|
|
bf11b7865d | ||
|
|
be579c347e | ||
|
|
9eb4ccbc6e | ||
|
|
bbaa84720c | ||
|
|
b2ac4102f7 | ||
|
|
fd5ce6f63b | ||
|
|
783ecf421e | ||
|
|
f6752313be | ||
|
|
12f916455b | ||
|
|
65669a2100 | ||
|
|
3e2fc0ef25 | ||
|
|
88474a75f5 | ||
|
|
afedcda930 | ||
|
|
f5b65ecf0a | ||
|
|
c31a78206f | ||
|
|
de95477480 | ||
|
|
73eb490537 | ||
|
|
c866d1bdb0 | ||
|
|
512db5f526 | ||
|
|
0638fe2fd7 | ||
|
|
8a994ff47b | ||
|
|
f3bbbfc25f | ||
|
|
e999437b93 | ||
|
|
f1dd6ab940 | ||
|
|
3d21e9136c | ||
|
|
6ec12a100a | ||
|
|
9be7c27410 | ||
|
|
a157489634 | ||
|
|
b5d6e60d45 | ||
|
|
f240486a7e | ||
|
|
5005cd7001 | ||
|
|
88ff4c2c71 | ||
|
|
5b6d5aaec4 | ||
|
|
2a2700b78c | ||
|
|
7162645ff8 | ||
|
|
44edffb8b7 |
@@ -0,0 +1,52 @@
|
||||
# personal-mcp MCP Usage
|
||||
|
||||
This repository is resource-first.
|
||||
|
||||
- Canonical skill guidance lives in `src/personal_mcp/docs/skills/<skill-id>/SKILL.md`.
|
||||
- Skills are exposed through FastMCP's native `skill://` resource family.
|
||||
- Prompts are exposed through native MCP prompt operations (`prompts/list`, `prompts/get`).
|
||||
- General documentation pages are exposed through `resource://docs/{path*}`.
|
||||
- The server intentionally does not provide compatibility tool projections for resources or prompts.
|
||||
|
||||
When a task appears to match a documented implementation pattern in `personal-mcp`, use this sequence:
|
||||
|
||||
1. Prefer an already attached native skill resource.
|
||||
2. Otherwise browse native MCP resources and compare available `skill://<name>/SKILL.md` descriptions.
|
||||
3. Read the best matching main skill file, or at most 2 candidate main files.
|
||||
4. Read `skill://<name>/_manifest` only when supporting material may be useful.
|
||||
5. Fetch only the relevant supporting paths from that manifest.
|
||||
6. Reconcile skill guidance with the actual repository code before proposing or making changes.
|
||||
|
||||
Preferred MCP resource order:
|
||||
|
||||
1. `skill://<name>/SKILL.md`
|
||||
2. `skill://<name>/_manifest` when needed
|
||||
3. `skill://<name>/<supporting-path>` for selected supporting files
|
||||
|
||||
Selection rules:
|
||||
|
||||
- Prefer the closest `name` and `description` match.
|
||||
- Keep context bounded; do not load many skill documents speculatively.
|
||||
- If confidence is low after reading at most two main files, ask one clarifying question before loading more context.
|
||||
|
||||
Repository-specific guidance:
|
||||
|
||||
- For tasks about adding or modifying a skill, use `skill://copilot-customization/SKILL.md` when relevant.
|
||||
- Keep skills provider-native; do not add tool projections for resource or prompt access.
|
||||
|
||||
|
||||
## Python Checks
|
||||
|
||||
After changes run these commands to confirm functionality. Resolve any errors
|
||||
|
||||
```python
|
||||
uv run ruff check .
|
||||
```
|
||||
|
||||
```python
|
||||
uv run ty check
|
||||
```
|
||||
|
||||
```python
|
||||
uv run pytest
|
||||
```
|
||||
@@ -1,17 +1,19 @@
|
||||
---
|
||||
name: Authoring Content
|
||||
description: "Use when editing Markdown under docs/. Routes authors to the canonical docs ownership, layout, and symlink guidance."
|
||||
applyTo: 'docs/**/*.md'
|
||||
description: "Use when editing Markdown under src/personal_mcp/docs/. Routes authors to the canonical docs ownership and layout guidance."
|
||||
applyTo: 'src/personal_mcp/docs/**/*.md'
|
||||
---
|
||||
|
||||
For edits under `docs/`, use the [Authoring Guide](../../docs/authoring.md) as the entry point for content placement and contracts.
|
||||
For edits under `src/personal_mcp/docs/`, use the [Authoring Guide](../../src/personal_mcp/docs/authoring.md) as the entry point for content placement and contracts.
|
||||
|
||||
For source-tree ownership, symlink, packaging, or runtime questions, follow [Source Tree Ownership](../../docs/authoring.md). Treat that section as authoritative instead of restating its guidance here.
|
||||
For source-tree ownership, packaging, or runtime questions, follow [Source Tree Ownership](../../src/personal_mcp/docs/authoring.md). Treat that section as authoritative instead of restating its guidance here.
|
||||
|
||||
|
||||
Primary references:
|
||||
- [Skill contract](../../docs/contracts/skill_contract.md)
|
||||
- [Prompt contract](../../docs/contracts/prompt.md)
|
||||
- [Frontmatter contract](../../docs/contracts/frontmatter.md)
|
||||
- [URI contract](../../docs/contracts/uris.md)
|
||||
- [Zensical documentation authoring skill](../../docs/skills/zensical-docs/SKILL.md)
|
||||
- [Skill contract](../../src/personal_mcp/docs/contracts/skill_contract.md)
|
||||
- [Prompt contract](../../src/personal_mcp/docs/contracts/prompt.md)
|
||||
- [Frontmatter contract](../../src/personal_mcp/docs/contracts/frontmatter.md)
|
||||
- [URI contract](../../src/personal_mcp/docs/contracts/uris.md)
|
||||
- `skill://zensical-docs/SKILL.md`
|
||||
|
||||
Inspect `skill://zensical-docs/_manifest` only when a supporting documentation reference is needed.
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: FastMCP Python Guidance
|
||||
description: Route FastMCP Python changes to the Personal MCP source-reference skill.
|
||||
applyTo: '**/*.py'
|
||||
---
|
||||
|
||||
A core part of this repository is [FastMCP](https://gofastmcp.com/servers/server).
|
||||
|
||||
For FastMCP implementation or protocol questions, load `skill://mcp-details/SKILL.md` first.
|
||||
|
||||
Inspect `skill://mcp-details/_manifest` only when a source reference is needed, then read the relevant supporting path. For FastMCP Python APIs, prefer the supporting reference that covers SDKs and FastMCP.
|
||||
|
||||
This repository exposes skills through native MCP resources and prompts through native MCP prompt operations.
|
||||
|
||||
Reconcile the skill guidance with the installed FastMCP version and the repository's existing implementation before editing.
|
||||
@@ -1,18 +1,24 @@
|
||||
---
|
||||
name: Pytest Scaffolding Guidance
|
||||
description: Route tests edits to the Personal MCP pytesting resource.
|
||||
description: Use when working under tests/. Route test edits to pytesting guidance and never create or expand tests unless the user explicitly asks.
|
||||
applyTo: 'tests/**'
|
||||
---
|
||||
|
||||
When editing files under `tests/`, use `resource://skills/pytesting/document` as the primary guidance source for test scaffolding and pytest authoring decisions.
|
||||
When editing files under `tests/`, use `skill://pytesting/SKILL.md` as the primary guidance source for test scaffolding and pytest authoring decisions.
|
||||
|
||||
Hard rule:
|
||||
|
||||
- Do not create new test files, test cases, or test scaffolding unless the user explicitly asks for tests in the current request.
|
||||
- If tests could help but were not requested, mention them as an optional next step instead of adding them.
|
||||
|
||||
Execution pattern:
|
||||
|
||||
1. Load `resource://skills/pytesting/document` first.
|
||||
2. Apply only the portions relevant to the file being edited.
|
||||
3. Keep tests focused, deterministic, and aligned with repository conventions.
|
||||
4. Include source-document links for any feature-level recommendation.
|
||||
1. Load `skill://pytesting/SKILL.md` first.
|
||||
2. Inspect `skill://pytesting/_manifest` only when a supporting reference is needed.
|
||||
3. Apply only the portions relevant to the file being edited.
|
||||
4. Keep tests focused, deterministic, and aligned with repository conventions.
|
||||
5. Include source-document links for any feature-level recommendation.
|
||||
|
||||
If task intent is ambiguous, ask one clarifying question before editing.
|
||||
|
||||
Be sure to also refer to the [testing page](../../docs/testing.md) page for design detail
|
||||
Be sure to also refer to the [testing page](../../src/personal_mcp/docs/testing.md) for design detail.
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Skill Authoring
|
||||
description: "Use when creating or editing skills under src/personal_mcp/docs/skills/. Enforces the Agent Skills specification and FastMCP skill provider compatibility."
|
||||
applyTo: 'src/personal_mcp/docs/skills/**'
|
||||
---
|
||||
|
||||
# Skill Authoring
|
||||
|
||||
Before editing files under `src/personal_mcp/docs/skills/`, consult all of these references:
|
||||
|
||||
- [Agent Skills quickstart](https://agentskills.io/skill-creation/quickstart)
|
||||
- [Agent Skills best practices](https://agentskills.io/skill-creation/best-practices)
|
||||
- [FastMCP skill providers](https://gofastmcp.com/servers/providers/skills)
|
||||
|
||||
Treat each immediate subdirectory of `src/personal_mcp/docs/skills/` as an independent Agent Skill. Keep its structure and content compliant with the Agent Skills pattern and compatible with the FastMCP skill provider.
|
||||
|
||||
Reconcile the external guidance with the repository's existing skill conventions and contracts before making changes.
|
||||
@@ -4,12 +4,12 @@ description: Route .vscode edits to the Personal MCP VS Code configuration skill
|
||||
applyTo: '.vscode/**'
|
||||
---
|
||||
|
||||
When editing files under `.vscode/`, use `resource://skills/vscode-configuration/document` as the primary guidance source.
|
||||
When editing files under `.vscode/`, use `skill://vscode-configuration/SKILL.md` as the primary guidance source.
|
||||
|
||||
Execution pattern:
|
||||
|
||||
1. Load `resource://skills/vscode-configuration/document` first.
|
||||
2. Select only the matching reference page for the current file type:
|
||||
1. Load `skill://vscode-configuration/SKILL.md` first.
|
||||
2. Inspect `skill://vscode-configuration/_manifest` and select only the matching reference page for the current file type:
|
||||
- `launch.json` -> debug launch configurations.
|
||||
- `tasks.json` -> tasks.json project tasks.
|
||||
- `mcp.json` -> mcp.json MCP server configuration.
|
||||
|
||||
@@ -4,7 +4,7 @@ description: Use the Zensical docs MCP resource when editing Markdown documentat
|
||||
applyTo: '**/*.md'
|
||||
---
|
||||
|
||||
When editing Markdown files in this repository, use the Zensical docs resource `resource://skills/zensical-docs/document` for relevant documentation authoring guidance.
|
||||
When editing Markdown files in this repository, use `skill://zensical-docs/SKILL.md` for relevant documentation authoring guidance. Inspect `skill://zensical-docs/_manifest` only when a supporting reference is needed.
|
||||
|
||||
Prefer Zensical-native documentation conventions when they cover the need cleanly, while preserving expected MkDocs compatibility unless the Zensical guidance intentionally diverges.
|
||||
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
## Plan: Docs-First FastMCP End State
|
||||
|
||||
Create a docs-first FastMCP architecture where all Markdown remains in docs/ as the only source of truth, each skill is Anthropic-compatible in its own directory, skill metadata lives in SKILL.md frontmatter, and packaged docs are served through importlib.resources so stdio deployments work from installed wheels.
|
||||
|
||||
**Steps**
|
||||
1. Phase 1: Define the end-state content contract. Confirm canonical structure as docs/skills/<skill-id>/SKILL.md plus docs/skills/<skill-id>/references/..., with strict per-skill ownership and no metadata.yaml sidecar. Also define stable skill-id rules (kebab-case, immutable after release). Deliverable: update the current docs/ directory with the finalized end-state content contract from this step.
|
||||
2. Phase 1: Define SKILL.md frontmatter schema with Pydantic-compatible fields: id, version, name, description, tags, capabilities, depends_on, and references manifest entries. The references manifest must map logical reference ids to relative paths so each skill can reorganize references internally without changing global server code. Depends on step 1. Deliverable: update the current docs/ directory with the finalized SKILL.md frontmatter schema from this step.
|
||||
3. Phase 1: Define URI contract with explicit break-and-replace policy. Recommend resource://catalog/skills_index, resource://catalog/skills/{skill_id}, resource://skills/{skill_id}/document, resource://skills/{skill_id}/references/{ref_id}, and resource://docs/{path*}. Evolving URIs and reference ids requires direct replacement, with no aliases or compatibility shims. Depends on steps 1-2. Deliverable: update the current docs/ directory with the finalized URI contract and break-and-replace policy from this step.
|
||||
4. Phase 2: Build a docs registry loader that reads packaged docs via importlib.resources.files(...) Traversable APIs, parses SKILL.md frontmatter, validates schema, and creates an in-memory registry keyed by skill_id. Fail fast for duplicate ids, missing files, broken reference mappings, or invalid depends_on. Depends on steps 2-3.
|
||||
5. Phase 2: Register FastMCP resources from the registry using RFC6570 templates (including wildcard paths where appropriate), read-only/idempotent annotations, explicit mime types, and on_duplicate_resources="error" for startup safety. Depends on step 4.
|
||||
6. Phase 2: Add discovery surfaces as resources first, then tool fallback. Keep catalog discovery in resources, then add ResourcesAsTools for tool-only clients. Add thin discovery tools only for parity and optional BM25/regex tool search when catalog/tool volume grows enough to affect token efficiency. Define canonical fallback tool names (`list_resources`, `read_resource`, `search_patterns`, `get_pattern_by_id`, `get_skill_document_by_id`), research host-specific naming behavior for GitHub Copilot, Cursor, Claude Desktop, and generic MCP clients, and require client-side name mapping or intentionally documented aliases when providers expose namespaced wrappers. Depends on step 5.
|
||||
7. Phase 3: Implement packaging so docs/ is copied into package resource space at build time (wheel + sdist) while docs/ remains canonical in source control. Use importlib.resources at runtime only; avoid direct filesystem assumptions. Depends on steps 4-6.
|
||||
8. Phase 3: Remove materialization coupling between skill source modules and docs. The website build reads docs/ directly, while MCP reads packaged docs resources from the installed package. This preserves one authored source with two distribution surfaces. Depends on step 7.
|
||||
9. Phase 4: Add validation and CI gates: frontmatter schema checks, URI uniqueness checks, reference integrity checks, docs build check, package content check, and stdio smoke checks that read representative skill/document resources from an installed wheel. Depends on steps 5-8.
|
||||
10. Phase 4: Add long-term maintainability guardrails: architecture decision record for URI and schema contracts, skill authoring checklist, and release checklist for evolving references safely within one skill. Parallel with step 9 after core architecture is stable.
|
||||
|
||||
|
||||
|
||||
**Relevant files**
|
||||
- /home/john/Documents/prompts/docs/index.md — Keep top-level docs entry and explain docs-first architecture contract.
|
||||
- /home/john/Documents/prompts/docs/skills — Canonical location for all skill content, including SKILL.md and references.
|
||||
- /home/john/Documents/prompts/pyproject.toml — Build inclusion rules for packaged markdown resources in wheel/sdist.
|
||||
- /home/john/Documents/prompts/src/personal_mcp/main.py — App/server startup wiring for resource registry initialization.
|
||||
- /home/john/Documents/prompts/src/personal_mcp/mcp.py — FastMCP instance composition and transform registration.
|
||||
- /home/john/Documents/prompts/src/personal_mcp/catalog/server.py — Catalog resource and fallback discovery behavior.
|
||||
- /home/john/Documents/prompts/src/personal_mcp/skills/document_loader.py — Replace file-path assumptions with importlib.resources docs registry loading.
|
||||
- /home/john/Documents/prompts/src/personal_mcp/web/materialize_skill_docs.py — De-scope or retire materialization once docs-first runtime is authoritative.
|
||||
|
||||
**Verification**
|
||||
1. Run uv run zensical build to verify docs/ remains valid and site output is stable.
|
||||
2. Run uv run pytest -q with tests that validate frontmatter parsing, URI generation, reference mapping, and catalog responses.
|
||||
3. Run a packaging integrity check using importlib.resources.files(...) to confirm packaged docs resources exist and are readable from an installed wheel.
|
||||
4. Run a stdio MCP smoke test that lists resources and reads at least one skill document and one reference document.
|
||||
5. Run fallback-client smoke tests verifying list_resources/read_resource tools work and return expected metadata for both static and templated resources, and that GitHub Copilot, Cursor, Claude Desktop, and protocol-level SDK tests use canonical tool names or documented mapped aliases.
|
||||
|
||||
**Decisions**
|
||||
- Anthropic compatibility: strict skill directory pattern with SKILL.md and references subtree.
|
||||
- Metadata strategy: YAML frontmatter in SKILL.md (no separate metadata file).
|
||||
- Discovery strategy: resource-first catalog with tool fallback for tool-only MCP clients.
|
||||
- Included scope: ideal end-state architecture, contracts, validation, and packaging for stdio operation.
|
||||
- Excluded scope: migration mechanics from current implementation, backward-compat shim details, and docs visual redesign.
|
||||
|
||||
**Further Considerations**
|
||||
1. Prefer recursive references support under each skill plus frontmatter manifest ids, so skill teams can reorganize internal reference folders without URI churn.
|
||||
2. Define a hard rule that skill_id and directory name must match exactly to eliminate namespace/slug drift classes of bugs.
|
||||
3. Do not provide URI aliases; client updates must track canonical URI contract changes directly.
|
||||
@@ -1,169 +0,0 @@
|
||||
**Phase 3 Results: Packaging Contract and Surface Decoupling (Wheel/sdist Resources + Docs-Only Authoring)**
|
||||
|
||||
This section finalizes Phase 3 by defining how authored docs are packaged as runtime resources, how runtime loading avoids filesystem assumptions, and how website and MCP distribution surfaces are decoupled while sharing one authored source.
|
||||
|
||||
### Greenfield Framing (Normative)
|
||||
|
||||
This Phase 3 design assumes a full refactor with intentional break-and-replace behavior:
|
||||
|
||||
1. No compatibility shims, aliases, adapter layers, or dual-read runtime paths.
|
||||
2. No runtime dependency on repository checkout layout.
|
||||
3. Runtime docs access is package-resource-only.
|
||||
4. Canonical authoring remains in `docs/` in source control.
|
||||
|
||||
### Research Baseline (Packaging + Runtime)
|
||||
|
||||
Authoritative references used for this phase:
|
||||
|
||||
1. Python `importlib.resources` docs (`files`, `Traversable`, and zip-safe behavior)
|
||||
2. Python packaging guidance for wheel/sdist data inclusion
|
||||
3. Hatchling build target configuration guidance for including non-code files
|
||||
4. Existing repository constraints from Steps 4-5 (registry-first, deterministic startup, resource-first discovery)
|
||||
|
||||
Best-practice conclusions applied to this design:
|
||||
|
||||
1. Package docs as build artifacts so runtime reads work from installed wheels.
|
||||
2. Keep docs source-of-truth in one place (`docs/`) and project into package resource space at build time.
|
||||
3. Avoid `Path(__file__)`/repo-root probing in runtime paths.
|
||||
4. Enforce parity across wheel and sdist so local/dev/prod behavior does not drift.
|
||||
|
||||
### Phase 3 Responsibilities (Normative)
|
||||
|
||||
Phase 3 MUST:
|
||||
|
||||
1. Ensure authored markdown under `docs/` is included in wheel and sdist artifacts.
|
||||
2. Ensure runtime docs registry/document reads use `importlib.resources` only.
|
||||
3. Ensure MCP runtime behavior is independent of current working directory or checkout structure.
|
||||
4. Ensure website docs build continues to consume source `docs/` directly.
|
||||
5. Remove materialization/path-probing coupling from runtime loader code.
|
||||
6. Preserve deterministic packaged docs layout for registry/resource URI generation.
|
||||
|
||||
### Packaging Contract (Wheel + sdist)
|
||||
|
||||
Canonical packaging behavior:
|
||||
|
||||
1. Source-authored docs remain at repository root: `docs/`.
|
||||
2. Build projects docs into package resource space under `personal_mcp/docs/` inside artifacts.
|
||||
3. Runtime anchor for docs loading is `importlib.resources.files("personal_mcp").joinpath("docs")`.
|
||||
4. Build artifacts MUST include:
|
||||
- top-level docs pages used by discovery/overview
|
||||
- `docs/skills/<skill-id>/SKILL.md`
|
||||
- `docs/skills/<skill-id>/references/**`
|
||||
|
||||
Parity requirements:
|
||||
|
||||
1. Wheel and sdist contain equivalent docs content for runtime use.
|
||||
2. Missing docs resources in either artifact is a hard validation failure.
|
||||
|
||||
### Build-System Plan (pyproject + build)
|
||||
|
||||
Primary target file:
|
||||
|
||||
1. `pyproject.toml`
|
||||
|
||||
Configuration goals:
|
||||
|
||||
1. Add explicit build inclusion rules so docs resources are shipped in wheel artifacts.
|
||||
2. Add explicit sdist inclusion rules so docs are present for source builds.
|
||||
3. Keep inclusion deterministic and auditable (no implicit glob side effects beyond intended docs content).
|
||||
4. Ensure packaged destination path matches runtime anchor (`personal_mcp/docs`).
|
||||
|
||||
Implementation note:
|
||||
|
||||
1. Use Hatchling-native inclusion mapping (for example force-include or equivalent target-level include mapping) to project `docs/` into package resource space.
|
||||
2. Prefer one clear packaging path over multiple fallback packaging mechanisms.
|
||||
|
||||
### Runtime Loader Contract (No Filesystem Assumptions)
|
||||
|
||||
Primary target file:
|
||||
|
||||
1. `src/personal_mcp/skills/document_loader.py`
|
||||
|
||||
Required runtime behavior:
|
||||
|
||||
1. Remove repository-root discovery helpers and path-probing candidates.
|
||||
2. Remove metadata-based document path overrides that bypass canonical skill layout.
|
||||
3. Resolve SKILL and reference documents via package-resource-relative paths only.
|
||||
4. Keep reads UTF-8 and deterministic.
|
||||
5. Raise explicit errors for missing packaged resources; no fallback probing.
|
||||
|
||||
Prohibited runtime behavior:
|
||||
|
||||
1. No `Path(__file__).resolve().parents[...]` lookup for docs.
|
||||
2. No implicit fallback to source-tree `docs/` during runtime reads.
|
||||
3. No slug-guessing or namespace substitution for path recovery.
|
||||
|
||||
### Surface Decoupling Contract (Website vs MCP)
|
||||
|
||||
Website surface:
|
||||
|
||||
1. Website build pipeline consumes source `docs/` directly (`uv run zensical build`).
|
||||
2. Static output (`site/`) remains a build artifact served by web mounting logic.
|
||||
|
||||
MCP surface:
|
||||
|
||||
1. MCP runtime serves docs from packaged resources loaded by registry/resource handlers.
|
||||
2. MCP does not read `site/` and does not depend on website build artifacts.
|
||||
|
||||
Decoupling guarantees:
|
||||
|
||||
1. One authored source (`docs/`), two distribution surfaces (website + MCP runtime).
|
||||
2. Changes to website serving do not alter MCP resource loading semantics.
|
||||
3. Changes to MCP runtime loader do not require website materialization logic.
|
||||
|
||||
### Integration Plan for Existing Modules
|
||||
|
||||
Primary integration targets:
|
||||
|
||||
1. `pyproject.toml`: add wheel/sdist docs inclusion mapping.
|
||||
2. `src/personal_mcp/skills/document_loader.py`: replace filesystem probing with package-resource loading.
|
||||
3. `src/personal_mcp/main.py`: keep startup composition deterministic once registry/resource registration is in place.
|
||||
4. `src/personal_mcp/mcp.py`: maintain registry-driven resource composition as canonical runtime surface.
|
||||
5. `src/personal_mcp/web/docs_mount.py`: continue static-site mount behavior without coupling to MCP runtime docs loading.
|
||||
|
||||
Cleanup targets:
|
||||
|
||||
1. Remove obsolete references to materialization-only modules if no longer present/used.
|
||||
2. Remove dead code paths that attempt source-tree fallback loading.
|
||||
|
||||
### Validation and Test Plan (Phase 3 Scope)
|
||||
|
||||
Build/package validation:
|
||||
|
||||
1. Build wheel and sdist in CI/local.
|
||||
2. Inspect artifacts to confirm `personal_mcp/docs/**` exists and includes representative skill/reference files.
|
||||
3. Install built wheel in isolated environment and verify resource reads via `importlib.resources.files(...)`.
|
||||
|
||||
Runtime validation:
|
||||
|
||||
1. Run MCP in an environment where repo-root docs paths are unavailable and confirm reads still succeed.
|
||||
2. Verify representative URIs resolve (skill document and reference document).
|
||||
3. Confirm startup fails clearly if required packaged docs resources are missing.
|
||||
|
||||
Decoupling validation:
|
||||
|
||||
1. Run `uv run zensical build` to verify website pipeline still consumes source `docs/`.
|
||||
2. Confirm MCP runtime does not require `site/` presence.
|
||||
3. Confirm web static serving behavior is unchanged when docs are built.
|
||||
|
||||
Expected command path in this repo:
|
||||
|
||||
1. `uv run pytest -q`
|
||||
2. `uv run zensical build`
|
||||
|
||||
### Acceptance Criteria for Phase 3 Completion
|
||||
|
||||
Phase 3 is complete when all are true:
|
||||
|
||||
1. Wheel and sdist include docs resources in deterministic package paths.
|
||||
2. Runtime docs loading works from installed artifacts using `importlib.resources` only.
|
||||
3. Runtime docs loading has no checkout-path dependency and no fallback probing.
|
||||
4. Website docs build remains source-docs-driven and independent of MCP runtime loading.
|
||||
5. No compatibility shims, aliases, or dual runtime loader paths exist.
|
||||
|
||||
### Non-goals for Phase 3
|
||||
|
||||
1. No Step 6 discovery-tool fallback implementation details.
|
||||
2. No URI aliasing or backward-compat transition mechanics.
|
||||
3. No redesign of skill frontmatter/schema contracts already finalized in earlier steps.
|
||||
4. No web UI visual redesign or docs IA overhaul.
|
||||
@@ -1,84 +0,0 @@
|
||||
**Step 1 Results: End-State Content Contract**
|
||||
|
||||
This section finalizes Step 1 by defining the canonical authored content model.
|
||||
|
||||
### Step Deliverable
|
||||
|
||||
- Update the current `docs/` directory with the finalized Step 1 content contract from this document.
|
||||
|
||||
### Canonical source of truth
|
||||
|
||||
- All authored Markdown lives under `docs/`.
|
||||
- MCP resources and static docs are two distribution surfaces of the same authored files.
|
||||
- No parallel authored markdown is allowed in `src/` or other package-only paths.
|
||||
|
||||
### Canonical skill shape (Anthropic-compatible)
|
||||
|
||||
Each skill is one directory under `docs/skills/`:
|
||||
|
||||
```text
|
||||
docs/
|
||||
skills/
|
||||
<skill-id>/
|
||||
SKILL.md
|
||||
references/
|
||||
... (one or more markdown files, optional nested folders)
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- `SKILL.md` is required for every skill.
|
||||
- `references/` is the only place for skill-specific supporting docs.
|
||||
- Nested folders inside `references/` are allowed so a skill can reorganize internals without changing global architecture.
|
||||
- Skill directories are independent ownership boundaries; no cross-skill file writes.
|
||||
|
||||
### File placement and ownership boundaries
|
||||
|
||||
- Top-level project docs stay in `docs/*.md`.
|
||||
- Skill docs stay in `docs/skills/<skill-id>/...`.
|
||||
- A skill may link to other skills, but must not store content inside another skill's directory.
|
||||
- Server/runtime code may index and serve docs, but must not be the source of authored markdown.
|
||||
|
||||
### Metadata location constraint
|
||||
|
||||
- Skill metadata is embedded in YAML frontmatter in `SKILL.md`.
|
||||
- No `metadata.yaml` sidecar in the end state.
|
||||
- Reference lookup metadata (ids to relative paths) is declared from `SKILL.md` frontmatter, not inferred as a hidden global convention.
|
||||
|
||||
### Skill-id contract (change-friendly)
|
||||
|
||||
`skill-id` is the public identifier and SHOULD satisfy all rules below:
|
||||
|
||||
- Format: lowercase kebab-case only.
|
||||
- Character set: `a-z`, `0-9`, and `-`.
|
||||
- Must start with a letter.
|
||||
- No underscores, spaces, dots, or uppercase characters.
|
||||
- Directory name should equal `skill-id` in each committed revision.
|
||||
- Frontmatter `id` should equal directory name in each committed revision.
|
||||
- Treat `skill-id` as immutable after release; any rename is a breaking replacement and clients must move to the new id.
|
||||
|
||||
Example valid ids:
|
||||
|
||||
- `fastapi-uv-docker`
|
||||
- `zensical-docs`
|
||||
- `pytesting`
|
||||
|
||||
Example invalid ids:
|
||||
|
||||
- `fastapi_uv_docker` (underscore)
|
||||
- `Zensical-Docs` (uppercase)
|
||||
- `docs.zensical` (dot)
|
||||
|
||||
### Invariants this contract guarantees
|
||||
|
||||
- One authored source tree (`docs/`) for both website and MCP.
|
||||
- One skill directory maps to one skill identity per revision.
|
||||
- Namespace/slug drift is minimized by keeping directory and frontmatter ids aligned per revision.
|
||||
- Per-skill reference structure can evolve without changing cross-skill architecture.
|
||||
- Packaging for stdio is deterministic because authored content is path-stable.
|
||||
|
||||
### Non-goals for Step 1
|
||||
|
||||
- No URI versioning policy details yet (handled in Step 3).
|
||||
- No full frontmatter schema details yet (handled in Step 2).
|
||||
- No migration instructions from current architecture (out of scope for this plan).
|
||||
@@ -1,298 +0,0 @@
|
||||
**Step 2 Results: SKILL.md Frontmatter and FastMCP Metadata Contract**
|
||||
|
||||
This section finalizes Step 2 by defining the canonical SKILL.md frontmatter schema, separating Anthropic-supported fields from repository extension fields, and mapping frontmatter to FastMCP-native metadata surfaces for resources and tools.
|
||||
|
||||
### Step Deliverable
|
||||
|
||||
- Update the current `docs/` directory with the finalized Step 2 frontmatter and metadata contract content from this document.
|
||||
|
||||
### Anthropic Frontmatter Support (Research Baseline)
|
||||
|
||||
Across Anthropic API and Agent Skills specification surfaces:
|
||||
|
||||
- Required for custom skill bundles: `name`, `description`.
|
||||
- `name` constraints (Agent Skills API docs): 1-64 chars, lowercase letters/numbers/hyphens, no XML tags, and must not use reserved words `anthropic` or `claude`.
|
||||
- `description` constraints (Agent Skills API docs): 1-1024 chars, non-empty, no XML tags.
|
||||
|
||||
Portable optional fields from the Agent Skills specification:
|
||||
|
||||
- `license`
|
||||
- `compatibility`
|
||||
- `metadata`
|
||||
- `allowed-tools` (experimental)
|
||||
|
||||
Claude Code-specific optional fields (supported by Claude Code skills docs):
|
||||
|
||||
- `when_to_use`, `argument-hint`, `arguments`
|
||||
- `disable-model-invocation`, `user-invocable`
|
||||
- `allowed-tools`, `disallowed-tools`
|
||||
- `model`, `effort`, `context`, `agent`, `hooks`, `paths`, `shell`
|
||||
|
||||
Contract decision for this repository:
|
||||
|
||||
- Treat `name` and `description` as required in all SKILL.md files, even where a client could infer defaults.
|
||||
- Keep Anthropic-facing semantics in standard fields and keep MCP indexing metadata in a namespaced extension block.
|
||||
- Preserve forward compatibility by allowing additive optional metadata fields over time.
|
||||
|
||||
### Canonical Frontmatter Schema For This Repository
|
||||
|
||||
Use this exact two-layer pattern:
|
||||
|
||||
1. Anthropic layer (portable): top-level fields intended for Anthropic/Agent Skills behavior.
|
||||
2. Repository layer (runtime indexing): one namespaced block, `x-personal-mcp`, for MCP catalog and routing metadata.
|
||||
|
||||
Canonical shape:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: <skill-id>
|
||||
description: <what this skill does and when to use it>
|
||||
|
||||
# Optional Anthropic/Agent Skills fields (use only when needed)
|
||||
when_to_use: <extra trigger guidance>
|
||||
allowed-tools: <space-separated string or YAML list>
|
||||
disable-model-invocation: false
|
||||
user-invocable: true
|
||||
license: <optional>
|
||||
compatibility: <optional>
|
||||
|
||||
# Repository-specific metadata (authoritative for MCP indexing)
|
||||
x-personal-mcp:
|
||||
id: <skill-id>
|
||||
version: <semver>
|
||||
tags:
|
||||
- <tag>
|
||||
capabilities:
|
||||
- resource://skills/<skill-id>/document
|
||||
depends_on: []
|
||||
references:
|
||||
<ref-id>:
|
||||
path: references/<file>.md
|
||||
mime_type: text/markdown
|
||||
title: <short title>
|
||||
---
|
||||
```
|
||||
|
||||
### Repository Metadata Field Rules (`x-personal-mcp`)
|
||||
|
||||
- `id` required: must follow Step 1 skill-id rules and equal directory name.
|
||||
- `version` required: semantic version string.
|
||||
- `tags` optional: list of kebab-case discovery labels.
|
||||
- `capabilities` required: list of MCP URIs this skill publishes.
|
||||
- `depends_on` optional: list of other skill ids.
|
||||
- `references` optional map:
|
||||
- key is `ref-id` (kebab-case).
|
||||
- `path` is a skill-relative markdown path and must stay inside the same skill directory.
|
||||
- nested folders under `references/` are allowed.
|
||||
- `mime_type` defaults to `text/markdown` if omitted.
|
||||
- `title` is an optional display label.
|
||||
- renaming `ref-id` values is allowed when needed; optional aliases may be used during transitions.
|
||||
|
||||
### Pydantic Models For Frontmatter Validation
|
||||
|
||||
Define the Step 2 contract with Pydantic v2 models and change-friendly validation.
|
||||
|
||||
Normative model sketch:
|
||||
|
||||
```python
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from pathlib import PurePosixPath
|
||||
from typing import Any
|
||||
|
||||
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
|
||||
|
||||
SKILL_ID_RE = re.compile(r"^[a-z][a-z0-9-]*$")
|
||||
SEMVER_RE = re.compile(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:[-+][0-9A-Za-z.-]+)?$")
|
||||
|
||||
|
||||
class ReferenceEntry(BaseModel):
|
||||
model_config = ConfigDict(extra="ignore", str_strip_whitespace=True)
|
||||
|
||||
path: str
|
||||
mime_type: str = "text/markdown"
|
||||
title: str | None = None
|
||||
|
||||
@field_validator("path")
|
||||
@classmethod
|
||||
def validate_reference_path(cls, value: str) -> str:
|
||||
p = PurePosixPath(value)
|
||||
if p.is_absolute() or ".." in p.parts:
|
||||
raise ValueError("reference path must be a relative in-skill path")
|
||||
if not str(p).startswith("references/"):
|
||||
raise ValueError("reference path must stay under references/")
|
||||
if p.suffix.lower() != ".md":
|
||||
raise ValueError("reference path must target a markdown file")
|
||||
return str(p)
|
||||
|
||||
|
||||
class PersonalMcpMetadata(BaseModel):
|
||||
model_config = ConfigDict(extra="ignore", str_strip_whitespace=True)
|
||||
|
||||
id: str
|
||||
version: str
|
||||
tags: list[str] = Field(default_factory=list)
|
||||
capabilities: list[str] = Field(min_length=1)
|
||||
depends_on: list[str] = Field(default_factory=list)
|
||||
references: dict[str, ReferenceEntry] = Field(default_factory=dict)
|
||||
|
||||
@field_validator("id")
|
||||
@classmethod
|
||||
def validate_id(cls, value: str) -> str:
|
||||
if not SKILL_ID_RE.fullmatch(value):
|
||||
raise ValueError("id must be lowercase kebab-case and start with a letter")
|
||||
return value
|
||||
|
||||
@field_validator("version")
|
||||
@classmethod
|
||||
def validate_version(cls, value: str) -> str:
|
||||
if not SEMVER_RE.fullmatch(value):
|
||||
raise ValueError("version must be semver")
|
||||
return value
|
||||
|
||||
@field_validator("depends_on")
|
||||
@classmethod
|
||||
def validate_depends_on(cls, value: list[str]) -> list[str]:
|
||||
for dep in value:
|
||||
if not SKILL_ID_RE.fullmatch(dep):
|
||||
raise ValueError(f"invalid depends_on skill id: {dep}")
|
||||
return value
|
||||
|
||||
@field_validator("references")
|
||||
@classmethod
|
||||
def validate_reference_ids(cls, value: dict[str, ReferenceEntry]) -> dict[str, ReferenceEntry]:
|
||||
for ref_id in value:
|
||||
if not SKILL_ID_RE.fullmatch(ref_id):
|
||||
raise ValueError(f"invalid reference id: {ref_id}")
|
||||
return value
|
||||
|
||||
@model_validator(mode="after")
|
||||
def ensure_primary_capability(self) -> "PersonalMcpMetadata":
|
||||
expected = f"resource://skills/{self.id}/document"
|
||||
if expected not in self.capabilities:
|
||||
raise ValueError(f"capabilities must include {expected}")
|
||||
return self
|
||||
|
||||
|
||||
class SkillFrontmatter(BaseModel):
|
||||
model_config = ConfigDict(extra="ignore", str_strip_whitespace=True)
|
||||
|
||||
# Anthropic/Agent Skills fields
|
||||
name: str = Field(min_length=1, max_length=64)
|
||||
description: str = Field(min_length=1, max_length=1024)
|
||||
when_to_use: str | None = None
|
||||
allowed_tools: str | list[str] | None = Field(default=None, alias="allowed-tools")
|
||||
disallowed_tools: str | list[str] | None = Field(default=None, alias="disallowed-tools")
|
||||
disable_model_invocation: bool | None = Field(default=None, alias="disable-model-invocation")
|
||||
user_invocable: bool | None = Field(default=None, alias="user-invocable")
|
||||
argument_hint: str | None = Field(default=None, alias="argument-hint")
|
||||
arguments: str | list[str] | None = None
|
||||
license: str | None = None
|
||||
compatibility: str | None = None
|
||||
metadata: dict[str, str] | None = None
|
||||
|
||||
# Repository extension block
|
||||
x_personal_mcp: PersonalMcpMetadata = Field(alias="x-personal-mcp")
|
||||
|
||||
@field_validator("name")
|
||||
@classmethod
|
||||
def validate_name(cls, value: str) -> str:
|
||||
if not SKILL_ID_RE.fullmatch(value):
|
||||
raise ValueError("name must be lowercase kebab-case and start with a letter")
|
||||
if "anthropic" in value or "claude" in value:
|
||||
raise ValueError("name must not contain reserved words anthropic or claude")
|
||||
return value
|
||||
|
||||
@model_validator(mode="after")
|
||||
def cross_validate(self) -> "SkillFrontmatter":
|
||||
if self.x_personal_mcp.id != self.name:
|
||||
raise ValueError("x-personal-mcp.id must exactly match name")
|
||||
return self
|
||||
|
||||
|
||||
def validate_skill_frontmatter(raw: dict[str, Any], skill_dir_name: str) -> SkillFrontmatter:
|
||||
model = SkillFrontmatter.model_validate(raw)
|
||||
if model.name != skill_dir_name:
|
||||
raise ValueError("frontmatter name must exactly match skill directory name")
|
||||
return model
|
||||
```
|
||||
|
||||
Validation behavior contract:
|
||||
|
||||
- Validate required core fields and relationships during registry load before FastMCP resource/tool registration.
|
||||
- Allow unknown additive fields so frontmatter can evolve without blocking startup.
|
||||
- Treat hard contract violations (missing required fields, invalid ids, broken required mappings) as startup errors.
|
||||
- Treat non-critical compatibility issues as warnings when possible.
|
||||
- Error messages should include skill path and failing field for CI readability.
|
||||
|
||||
Projection mode contract (for Anthropic API upload pipelines):
|
||||
|
||||
- Parse with `SkillFrontmatter` first.
|
||||
- Emit Anthropic-safe frontmatter with standard fields only.
|
||||
- Serialize repository metadata into standard `metadata` as namespaced keys.
|
||||
- Preserve the canonical authored source in `x-personal-mcp`; projection output is a build artifact.
|
||||
|
||||
### Anthropic Upload Compatibility Rule
|
||||
|
||||
- Anthropic documentation guarantees behavior for standard frontmatter fields but does not explicitly guarantee handling of arbitrary unknown top-level keys.
|
||||
- Therefore, publishing pipelines that target strict API compatibility should support a projection mode that emits only standard frontmatter fields for upload.
|
||||
- In projection mode, repository extension metadata is serialized into the standard `metadata` field (for example as namespaced keys or JSON-encoded values), while source-of-truth authoring remains in `x-personal-mcp`.
|
||||
|
||||
### FastMCP Native Metadata Surfaces (Research Baseline)
|
||||
|
||||
Resources (`@mcp.resource` and templates) support native definition metadata:
|
||||
|
||||
- `name`, `description`, `mime_type`, `tags`
|
||||
- `annotations` (`readOnlyHint`, `idempotentHint`)
|
||||
- `icons`
|
||||
- `meta` (custom metadata passed through to the MCP client resource object)
|
||||
- `version`
|
||||
- `enabled` (deprecated in v3; prefer server-level `mcp.enable()` / `mcp.disable()`)
|
||||
|
||||
Resources support runtime metadata:
|
||||
|
||||
- `ResourceContent.meta` (item-level)
|
||||
- `ResourceResult.meta` (result-level `_meta`)
|
||||
|
||||
Tools (`@mcp.tool`) support native definition metadata:
|
||||
|
||||
- `name`, `description`, `tags`
|
||||
- `annotations` (`title`, `readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`)
|
||||
- `icons`
|
||||
- `meta` (custom metadata passed through to the MCP client tool object)
|
||||
- `version`
|
||||
- `timeout`, `output_schema`, `run_in_thread`
|
||||
- `enabled` (deprecated in v3; prefer server-level `mcp.enable()` / `mcp.disable()`)
|
||||
|
||||
Tools support runtime metadata:
|
||||
|
||||
- `ToolResult.meta` (execution-level metadata for each call)
|
||||
|
||||
### Frontmatter To FastMCP Mapping Contract
|
||||
|
||||
At server startup, map `x-personal-mcp` fields into FastMCP registration as follows:
|
||||
|
||||
- `x-personal-mcp.id` -> canonical URI namespace and identity checks.
|
||||
- `description` -> default `description` for the primary skill document resource.
|
||||
- `x-personal-mcp.tags` -> `tags` on resources/tools.
|
||||
- `x-personal-mcp.version` -> `version` on resources/tools.
|
||||
- `x-personal-mcp.capabilities` -> registered URI list plus catalog exposure.
|
||||
- `x-personal-mcp.references[*]` -> resource templates or concrete resources with:
|
||||
- `mime_type` from reference entry (or default)
|
||||
- `meta` including `skill_id`, `ref_id`, and source `path`
|
||||
- read-only annotations for documentation resources
|
||||
- `x-personal-mcp.depends_on` -> catalog dependency graph metadata and validation checks.
|
||||
|
||||
### Invariants This Contract Guarantees
|
||||
|
||||
- Anthropic-required frontmatter stays valid for custom skill upload and Claude Code loading.
|
||||
- MCP-specific metadata remains embedded in SKILL.md frontmatter, with no `metadata.yaml` sidecar.
|
||||
- FastMCP registration uses only native metadata fields for resources/tools.
|
||||
- Reference ids and metadata can evolve with low-friction updates while internal file layout under `references/` stays refactor-friendly.
|
||||
|
||||
### Non-goals For Step 2
|
||||
|
||||
- No URI versioning/deprecation rollout policy details (handled in Step 3).
|
||||
- No migration script design from existing `metadata.yaml` files.
|
||||
- No runtime caching/indexing performance tuning details.
|
||||
@@ -1,114 +0,0 @@
|
||||
**Step 3 Results: URI Contract and Compatibility Policy**
|
||||
|
||||
This section finalizes Step 3 by defining the canonical resource URI contract, template parameter rules, and explicit compatibility/versioning policy for URIs and reference ids.
|
||||
|
||||
### Step Deliverable
|
||||
|
||||
- Update the current `docs/` directory with the finalized Step 3 URI contract and compatibility policy content from this document.
|
||||
|
||||
### Canonical URI Surface (Normative)
|
||||
|
||||
The public, preferred URIs are:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills/{skill_id}`
|
||||
3. `resource://skills/{skill_id}/document`
|
||||
4. `resource://skills/{skill_id}/references/{ref_id}`
|
||||
5. `resource://docs/{path*}`
|
||||
|
||||
Contract intent:
|
||||
|
||||
- Catalog URIs are discovery surfaces.
|
||||
- Skill URIs are primary per-skill guidance surfaces.
|
||||
- Docs wildcard URI is a direct authored-markdown access surface under `docs/`.
|
||||
|
||||
### URI Semantics
|
||||
|
||||
`resource://catalog/skills_index`
|
||||
|
||||
- Returns a compact list of skill records for discovery.
|
||||
- One entry per `skill_id`.
|
||||
- Must include enough metadata for client-side selection (at minimum id, name, description, tags, capabilities).
|
||||
|
||||
`resource://catalog/skills/{skill_id}`
|
||||
|
||||
- Returns one normalized record for `skill_id`.
|
||||
- Must include canonical document URI and declared reference ids.
|
||||
- Returns not-found when `skill_id` does not exist.
|
||||
|
||||
`resource://skills/{skill_id}/document`
|
||||
|
||||
- Returns the canonical `SKILL.md` authored content for that skill.
|
||||
- `skill_id` must match Step 1 stable id rules.
|
||||
|
||||
`resource://skills/{skill_id}/references/{ref_id}`
|
||||
|
||||
- Returns one reference document declared in the skill frontmatter references manifest.
|
||||
- `ref_id` is the stable public handle for that reference document.
|
||||
|
||||
`resource://docs/{path*}`
|
||||
|
||||
- Returns authored markdown at a normalized relative path under `docs/`.
|
||||
- Supports nested paths via RFC6570 wildcard expansion.
|
||||
- Typical examples: `index.md`, `usage.md`, `skills/<skill-id>/SKILL.md`, `skills/<skill-id>/references/<file>.md`.
|
||||
|
||||
### Template Parameter and Validation Rules
|
||||
|
||||
`skill_id`
|
||||
|
||||
- Lowercase kebab-case.
|
||||
- Must satisfy Step 1 stable id rules.
|
||||
|
||||
`ref_id`
|
||||
|
||||
- Lowercase kebab-case.
|
||||
- Must be declared in the skill’s references manifest.
|
||||
|
||||
`path*`
|
||||
|
||||
- Relative POSIX path only.
|
||||
- No leading slash.
|
||||
- No `..` traversal segments.
|
||||
- Resolves only inside `docs/`.
|
||||
- This surface is markdown-only in end state (`.md` files).
|
||||
|
||||
### URI Versioning Policy
|
||||
|
||||
Default rule:
|
||||
|
||||
- Keep URIs unversioned by default.
|
||||
- Allow URI and payload updates when they improve clarity or implementation simplicity.
|
||||
|
||||
Breaking-change rule:
|
||||
|
||||
- Breaking changes use direct replacement of the canonical URI family.
|
||||
- No compatibility aliases or dual URI families are maintained in this greenfield phase.
|
||||
|
||||
FastMCP version metadata usage:
|
||||
|
||||
- Resource `version` metadata MAY be used for implementation/version discovery.
|
||||
- URI readability and maintainability remain the primary contract.
|
||||
|
||||
### Reference ID Compatibility Policy
|
||||
|
||||
`ref_id` is the public identifier for a reference document, separate from file path.
|
||||
|
||||
Rules:
|
||||
|
||||
- Prefer keeping `ref_id` stable when practical.
|
||||
- File paths may change without URI churn as long as the mapped `ref_id` resolves.
|
||||
- If a reference is renamed, introduce a new `ref_id` and treat the old one as retired.
|
||||
- Avoid reusing retired `ref_id` values for unrelated content.
|
||||
|
||||
### Invariants This Contract Guarantees
|
||||
|
||||
- One canonical URI pattern per core capability surface.
|
||||
- Fast, low-friction URI evolution through direct replacement of canonical URIs.
|
||||
- A single canonical catalog URI family with no alias maintenance overhead.
|
||||
- Reference mappings can evolve with minimal churn.
|
||||
|
||||
### Non-goals For Step 3
|
||||
|
||||
- No implementation-specific transform wiring details (`VersionFilter`, mounts, provider composition).
|
||||
- No migration script mechanics for auto-generating aliases.
|
||||
- No authorization policy design for URI-level access control.
|
||||
@@ -1,248 +0,0 @@
|
||||
**Step 4 Results: Docs Registry Loader Design (importlib.resources + Fail-Fast Validation)**
|
||||
|
||||
This section finalizes Step 4 by defining a production-ready docs registry loader that reads packaged docs through Python resource APIs, parses SKILL.md frontmatter, validates schema and cross-links, and builds an immutable in-memory registry keyed by skill_id.
|
||||
|
||||
### Greenfield Framing (Normative)
|
||||
|
||||
This Step 4 design is for the greenfield target state:
|
||||
|
||||
1. No legacy metadata sidecars (`metadata.yaml`) are part of the runtime contract.
|
||||
2. No dual-loader compatibility path is required.
|
||||
3. Registry loading from packaged resources is the only runtime source of truth.
|
||||
4. Compatibility shims are prohibited.
|
||||
|
||||
### Research Baseline (Python + Design Guidance)
|
||||
|
||||
Authoritative references used for this step:
|
||||
|
||||
1. Python `importlib.resources` docs (`files`, `as_file`, `Traversable` APIs)
|
||||
2. Python `importlib.resources.abc` docs (`Traversable`, path traversal semantics, joinpath compatibility notes)
|
||||
3. Pydantic v2 model/validation docs (`model_validate`, `ValidationError`, strictness and extra handling)
|
||||
4. Python packaging guidance for including package data in wheels/sdists
|
||||
|
||||
Best-practice conclusions applied to this design:
|
||||
|
||||
1. Prefer `importlib.resources.files(<package>).joinpath(...)` over filesystem assumptions so stdio deployments from installed wheels work.
|
||||
2. Treat resources as potentially non-filesystem artifacts (zip-import compatible); only use `as_file(...)` when an actual OS path is required.
|
||||
3. Validate metadata with explicit Pydantic models and fail startup on contract violations.
|
||||
4. Keep registry load deterministic (sorted traversal, stable error messages, no hidden fallback mutations).
|
||||
5. Resolve references via manifest ids declared in frontmatter, not by global file conventions.
|
||||
|
||||
### Loader Responsibilities (Normative)
|
||||
|
||||
The Step 4 loader MUST:
|
||||
|
||||
1. Read canonical docs from package resources (not repo-root paths).
|
||||
2. Discover all skill directories under `docs/skills/` in packaged resources.
|
||||
3. For each skill, read and parse `SKILL.md` frontmatter.
|
||||
4. Validate frontmatter using the Step 2 schema contract.
|
||||
5. Validate directory/id invariants from Step 1 (directory name equals frontmatter id).
|
||||
6. Validate URI/reference semantics from Step 3 assumptions.
|
||||
7. Build a single in-memory registry keyed by `skill_id`.
|
||||
8. Fail fast on any integrity error before FastMCP resource registration.
|
||||
9. Precompute compact discovery projections so index resources can be served without reading full markdown bodies at request time.
|
||||
|
||||
### Package Resource Contract
|
||||
|
||||
Runtime anchor:
|
||||
|
||||
1. The loader resolves content from an importable package anchor, for example `personal_mcp`.
|
||||
2. Docs root is located as `files(anchor).joinpath("docs")` when docs are packaged at package root, or an equivalent configured subpath.
|
||||
3. Skill root is `docs/skills`.
|
||||
|
||||
Resource assumptions:
|
||||
|
||||
1. `SKILL.md` is UTF-8 text.
|
||||
2. Reference files declared in frontmatter are UTF-8 markdown by default unless otherwise declared.
|
||||
3. Path resolution always remains inside the same skill directory.
|
||||
|
||||
### Registry Data Model
|
||||
|
||||
Build immutable runtime records with explicit structure:
|
||||
|
||||
1. `SkillRecord`
|
||||
- `skill_id`
|
||||
- `name`
|
||||
- `description`
|
||||
- `version`
|
||||
- `tags`
|
||||
- `capabilities`
|
||||
- `depends_on`
|
||||
- `document_uri`
|
||||
- `document_relpath` (canonical resource-relative path)
|
||||
- `references` map keyed by `ref_id`
|
||||
2. `ReferenceRecord`
|
||||
- `ref_id`
|
||||
- `uri`
|
||||
- `relpath`
|
||||
- `mime_type`
|
||||
- `title`
|
||||
3. `DocsRegistry`
|
||||
- `skills_by_id: dict[str, SkillRecord]`
|
||||
- `skills_in_load_order: list[str]` (deterministic ordering)
|
||||
- helper indexes for catalog payload generation
|
||||
- `skills_summary_in_load_order: list[SkillSummaryRecord]` for progressive discovery responses
|
||||
- filter indexes (for example by tag/capability) derived once at startup
|
||||
|
||||
4. `SkillSummaryRecord`
|
||||
- `skill_id`
|
||||
- `name`
|
||||
- `description`
|
||||
- `tags`
|
||||
- `capabilities`
|
||||
- `document_uri`
|
||||
- optional `version`
|
||||
|
||||
Immutability rule:
|
||||
|
||||
1. Once built, registry records are treated as read-only for the process lifetime.
|
||||
2. No runtime mutation during requests; refresh only via process restart.
|
||||
|
||||
### Frontmatter Parsing Contract
|
||||
|
||||
`SKILL.md` parse steps:
|
||||
|
||||
1. Read full markdown text from resource.
|
||||
2. Parse YAML frontmatter block at file start (between the first two `---` delimiters).
|
||||
3. Parse YAML with safe loader semantics.
|
||||
4. Validate parsed object with Step 2 Pydantic model(s).
|
||||
5. Preserve markdown body as document content payload.
|
||||
|
||||
Parsing failure behavior:
|
||||
|
||||
1. Missing frontmatter block: startup error.
|
||||
2. Invalid YAML: startup error with skill path and YAML parser detail.
|
||||
3. Missing required fields (`name`, `description`, `x-personal-mcp` contract fields): startup error.
|
||||
|
||||
### Validation Pipeline (Fail-Fast)
|
||||
|
||||
Validation happens in this order:
|
||||
|
||||
1. Structural discovery validation
|
||||
- skill directory exists under `docs/skills`
|
||||
- required `SKILL.md` exists for each discovered skill
|
||||
2. Schema validation
|
||||
- Pydantic frontmatter validation for all required and constrained fields
|
||||
3. Identity validation
|
||||
- frontmatter `name` equals `x-personal-mcp.id`
|
||||
- frontmatter id equals skill directory name
|
||||
4. Reference manifest validation
|
||||
- unique `ref_id` keys per skill
|
||||
- each manifest path is relative, in-skill, and under `references/`
|
||||
- each manifest target exists and is a file
|
||||
5. Dependency graph validation
|
||||
- every `depends_on` target exists in discovered skill set
|
||||
- no self-dependency
|
||||
- cycle detection enabled (hard error on cycle)
|
||||
6. Capability sanity checks
|
||||
- required primary capability `resource://skills/{skill_id}/document` is present
|
||||
7. Global uniqueness checks
|
||||
- no duplicate `skill_id`
|
||||
- no duplicate canonical resource URIs generated from registry
|
||||
8. Discovery payload checks
|
||||
- summary fields required by catalog index are present and non-empty
|
||||
- summary generation does not require reading markdown body content during request handling
|
||||
|
||||
### Error Model and Reporting
|
||||
|
||||
Error handling contract:
|
||||
|
||||
1. Collect errors per validation phase for clarity, then raise one startup exception containing all findings.
|
||||
2. Error messages must include:
|
||||
- skill id (when known)
|
||||
- packaged relative path
|
||||
- violated rule
|
||||
- actionable fix hint
|
||||
3. If any error exists, registry is not published and FastMCP resource registration does not proceed.
|
||||
|
||||
Recommended exception shape:
|
||||
|
||||
1. `DocsRegistryValidationError(errors: list[RegistryIssue])`
|
||||
2. `RegistryIssue` fields: `code`, `message`, `skill_id`, `path`, `hint`
|
||||
|
||||
### Determinism and Runtime Safety
|
||||
|
||||
Determinism rules:
|
||||
|
||||
1. Traverse directories in sorted order.
|
||||
2. Normalize all stored relative paths to POSIX form.
|
||||
3. Normalize ids/tags exactly once at parse boundary.
|
||||
4. Produce stable catalog ordering to reduce client churn.
|
||||
5. Produce stable summary projections and filter indexes from the same normalized source records.
|
||||
|
||||
Runtime safety rules:
|
||||
|
||||
1. No dependence on `Path(__file__)` or repository root.
|
||||
2. No ad-hoc fallback probing across multiple locations.
|
||||
3. No lazy validation deferred until first request.
|
||||
|
||||
### Integration Plan for Existing Modules
|
||||
|
||||
Primary integration target:
|
||||
|
||||
1. Implement the canonical package-resource-based registry loader in `src/personal_mcp/skills/document_loader.py` as the only supported runtime loader path.
|
||||
|
||||
Catalog integration:
|
||||
|
||||
1. Update `src/personal_mcp/catalog/server.py` to consume the shared in-memory registry as the only catalog data source.
|
||||
2. Keep catalog payload normalization deterministic and sourced from registry records only.
|
||||
|
||||
Startup wiring:
|
||||
|
||||
1. Initialize registry once during app/server startup in `src/personal_mcp/main.py` or equivalent composition point.
|
||||
2. Pass registry to resource registration step (Step 5).
|
||||
|
||||
### Proposed Loader API Surface
|
||||
|
||||
Use a small, testable API:
|
||||
|
||||
1. `load_docs_registry(*, package_anchor: str, docs_root: str = "docs") -> DocsRegistry`
|
||||
2. `read_skill_document(registry: DocsRegistry, skill_id: str) -> DocumentPayload`
|
||||
3. `read_skill_reference(registry: DocsRegistry, skill_id: str, ref_id: str) -> DocumentPayload`
|
||||
|
||||
Design constraints:
|
||||
|
||||
1. Loader functions are pure relative to package resources and input args.
|
||||
2. No global mutable singleton required for unit tests.
|
||||
3. Caching is explicit and owned by startup composition.
|
||||
|
||||
### Test and Validation Plan (Step 4 Scope)
|
||||
|
||||
Unit tests:
|
||||
|
||||
1. valid multi-skill registry load from packaged test fixtures
|
||||
2. duplicate id detection
|
||||
3. missing SKILL.md detection
|
||||
4. invalid frontmatter field constraints
|
||||
5. broken reference target detection
|
||||
6. invalid depends_on target detection
|
||||
7. cycle detection in depends_on graph
|
||||
8. deterministic output ordering across runs
|
||||
|
||||
Packaging/runtime tests:
|
||||
|
||||
1. install built wheel in isolated env
|
||||
2. load registry via `importlib.resources.files(...)`
|
||||
3. assert representative skill document/reference are readable
|
||||
|
||||
Expected command path in this repo:
|
||||
|
||||
1. `uv run pytest -q`
|
||||
|
||||
### Acceptance Criteria for Step 4 Completion
|
||||
|
||||
Step 4 is complete when all are true:
|
||||
|
||||
1. Registry loads exclusively from packaged resources.
|
||||
2. All Step 2 and Step 3 dependent validations are enforced at startup.
|
||||
3. Invalid docs state blocks startup with actionable diagnostics.
|
||||
4. Registry is deterministic and immutable for runtime use.
|
||||
5. Catalog and later resource registration can consume registry without direct filesystem scanning.
|
||||
|
||||
### Non-goals for Step 4
|
||||
|
||||
1. No FastMCP resource registration wiring details (Step 5).
|
||||
2. No discovery-tool fallback behavior design (Step 6).
|
||||
3. No final packaging/build-system migration mechanics (Step 7).
|
||||
4. No backward-compat alias rollout mechanics in the greenfield baseline.
|
||||
5. No compatibility layer of any kind (URI aliases, dual reads, adapter shims, or legacy schema bridges).
|
||||
@@ -1,221 +0,0 @@
|
||||
**Step 5 Results: Registry-Driven FastMCP Resource Registration (RFC6570 + Startup Safety)**
|
||||
|
||||
This section finalizes Step 5 by defining how FastMCP resources are registered from the Step 4 docs registry using RFC6570 URI templates, explicit metadata, and strict duplicate-registration safety.
|
||||
|
||||
### Greenfield Framing (Normative)
|
||||
|
||||
This Step 5 design is for the greenfield target state:
|
||||
|
||||
1. Registry-driven resources are the primary and authoritative discovery/read surface.
|
||||
2. No legacy per-skill hardcoded resource registration is retained.
|
||||
3. Resource contracts are defined for net-new clients and replace prior contracts without transition shims.
|
||||
4. Step 6 tool fallback layers on top of this resource contract, not as a competing source of truth.
|
||||
5. Breaking changes are intentional in this full-refactor phase.
|
||||
|
||||
### Research Baseline (FastMCP + URI Templates)
|
||||
|
||||
Authoritative references used for this step:
|
||||
|
||||
1. FastMCP Resources and Templates docs (resource decorator, template behavior)
|
||||
2. FastMCP RFC6570 support docs (simple params, wildcard params, query params)
|
||||
3. FastMCP duplicate handling docs (`on_duplicate_resources`)
|
||||
4. FastMCP annotations guidance (`readOnlyHint`, `idempotentHint`)
|
||||
|
||||
Best-practice conclusions applied to this design:
|
||||
|
||||
1. Use URI templates for parameterized resources instead of generating N static resource handlers.
|
||||
2. Use wildcard template parameters (`{path*}`) for hierarchical docs paths.
|
||||
3. Set startup duplicate policy to `on_duplicate_resources="error"` to fail fast on contract collisions.
|
||||
4. Set explicit `mime_type` and resource annotations for all docs resources.
|
||||
5. Keep registration deterministic and sourced only from the validated Step 4 registry.
|
||||
|
||||
### Registration Responsibilities (Normative)
|
||||
|
||||
The Step 5 registration layer MUST:
|
||||
|
||||
1. Consume only the validated in-memory registry produced by Step 4.
|
||||
2. Register canonical resource discovery surfaces and skill document/reference surfaces.
|
||||
3. Use RFC6570 templates where URI patterns are parameterized.
|
||||
4. Use wildcard templates where path depth is variable.
|
||||
5. Attach read-only/idempotent annotations to documentation resources.
|
||||
6. Set explicit MIME types for all registered resources.
|
||||
7. Fail startup if duplicate URI/template keys are encountered.
|
||||
|
||||
### Canonical Resource Surface (from Registry)
|
||||
|
||||
The preferred resources registered in this phase are:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills_index{?q,tag,capability,cursor,limit}` (optional filtered/paginated discovery template)
|
||||
3. `resource://catalog/skills/{skill_id}`
|
||||
4. `resource://skills/{skill_id}/document`
|
||||
5. `resource://skills/{skill_id}/references/{ref_id}`
|
||||
6. `resource://docs/{path*}`
|
||||
|
||||
Registration decision rules:
|
||||
|
||||
1. Use static resource registration for fixed singleton endpoints (for example `skills_index`).
|
||||
2. Use template registration for parameterized endpoints (`{skill_id}`, `{ref_id}`) and optional discovery query templates.
|
||||
3. Use wildcard template registration for hierarchical docs routing (`{path*}`).
|
||||
4. Keep the singleton and query-template discovery surfaces semantically equivalent (same schema, query template adds filtering/pagination only).
|
||||
|
||||
### Progressive Discovery Contract
|
||||
|
||||
Discovery-first behavior for Step 5 resources:
|
||||
|
||||
1. `skills_index` returns summaries only (no embedded full SKILL.md bodies).
|
||||
2. Each summary includes canonical follow-up URIs so clients can progressively fetch detail (`catalog/skills/{skill_id}` then `skills/{skill_id}/document`).
|
||||
3. Filtered/paginated discovery uses RFC6570 query params (`q`, `tag`, `capability`, `cursor`, `limit`) with deterministic ordering.
|
||||
4. Handlers should enforce bounded page size and return explicit continuation metadata when pagination is active.
|
||||
5. Errors for unsupported filter params or invalid cursor/limit are explicit and actionable.
|
||||
|
||||
### RFC6570 Template Contract
|
||||
|
||||
Path parameters:
|
||||
|
||||
1. `{skill_id}` and `{ref_id}` are single-segment template params.
|
||||
2. `{path*}` is a wildcard param and may capture multi-segment paths separated by `/`.
|
||||
|
||||
Validation contract at resource-read time:
|
||||
|
||||
1. `skill_id` must exist in registry.
|
||||
2. `ref_id` must exist in that skill’s reference manifest.
|
||||
3. wildcard `path*` must normalize to an allowed docs-relative markdown path.
|
||||
4. invalid params return explicit not-found or validation errors (no silent fallback).
|
||||
|
||||
Template function signature contract:
|
||||
|
||||
1. Required URI params must exist as function parameters.
|
||||
2. Avoid hidden implicit params not represented in template.
|
||||
3. Keep template handlers side-effect free.
|
||||
|
||||
### Metadata and Annotation Contract
|
||||
|
||||
Each docs/resource registration should specify explicit metadata:
|
||||
|
||||
1. `mime_type`
|
||||
- skill docs and references: `text/markdown`
|
||||
- catalog payloads: `application/json`
|
||||
2. `annotations`
|
||||
- `readOnlyHint: true`
|
||||
- `idempotentHint: true`
|
||||
3. `tags`
|
||||
- include stable categories such as `catalog`, `skill-doc`, `reference`, `docs`
|
||||
4. `version`
|
||||
- project-defined version from registry metadata where applicable
|
||||
5. `meta`
|
||||
- include normalized identifiers (for example `skill_id`, `ref_id`, `source_relpath`) when useful
|
||||
|
||||
### Startup Safety and Duplicate Policy
|
||||
|
||||
FastMCP initialization contract for this phase:
|
||||
|
||||
1. Construct the root server with `on_duplicate_resources="error"`.
|
||||
2. Register all Step 5 resources during startup composition before serving traffic.
|
||||
3. Treat duplicate registration as a hard startup failure.
|
||||
|
||||
Duplicate conflict classes covered:
|
||||
|
||||
1. static URI vs static URI collision
|
||||
2. static URI vs template key collision
|
||||
3. template URI vs template URI collision
|
||||
4. conflicting registrations introduced by future aliases without explicit migration handling
|
||||
|
||||
### Registration Architecture
|
||||
|
||||
Use one dedicated registration module that converts registry records into FastMCP resources.
|
||||
|
||||
Recommended API:
|
||||
|
||||
1. `register_docs_resources(mcp: FastMCP, registry: DocsRegistry) -> None`
|
||||
|
||||
Responsibilities of `register_docs_resources`:
|
||||
|
||||
1. register singleton catalog resources
|
||||
2. register parameterized catalog/detail templates
|
||||
3. register skill document and reference templates
|
||||
4. register docs wildcard template
|
||||
5. apply shared annotations and MIME defaults consistently
|
||||
|
||||
Separation of concerns:
|
||||
|
||||
1. Step 4 validates and normalizes docs state.
|
||||
2. Step 5 only registers handlers and reads from validated registry state.
|
||||
3. Request handlers do not re-discover filesystem/package structure.
|
||||
|
||||
### Handler Behavior Contract
|
||||
|
||||
Catalog handlers:
|
||||
|
||||
1. `skills_index` returns compact deterministic discovery payload (summary records only) and supports progressive follow-up links.
|
||||
2. `skills/{skill_id}` returns one normalized detail record or not-found.
|
||||
|
||||
Skill document handlers:
|
||||
|
||||
1. `skills/{skill_id}/document` returns canonical SKILL markdown content.
|
||||
2. MIME type is always `text/markdown`.
|
||||
|
||||
Reference handlers:
|
||||
|
||||
1. `skills/{skill_id}/references/{ref_id}` resolves via frontmatter manifest mapping.
|
||||
2. MIME type is explicit from manifest or defaults to `text/markdown`.
|
||||
|
||||
Wildcard docs handler:
|
||||
|
||||
1. `docs/{path*}` serves markdown docs under canonical packaged docs tree.
|
||||
2. traversal outside docs root is blocked.
|
||||
|
||||
### Integration Plan for Existing Modules
|
||||
|
||||
Primary composition updates:
|
||||
|
||||
1. Implement registry-driven registration in [src/personal_mcp/mcp.py](src/personal_mcp/mcp.py) as the canonical resource composition path.
|
||||
2. Keep [src/personal_mcp/main.py](src/personal_mcp/main.py) responsible for startup wiring order (load registry first, then register resources).
|
||||
3. Use [src/personal_mcp/catalog/server.py](src/personal_mcp/catalog/server.py) as registry-backed handlers only.
|
||||
|
||||
Lifecycle order (required):
|
||||
|
||||
1. load and validate registry (Step 4)
|
||||
2. initialize FastMCP with duplicate error policy
|
||||
3. register all Step 5 resources/templates
|
||||
4. start server
|
||||
|
||||
### Testing Plan (Step 5 Scope)
|
||||
|
||||
Unit/integration tests:
|
||||
|
||||
1. resource registration succeeds with valid registry
|
||||
2. duplicate resource registration fails at startup
|
||||
3. `skills/{skill_id}` template resolves expected record
|
||||
4. `skills/{skill_id}/document` returns markdown with correct MIME
|
||||
5. `skills/{skill_id}/references/{ref_id}` resolves manifest-mapped file
|
||||
6. `docs/{path*}` resolves nested docs paths and blocks traversal attempts
|
||||
7. all registered docs resources include `readOnlyHint` and `idempotentHint`
|
||||
8. catalog payload order is deterministic
|
||||
9. filtered/paginated `skills_index{?q,tag,capability,cursor,limit}` responses are deterministic and schema-compatible with the singleton index response
|
||||
10. catalog index payload excludes full markdown bodies and includes follow-up URIs for progressive reads
|
||||
|
||||
Smoke tests:
|
||||
|
||||
1. list resources includes singleton and template entries
|
||||
2. read representative skill doc URI and reference URI successfully
|
||||
3. read representative wildcard docs URI successfully
|
||||
|
||||
### Acceptance Criteria for Step 5 Completion
|
||||
|
||||
Step 5 is complete when all are true:
|
||||
|
||||
1. Resource registration is fully registry-driven (no per-skill hardcoded decorators required for core docs surfaces).
|
||||
2. RFC6570 templates are used for parameterized URI families, including wildcard where needed.
|
||||
3. All docs resources declare explicit MIME types and read-only/idempotent annotations.
|
||||
4. `on_duplicate_resources="error"` is enabled and verified by tests.
|
||||
5. Startup fails safely on registration conflicts.
|
||||
|
||||
### Non-goals for Step 5
|
||||
|
||||
1. No tool fallback discovery behavior implementation (Step 6).
|
||||
2. No packaging build inclusion mechanics (Step 7).
|
||||
3. No CI gate expansion details (Step 9).
|
||||
4. No migration shims for legacy URI aliases in the greenfield baseline.
|
||||
5. No ranking-strategy implementation for discovery tools beyond what is needed to preserve deterministic resource-first discovery contracts.
|
||||
6. No backward-compat resource aliases, adapter handlers, or dual registration paths.
|
||||
@@ -1,243 +0,0 @@
|
||||
**Step 6 Results: Resource-First Discovery and Tool Fallback Contract**
|
||||
|
||||
This section finalizes Step 6 by defining discovery behavior for clients that can attach MCP resources and the fallback behavior for clients or chat surfaces that must rely on MCP tools.
|
||||
|
||||
### Step Deliverable
|
||||
|
||||
- Update the current `docs/` directory with the finalized Step 6 discovery and fallback contract content from this document.
|
||||
|
||||
### Primary Source Baseline (Repository Docs)
|
||||
|
||||
Step 6 is based on the current project contracts in:
|
||||
|
||||
1. `docs/architecture.md` (resource-first architecture and catalog role)
|
||||
2. `docs/usage.md` (operating flows, bounded loading, and fallback sequence)
|
||||
3. `docs/copilot.md` (client capability lanes and practical fallback behavior)
|
||||
4. `docs/mcp_layout.md` (shared content source and thin-tool fallback position)
|
||||
5. `docs/securing.md` (read-only/public-docs security invariant)
|
||||
|
||||
Normative conclusions from those sources:
|
||||
|
||||
1. Discovery stays resource-first.
|
||||
2. Tool fallback is allowed, thin, and read-only.
|
||||
3. Resources and tools must resolve to the same canonical authored markdown.
|
||||
4. Fallback behavior should keep context bounded and deterministic.
|
||||
|
||||
### FastMCP Source Baseline (Authoritative References)
|
||||
|
||||
Step 6 fallback behavior and compatibility-layer expectations align with:
|
||||
|
||||
1. [FastMCP server concepts](https://gofastmcp.com/servers/server)
|
||||
2. [FastMCP resources and resource templates](https://gofastmcp.com/servers/resources)
|
||||
3. [FastMCP resources-as-tools transform](https://gofastmcp.com/servers/transforms/resources-as-tools)
|
||||
4. [MCP specification: resources](https://modelcontextprotocol.io/specification/latest/server/resources)
|
||||
|
||||
Applied conclusions for this step:
|
||||
|
||||
1. Resource contracts remain canonical and should be surfaced directly when clients support resource attachment.
|
||||
2. Tool-first compatibility layers should wrap canonical resource reads rather than creating alternate authored-content stores.
|
||||
3. URI-template-backed resource identity remains stable across direct-resource and tool-compatibility access paths.
|
||||
|
||||
### Client Tool-Naming Research Baseline
|
||||
|
||||
Authoritative and client-specific references to verify during implementation:
|
||||
|
||||
1. [MCP specification: tools](https://modelcontextprotocol.io/specification/latest/server/tools)
|
||||
2. [MCP client concepts](https://modelcontextprotocol.io/docs/learn/client-concepts)
|
||||
3. [FastMCP tools](https://gofastmcp.com/servers/tools)
|
||||
4. [FastMCP resources-as-tools transform](https://gofastmcp.com/servers/transforms/resources-as-tools)
|
||||
5. [VS Code MCP servers](https://code.visualstudio.com/docs/agent-customization/mcp-servers)
|
||||
6. [VS Code MCP configuration reference](https://code.visualstudio.com/docs/agents/reference/mcp-configuration)
|
||||
7. [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol)
|
||||
8. [Claude Desktop local MCP server setup](https://support.anthropic.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop)
|
||||
|
||||
Baseline naming conclusions:
|
||||
|
||||
1. MCP protocol tool identity is the server-advertised `name` returned by `tools/list` and used in `tools/call`.
|
||||
2. FastMCP tool identity should be treated as the canonical server contract unless a tool is intentionally registered with an explicit alternate name.
|
||||
3. Clients and host integrations may display, namespace, or internally route tool names with provider-specific prefixes, but those wrappers are not canonical server tool names.
|
||||
4. Compatibility should be validated by observed `tools/list` and successful `tools/call` behavior in each target client rather than by assuming one global host naming convention.
|
||||
|
||||
### Discovery Priority Contract (Normative)
|
||||
|
||||
Preferred sequence for skill discovery and loading:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills/{skill_id}`
|
||||
3. `resource://skills/{skill_id}/document`
|
||||
4. `resource://skills/{skill_id}/references/{ref_id}` only when needed
|
||||
|
||||
Rules:
|
||||
|
||||
1. Start from catalog discovery before loading any skill document.
|
||||
2. Do not skip straight to broad document loading when catalog metadata can narrow choices first.
|
||||
3. Use `resource://docs/{path*}` only for direct authored-doc access outside skill-specific flows.
|
||||
|
||||
### Fallback Activation Rule
|
||||
|
||||
Fallback is used only when the active client path cannot reliably attach MCP resources (for example, tool-only chat surfaces).
|
||||
|
||||
Rules:
|
||||
|
||||
1. Keep the same discovery order semantics as the resource path.
|
||||
2. If resource attachment is available, prefer resources over tools.
|
||||
3. Tool fallback must never become a second authoritative content source.
|
||||
|
||||
### Tool Fallback Surface (Normative)
|
||||
|
||||
The fallback tool surface includes:
|
||||
|
||||
1. `list_resources`
|
||||
2. `read_resource`
|
||||
3. `search_patterns`
|
||||
4. `get_pattern_by_id`
|
||||
5. `get_skill_document_by_id`
|
||||
|
||||
Canonical naming rule:
|
||||
|
||||
1. The server-level tool contract uses the exact registered FastMCP tool names above.
|
||||
2. Clients that expose provider-prefixed names (for example, namespaced wrappers) must map those names to the canonical server tool name before invocation.
|
||||
3. `catalog_get_skill_document_by_id` is not a canonical server tool name for this contract unless an explicit alias is intentionally registered.
|
||||
|
||||
Compatibility alias policy:
|
||||
|
||||
1. Prefer canonical server tool names over aliases.
|
||||
2. Add server-side aliases only when a major client cannot reliably map its wrapper name back to the canonical name.
|
||||
3. Any alias must be read-only, delegate to the same payload builder as the canonical tool, and be documented as compatibility-only.
|
||||
4. If aliases are added, canonical and alias tools must return byte-for-byte equivalent payloads for the same input.
|
||||
|
||||
Fallback order:
|
||||
|
||||
1. call `list_resources` to inspect canonical static/template resource surfaces
|
||||
2. call `read_resource` for catalog URIs and selected skill URIs
|
||||
3. use thin catalog tools only when additional metadata-first narrowing is needed
|
||||
|
||||
Tool behavior requirements:
|
||||
|
||||
1. read-only and idempotent semantics
|
||||
2. deterministic ordering and bounded pagination
|
||||
3. explicit not-found responses (`found: false` style) where applicable
|
||||
4. payloads remain schema-aligned with catalog resources
|
||||
5. tool invocation examples and Copilot guidance must use canonical server tool names to avoid unknown-tool errors
|
||||
|
||||
### Major Client Compatibility Plan
|
||||
|
||||
Target clients and expected validation:
|
||||
|
||||
1. GitHub Copilot in VS Code
|
||||
- primary path: attach MCP resources when `MCP Resources...` is available
|
||||
- fallback path: call `list_resources`, `read_resource`, then canonical thin tools only when needed
|
||||
- validation: confirm Copilot-visible tool inventory includes or can invoke `list_resources`, `read_resource`, `search_patterns`, `get_pattern_by_id`, and `get_skill_document_by_id`
|
||||
- compatibility risk: host-generated wrapper names may differ from canonical FastMCP names; document any observed wrapper-to-canonical mapping
|
||||
2. Cursor
|
||||
- primary path: use the client MCP server configuration and resource/tool surfaces supported by the active Cursor version
|
||||
- fallback path: prefer resource-backed tools first, then canonical thin tools
|
||||
- validation: capture Cursor `tools/list` equivalent behavior and verify the canonical tool names or required host mappings
|
||||
- compatibility risk: Cursor may present MCP tools through its own UI labels or internal routing names
|
||||
3. Claude Desktop
|
||||
- primary path: configure the local MCP server and inspect advertised tools/resources in Claude Desktop
|
||||
- fallback path: invoke canonical server tool names exactly as returned by `tools/list`
|
||||
- validation: run a local smoke prompt that reads `resource://catalog/skills_index` and loads one skill document through `read_resource` or `get_skill_document_by_id`
|
||||
- compatibility risk: local server configuration and transport setup may fail before tool-name compatibility is tested
|
||||
4. Generic MCP clients and SDK-based tests
|
||||
- primary path: protocol-level `resources/list`, `resources/read`, `tools/list`, and `tools/call`
|
||||
- fallback path: none beyond the canonical tool contract
|
||||
- validation: automated smoke tests assert exact tool names returned by `tools/list` and successful calls for canonical names
|
||||
- compatibility risk: SDK/client libraries may expose helper names that differ from raw protocol names
|
||||
|
||||
Implementation checklist:
|
||||
|
||||
1. Capture each target client's advertised tool names before adding aliases.
|
||||
2. Prefer fixing documentation or client-side mapping when the server already advertises canonical names correctly.
|
||||
3. Add a server-side alias only for a confirmed major-client incompatibility.
|
||||
4. Add regression tests for canonical names, resource-backed tools, and any intentionally supported aliases.
|
||||
5. Keep public examples centered on `list_resources`/`read_resource` and canonical thin tool names.
|
||||
|
||||
### Resources-As-Tools Compatibility Layer
|
||||
|
||||
Step 6 includes a resources-as-tools compatibility layer for clients that can call tools but not attach resources.
|
||||
|
||||
Rules:
|
||||
|
||||
1. It wraps canonical resource reads rather than re-implementing content transforms.
|
||||
2. It preserves canonical URIs and metadata semantics.
|
||||
3. It does not replace the minimal catalog tools listed above.
|
||||
4. It is interoperability-driven and remains read-only.
|
||||
|
||||
### Resource/Tool Parity Contract
|
||||
|
||||
Resources and fallback tools must agree on identity and routing metadata.
|
||||
|
||||
Parity requirements:
|
||||
|
||||
1. `skill_id` and `ref_id` are identical across both paths.
|
||||
2. canonical URIs in payloads match Step 3 URI rules.
|
||||
3. skill metadata (`id`, `name`, `description`, `tags`, `capabilities`, `version`) remains consistent.
|
||||
4. document payload returned by `get_skill_document_by_id` resolves to the same canonical `SKILL.md` content as `resource://skills/{skill_id}/document`.
|
||||
|
||||
### Relevance and Ranking Contract
|
||||
|
||||
Baseline matching behavior is metadata-first and deterministic.
|
||||
|
||||
Rules:
|
||||
|
||||
1. Search primarily over normalized skill metadata (id, name, description, tags).
|
||||
2. Keep deterministic ordering and deterministic pagination behavior.
|
||||
3. Keep ranking logic transparent and bounded for predictable client behavior.
|
||||
|
||||
Optional extension policy:
|
||||
|
||||
1. BM25/regex augmentation is allowed only when catalog/tool volume meaningfully harms token efficiency or precision.
|
||||
2. Any augmentation must preserve canonical ids, URIs, and deterministic tie-breaking.
|
||||
3. Any augmentation remains discovery-only and does not create alternate content payloads.
|
||||
|
||||
### Context-Bounding and Clarification Policy
|
||||
|
||||
To prevent context bloat and improve answer quality:
|
||||
|
||||
1. load only the most relevant skill document by default
|
||||
2. load at most two skill documents in one pass unless the user explicitly asks for more
|
||||
3. if confidence is low after catalog discovery, ask one clarifying question before loading additional skill documents
|
||||
4. fetch references lazily and only when required
|
||||
|
||||
### Security and Safety Constraints
|
||||
|
||||
Fallback tools must preserve the project security invariant.
|
||||
|
||||
Rules:
|
||||
|
||||
1. tool surfaces stay documentation-only and read-only
|
||||
2. no mutation, shell execution, secret access, or private filesystem exposure
|
||||
3. all returned content remains safe to publish publicly
|
||||
|
||||
### Integration Boundaries
|
||||
|
||||
Step 6 integrates with prior steps as follows:
|
||||
|
||||
1. Step 4 provides the validated in-memory registry.
|
||||
2. Step 5 provides canonical resource registration.
|
||||
3. Step 6 adds fallback discovery/read behavior that reuses the same registry and canonical markdown sources.
|
||||
|
||||
Separation-of-concerns rule:
|
||||
|
||||
1. Catalog/resource contracts remain canonical.
|
||||
2. Fallback tools are interoperability adapters, not a parallel architecture.
|
||||
|
||||
### Acceptance Criteria for Step 6 Completion
|
||||
|
||||
Step 6 is complete when all are true:
|
||||
|
||||
1. Resource-first discovery remains the documented and implemented default path.
|
||||
2. `list_resources` and `read_resource` are available for tool-only clients.
|
||||
3. Thin catalog tools remain minimal, read-only parity surfaces.
|
||||
4. Fallback tool outputs map to canonical skill identities and URIs.
|
||||
5. Context loading is bounded and clarifying-question behavior is documented for low-confidence cases.
|
||||
6. No second content source is introduced; resources and tools resolve the same authored markdown.
|
||||
|
||||
### Non-goals for Step 6
|
||||
|
||||
1. No write or side-effecting tools.
|
||||
2. No alternate authored markdown stores or duplicated skill content pipelines.
|
||||
3. No guarantee that every client session exposes MCP resource attachment UI.
|
||||
4. No packaging/build contract changes (handled in Step 7).
|
||||
5. No CI gate expansion details (handled in later validation/governance steps).
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
name: Pytest Fill Scaffold
|
||||
description: Fill scaffolded pytest test methods with assertions, fixtures, and minimal test data while preserving concise test names and one-line intent docstrings.
|
||||
argument-hint: Target test file(s) under tests plus stack (pure-python, fastapi, sqlalchemy-sync, sqlalchemy-async, or mixed)
|
||||
agent: agent
|
||||
---
|
||||
|
||||
# Pytest Fill Scaffold
|
||||
|
||||
Use this prompt after test scaffolding exists and method names/docstrings are already in place.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Target test file(s) under `tests/`.
|
||||
- Stack type:
|
||||
- `pure-python`
|
||||
- `fastapi`
|
||||
- `sqlalchemy-sync`
|
||||
- `sqlalchemy-async`
|
||||
- `mixed`
|
||||
- Optional constraints:
|
||||
- keep implementation minimal vs comprehensive
|
||||
- marker lane target (`unit`, `integration`, `smoke`)
|
||||
|
||||
## Required References
|
||||
|
||||
Load these in order and use only what matches the task:
|
||||
|
||||
1. Core defaults: [pytest scaffolding skill](../../src/personal_mcp/docs/skills/pytesting/SKILL.md)
|
||||
2. Naming/hierarchy preservation: [naming and organization](../../src/personal_mcp/docs/skills/pytesting/references/naming-and-organization.md)
|
||||
3. Baseline pytest fixtures/markers: [pytest docs notes](../../src/personal_mcp/docs/skills/pytesting/references/pytest-docs.md)
|
||||
4. FastAPI-specific behavior (only when needed): [fastapi testing](../../src/personal_mcp/docs/skills/pytesting/references/fastapi-testing.md)
|
||||
5. SQLAlchemy-specific behavior (only when needed): [sqlalchemy testing](../../src/personal_mcp/docs/skills/pytesting/references/sqlalchemy-testing.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Inspect target files and treat human-reviewed docstring-only scaffolds as invariant.
|
||||
2. Convert each scaffolded method into an executable test with a single behavior focus.
|
||||
3. Keep one-line docstrings for class and method intent.
|
||||
4. Add or refine fixtures at the nearest useful scope:
|
||||
- global in `tests/conftest.py` only when broadly reusable
|
||||
- subtree `conftest.py` for domain-specific fixtures
|
||||
5. Assign markers consistent with cost and dependencies:
|
||||
- `unit` for pure logic
|
||||
- `integration` for framework/DB contracts
|
||||
- `smoke` for thin critical-path checks
|
||||
6. Validate in this order:
|
||||
- `uv run pytest --collect-only -q`
|
||||
- `uv run pytest -m unit -q` when unit tests are touched
|
||||
- `uv run pytest -q` if dependencies are available
|
||||
|
||||
## Authoring Rules
|
||||
|
||||
- Prefer deterministic tests and explicit setup/teardown.
|
||||
- Keep assertions precise and readable.
|
||||
- Do not overfit tests to private implementation details.
|
||||
- If a scaffolded class or method has only a docstring body, treat its name and hierarchy as locked.
|
||||
- Do not rename, move, merge, split, or re-nest docstring-only scaffolded tests unless explicitly requested.
|
||||
- Preserve existing one-line docstrings on scaffolded classes and methods unless they are factually incorrect.
|
||||
- If stack details are missing and would change fixture strategy, ask one concise clarifying question before editing.
|
||||
|
||||
## Output Format
|
||||
|
||||
Return:
|
||||
1. Files updated.
|
||||
2. Fixture and marker decisions.
|
||||
3. Which references were used and why.
|
||||
4. Validation command results.
|
||||
5. Risks or open questions.
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
name: Pytest Scaffold
|
||||
description: Plan and scaffold pytest test files, class hierarchy, and concise method names for selected Python modules in this repository.
|
||||
argument-hint: Target module path(s) in src plus scope (plan-only or scaffold)
|
||||
agent: agent
|
||||
---
|
||||
|
||||
# Pytest Scaffold
|
||||
|
||||
Use this prompt to do in one run what we have been doing manually in chat:
|
||||
1. Build a naming and hierarchy plan for tests.
|
||||
2. Scaffold test files and class/method skeletons.
|
||||
3. Keep test method names concise because intent is carried by one-line docstrings.
|
||||
|
||||
## Inputs
|
||||
|
||||
- Target module path(s) under `src/`.
|
||||
- Scope mode:
|
||||
- `plan-only`
|
||||
- `scaffold`
|
||||
- Optional constraints:
|
||||
- flattening preferences for path mapping under `tests/`
|
||||
- method naming style preference
|
||||
|
||||
## Repository Rules To Apply
|
||||
|
||||
- Use [pytest scaffolding skill](../../src/personal_mcp/docs/skills/pytesting/SKILL.md) for strategy and defaults.
|
||||
- Use [naming and organization reference](../../src/personal_mcp/docs/skills/pytesting/references/naming-and-organization.md) before finalizing hierarchy.
|
||||
- Use `uv run pytest --collect-only -q` as structural validation.
|
||||
- Default to a source-mirror style adapted to this repository:
|
||||
- map selected modules to `tests/` with concise path segments when requested
|
||||
- keep one test module per source module
|
||||
|
||||
## Execution Steps
|
||||
|
||||
1. Inspect current `tests/` layout and identify existing naming patterns.
|
||||
2. Propose a concise hierarchy plan first:
|
||||
- test file paths
|
||||
- class hierarchy
|
||||
- method naming pattern
|
||||
- fixture placement (`tests/conftest.py` vs subtree `conftest.py`)
|
||||
3. If scope mode is `scaffold`, implement the skeleton:
|
||||
- create missing test modules
|
||||
- create class hierarchy
|
||||
- add one-line docstrings to every class and test method
|
||||
- keep test method names short and behavior-focused
|
||||
- treat resulting docstring-only scaffolds as human-reviewed baseline for future fill-in work
|
||||
4. Validate collection with `uv run pytest --collect-only -q`.
|
||||
5. Report results:
|
||||
- files created or updated
|
||||
- collection outcome
|
||||
- any ambiguities or follow-up choices
|
||||
|
||||
## Class And Method Shape Defaults
|
||||
|
||||
- Class shape:
|
||||
- `Test<PrimarySubject>` as the top-level subject class
|
||||
- nested `Test<MethodOrArea>` classes when it improves context
|
||||
- top-level `Test<FunctionName>` classes for standalone module functions
|
||||
- Method shape:
|
||||
- `test_<short_outcome>` naming
|
||||
- one behavior target per method name
|
||||
- one-line docstring that states the full intent
|
||||
|
||||
## Output Format
|
||||
|
||||
Return:
|
||||
1. Discovery summary and references consulted.
|
||||
2. Proposed or applied test tree.
|
||||
3. Class and method naming map.
|
||||
4. Validation command results.
|
||||
5. Open questions only if they block confident completion.
|
||||
@@ -0,0 +1,183 @@
|
||||
## Goal
|
||||
|
||||
Build a local, self-hosted documentation knowledge base that can ingest software docs, generate embeddings, store them in SQLite, and expose high-quality retrieval through MCP tools and resources.
|
||||
|
||||
---
|
||||
|
||||
## Core Architectural Decisions
|
||||
|
||||
### Storage
|
||||
|
||||
Use:
|
||||
|
||||
* SQLite for metadata and document storage
|
||||
* FTS5 for keyword search
|
||||
* sqlite-vec for vector similarity search
|
||||
|
||||
Avoid a separate vector database unless scale requirements emerge.
|
||||
|
||||
---
|
||||
|
||||
### Embeddings
|
||||
|
||||
Use local embedding models via:
|
||||
|
||||
* sentence-transformers
|
||||
|
||||
Recommended model:
|
||||
|
||||
```text
|
||||
BAAI/bge-base-en-v1.5
|
||||
```
|
||||
|
||||
Store embeddings alongside document chunks.
|
||||
|
||||
---
|
||||
|
||||
### Ingestion
|
||||
|
||||
Primary sources:
|
||||
|
||||
1. Git repositories containing Markdown docs
|
||||
2. Documentation websites via Crawl4AI
|
||||
3. Sitemap-driven crawls when available
|
||||
|
||||
Pipeline:
|
||||
|
||||
```text
|
||||
Source
|
||||
↓
|
||||
Extract
|
||||
↓
|
||||
Normalize
|
||||
↓
|
||||
Chunk by headings
|
||||
↓
|
||||
Embed
|
||||
↓
|
||||
Store
|
||||
```
|
||||
|
||||
Track content hashes so unchanged documents are skipped during reindexing.
|
||||
|
||||
---
|
||||
|
||||
### Retrieval
|
||||
|
||||
Implement hybrid retrieval:
|
||||
|
||||
```text
|
||||
FTS5 keyword search
|
||||
+
|
||||
sqlite-vec similarity search
|
||||
↓
|
||||
Candidate set
|
||||
↓
|
||||
Reranker
|
||||
↓
|
||||
Final results
|
||||
```
|
||||
|
||||
Reranker:
|
||||
|
||||
```text
|
||||
BAAI/bge-reranker-v2
|
||||
```
|
||||
|
||||
The retriever owns all ranking logic.
|
||||
|
||||
---
|
||||
|
||||
### Public Interface
|
||||
|
||||
Do not expose vector search directly.
|
||||
|
||||
Expose a retrieval service through MCP:
|
||||
|
||||
```python
|
||||
search_docs(query)
|
||||
|
||||
get_context(query)
|
||||
|
||||
get_doc(path)
|
||||
```
|
||||
|
||||
The MCP layer becomes the stable API.
|
||||
|
||||
Clients never interact with embeddings or vectors.
|
||||
|
||||
---
|
||||
|
||||
## Repository Layout
|
||||
|
||||
```text
|
||||
src/
|
||||
├── knowledge/
|
||||
│ ├── models.py
|
||||
│ ├── chunking.py
|
||||
│ ├── embeddings.py
|
||||
│ ├── ingestion.py
|
||||
│ ├── sqlite_store.py
|
||||
│ ├── hybrid_search.py
|
||||
│ ├── reranker.py
|
||||
│ └── retrieval.py
|
||||
│
|
||||
├── sources/
|
||||
│ ├── git_docs.py
|
||||
│ ├── crawl4ai_docs.py
|
||||
│ └── sitemap_docs.py
|
||||
│
|
||||
├── mcp_server/
|
||||
│ ├── tools.py
|
||||
│ └── resources.py
|
||||
│
|
||||
└── cli/
|
||||
├── ingest.py
|
||||
└── reindex.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Retrieval Flow
|
||||
|
||||
```text
|
||||
User Query
|
||||
↓
|
||||
Embed Query
|
||||
↓
|
||||
FTS5 Search
|
||||
+
|
||||
Vector Search
|
||||
↓
|
||||
Merge Results
|
||||
↓
|
||||
Rerank
|
||||
↓
|
||||
Return Context Bundle
|
||||
```
|
||||
|
||||
Where a context bundle contains:
|
||||
|
||||
```python
|
||||
ContextBundle(
|
||||
passages=[...],
|
||||
citations=[...],
|
||||
related_docs=[...],
|
||||
)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Future Extensions
|
||||
|
||||
Without changing the architecture:
|
||||
|
||||
* Multiple documentation corpora
|
||||
* Version-aware retrieval
|
||||
* Code snippet indexing
|
||||
* MCP resources for specific topics
|
||||
* LangGraph integration
|
||||
* Docker deployment
|
||||
* Scheduled reindexing
|
||||
|
||||
The key design principle is: **treat the vector store as an internal implementation detail and expose a retrieval-oriented MCP interface instead.**
|
||||
Vendored
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Python: personal-mcp entrypoint",
|
||||
"type": "debugpy",
|
||||
"request": "launch",
|
||||
"module": "personal_mcp.__main__",
|
||||
"cwd": "${workspaceFolder}",
|
||||
"console": "integratedTerminal",
|
||||
"justMyCode": true,
|
||||
"env": {
|
||||
"PYTHONUNBUFFERED": "1"
|
||||
},
|
||||
"args": [ "--port", "8766", "--reload" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
Vendored
+1
-7
@@ -51,13 +51,7 @@
|
||||
"command": "uv",
|
||||
"args": [
|
||||
"run",
|
||||
"uvicorn",
|
||||
"personal_mcp.main:create_app",
|
||||
"--factory",
|
||||
"--host",
|
||||
"127.0.0.1",
|
||||
"--port",
|
||||
"8000",
|
||||
"personal-mcp",
|
||||
"--reload"
|
||||
],
|
||||
"options": {
|
||||
|
||||
+25
-27
@@ -1,54 +1,52 @@
|
||||
FROM python:3.14-slim AS builder
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
|
||||
|
||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
||||
PYTHONUNBUFFERED=1 \
|
||||
ENV PYTHONUNBUFFERED=1 \
|
||||
UV_SYSTEM_CERTS=1 \
|
||||
UV_PYTHON_DOWNLOADS=0 \
|
||||
UV_NO_MANAGED_PYTHON=1 \
|
||||
UV_SYSTEM_PYTHON=1 \
|
||||
UV_PROJECT_ENVIRONMENT=/usr/local \
|
||||
UV_COMPILE_BYTECODE=1 \
|
||||
UV_LINK_MODE=copy \
|
||||
UV_LOCKED=1
|
||||
UV_NO_DEV=1 \
|
||||
UV_LOCKED=1 \
|
||||
UV_LINK_MODE=copy
|
||||
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
--mount=type=bind,source=zensical.toml,target=zensical.toml \
|
||||
--mount=type=bind,source=docs/,target=docs/ \
|
||||
uvx zensical build
|
||||
--mount=type=bind,source=src/personal_mcp/docs/,target=src/personal_mcp/docs/ \
|
||||
uvx zensical build --clean --strict
|
||||
|
||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
--mount=type=bind,source=uv.lock,target=uv.lock \
|
||||
--mount=type=bind,source=pyproject.toml,target=pyproject.toml \
|
||||
uv sync --no-install-project
|
||||
|
||||
# COPY --chown=appuser:appuser . /app
|
||||
COPY pyproject.toml uv.lock README.md /app/
|
||||
COPY ./src /app/src
|
||||
|
||||
# RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
# uv sync --no-editable
|
||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
uv sync
|
||||
|
||||
FROM python:3.14-slim AS runtime
|
||||
|
||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
||||
PYTHONUNBUFFERED=1 \
|
||||
PATH="/app/.venv/bin:$PATH" \
|
||||
PERSONAL_MCP_SITE_DIR=/app/site
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
EXPOSE 8765
|
||||
PYTHONUNBUFFERED=1
|
||||
|
||||
RUN groupadd --system --gid 1001 appuser && \
|
||||
useradd --system --uid 1001 --gid appuser appuser
|
||||
|
||||
COPY --from=ghcr.io/astral-sh/uv:latest --chown=appuser:appuser /uv /uvx /bin/
|
||||
COPY --from=builder --chown=appuser:appuser /app/.venv /app/.venv
|
||||
COPY --from=builder --chown=appuser:appuser /app/site /app/site
|
||||
COPY --chown=appuser:appuser ./docs /app/docs
|
||||
WORKDIR /app
|
||||
|
||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
--mount=type=bind,source=uv.lock,target=uv.lock \
|
||||
--mount=type=bind,source=pyproject.toml,target=pyproject.toml \
|
||||
--mount=type=bind,source=src/,target=src/ \
|
||||
uv sync --no-editable --refresh-package prompts
|
||||
RUN chown appuser:appuser /app
|
||||
|
||||
COPY --from=builder --chown=appuser:appuser /usr/local/lib /usr/local/lib
|
||||
COPY --from=builder --chown=appuser:appuser /usr/local/bin /usr/local/bin
|
||||
COPY --from=builder --chown=appuser:appuser /app /app
|
||||
|
||||
USER appuser
|
||||
|
||||
CMD ["uvicorn", "personal_mcp.main:create_app", "--factory", "--host", "0.0.0.0", "--port", "8765"]
|
||||
ENTRYPOINT ["/usr/local/bin/personal-mcp"]
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# JSL MCP
|
||||
|
||||
```shell
|
||||
uv run mcp-stdio
|
||||
```
|
||||
|
||||
```shell
|
||||
uv run fastmcp list --command "uv run mcp-stdio" --prompts
|
||||
```
|
||||
|
||||
```shell
|
||||
uv run fastmcp call --command "uv run mcp-stdio" \
|
||||
--target authoring --prompt \
|
||||
--input-json '{"artifact_type":"prompt","artifact_id":"release-notes","goal":"Create a reusable release-notes workflow."}' \
|
||||
--json
|
||||
```
|
||||
+9
-4
@@ -1,8 +1,13 @@
|
||||
services:
|
||||
personal-mcp:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
app:
|
||||
image: personal-mcp:latest
|
||||
build: .
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "8765:8765"
|
||||
environment:
|
||||
PERSONAL_MCP_PORT: 8765
|
||||
PERSONAL_MCP_HOST: 0.0.0.0
|
||||
PERSONAL_MCP_RELOAD: 1
|
||||
volumes:
|
||||
- ./src:/app/src:ro
|
||||
|
||||
@@ -1,266 +0,0 @@
|
||||
---
|
||||
icon: lucide/library
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
## Overview
|
||||
|
||||
The platform is implemented as a resource-first MCP system with an integrated static documentation surface. The same methodology content powers both MCP resources and the published docs site.
|
||||
|
||||
An MCP server is a runtime that exposes machine-readable resources and tools through stable interfaces so AI clients can discover and consume context consistently. Here, the server's role is intentionally narrow: publish canonical methodology documents as resources, keep discovery predictable through a catalog layer, and serve the same source material as pre-built static documentation.
|
||||
|
||||
The system is complete in three layers:
|
||||
|
||||
1. Canonical methodology is maintained in Markdown skill documents.
|
||||
2. Catalog resources provide normalized discovery.
|
||||
3. Zensical builds a static site from those same Markdown sources and the FastAPI app serves it in the FastMCP runtime process.
|
||||
|
||||
Prompt documents under `docs/prompts/` are also indexed and exposed as first-class catalog and prompt surfaces.
|
||||
|
||||
This architecture is anchored by three contracts:
|
||||
|
||||
1. Docs-first authored content contract under `docs/` with strict per-skill ownership.
|
||||
2. `SKILL.md` frontmatter contract with Anthropic fields plus `x-personal-mcp` metadata.
|
||||
3. Canonical resource URI contract with break-and-replace policy for contract changes.
|
||||
|
||||
Detailed contract pages:
|
||||
|
||||
1. [Content Contract](./contracts/index.md#content-contract)
|
||||
2. [Frontmatter Contract](./contracts/frontmatter.md)
|
||||
3. [URI Contract](./contracts/uris.md)
|
||||
|
||||
This architecture keeps authored content human-friendly while preserving machine-stable contracts.
|
||||
|
||||
## Intent
|
||||
|
||||
The architecture is designed to satisfy three long-term requirements:
|
||||
|
||||
1. Methodology must be editable as markdown by humans.
|
||||
2. Agents must consume stable, discoverable resource contracts, with a minimal read-only catalog tool fallback for constrained clients.
|
||||
3. Public documentation must be pre-built static output served from the application runtime without a separate docs service.
|
||||
|
||||
## System Model
|
||||
|
||||
### Pattern Modules
|
||||
|
||||
Each skill encapsulates one methodology domain in a docs-owned directory:
|
||||
|
||||
1. `docs/skills/<skill-id>/SKILL.md`
|
||||
2. `docs/skills/<skill-id>/references/...`
|
||||
|
||||
The skill document and references are the authored source of truth; runtime code indexes and serves these files without becoming a second authored source.
|
||||
|
||||
Each skill publishes resource families:
|
||||
|
||||
1. document
|
||||
|
||||
The document resource returns canonical Markdown, while clients can perform any downstream section extraction they need.
|
||||
|
||||
### Prompt Modules
|
||||
|
||||
Prompt guidance can be authored in `docs/prompts/` using either canonical prompt directories (`docs/prompts/<prompt-id>/PROMPT.md`) or legacy markdown files during migration.
|
||||
|
||||
Prompt modules publish two additive surfaces:
|
||||
|
||||
1. prompt resources for catalog and document retrieval
|
||||
2. MCP prompt objects for prompt-list/get-prompt style client workflows
|
||||
|
||||
This keeps authored markdown as source-of-truth while allowing clients to discover and invoke prompts directly.
|
||||
|
||||
### Catalog Module
|
||||
|
||||
The catalog is the canonical discovery layer and publishes normalized records for all modules. It may also expose a minimal set of read-only discovery tools that resolve back to the same canonical markdown content when a client chat surface does not expose MCP resource attachment.
|
||||
|
||||
Typical catalog resources:
|
||||
|
||||
1. resource://catalog/skills_index
|
||||
2. resource://catalog/skills_index{?q,tag,capability,cursor,limit}
|
||||
3. resource://catalog/skills/{skill_id}
|
||||
4. resource://catalog/prompts_index
|
||||
5. resource://catalog/prompts_index{?q,tag,cursor,limit}
|
||||
6. resource://catalog/prompts/{prompt_id}
|
||||
|
||||
Only canonical catalog resources are part of the runtime contract in this phase.
|
||||
|
||||
### Registry Loader
|
||||
|
||||
Importing the package does not read or parse documentation. The MCP server and FastAPI application factories request the registry when constructing a runnable server, using packaged resources through `importlib.resources.files(...)` and `Traversable` APIs.
|
||||
|
||||
Loader responsibilities:
|
||||
|
||||
1. Parse SKILL.md frontmatter for each skill.
|
||||
2. Validate schema and cross-field constraints before any resource registration.
|
||||
3. Build an in-memory registry keyed by `skill_id`.
|
||||
4. Fail fast for duplicate ids, missing markdown files, and broken reference mappings.
|
||||
|
||||
The immutable registry is cached for the process lifetime. Each Uvicorn worker constructs and retains its own registry because worker processes do not share Python objects. Registry load failure is a server-factory startup error, not a package-import error or partial runtime warning.
|
||||
|
||||
### Content Sources
|
||||
|
||||
Content is authored in markdown under `docs/` and managed as long-form reference material. Skill documents and companion references now live under `docs/skills/`, while project-authored pages remain alongside them in the docs tree. Resource handlers expose the same authored documents through stable resource URIs.
|
||||
|
||||
The repository root `docs/` directory is the only authored source. The `src/personal_mcp/docs` path is a relative symlink to that directory for source-checkout and editable-install workflows; it is not a second content tree and packaging does not depend on traversing it.
|
||||
|
||||
For wheel builds, [Hatchling forced inclusion](https://hatch.pypa.io/latest/config/build/#forced-inclusion) maps the root `docs/` tree to `personal_mcp/docs/`. The wheel therefore contains regular resource files at that destination rather than a symlink. Runtime registry loading uses [`importlib.resources.files`](https://docs.python.org/3/library/importlib.resources.html#importlib.resources.files) and `Traversable` operations from the `personal_mcp` package anchor, so it does not depend on the repository layout or current working directory.
|
||||
|
||||
### Static Docs Surface
|
||||
|
||||
Static docs are built directly from two markdown source streams:
|
||||
|
||||
1. Project-authored docs pages
|
||||
2. Skill and reference markdown pages
|
||||
|
||||
The merged docs tree is built by Zensical into static files and served by the FastAPI app.
|
||||
|
||||
Generated `site/` files are deployment assets for the human-facing static site. They are separate from the authored Markdown resources packaged under `personal_mcp/docs/`.
|
||||
|
||||
## Data Flow
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[Authored Markdown] --> C[Resource Handlers]
|
||||
B[Pattern Metadata] --> D[Catalog Resources]
|
||||
A --> E[Zensical Static Build]
|
||||
E --> H[FastAPI Static Mount]
|
||||
H --> I[Served Docs Site]
|
||||
D --> I
|
||||
```
|
||||
|
||||
## Contracts
|
||||
|
||||
### Metadata Contract
|
||||
|
||||
Each skill declares frontmatter in `docs/skills/<skill-id>/SKILL.md`.
|
||||
|
||||
For the full field-level contract, validation model, and FastMCP metadata mapping, see [Frontmatter Contract](./contracts/frontmatter.md).
|
||||
|
||||
Anthropic-facing required fields:
|
||||
|
||||
1. name
|
||||
2. description
|
||||
|
||||
Repository indexing metadata is declared in `x-personal-mcp`:
|
||||
|
||||
1. id
|
||||
2. version
|
||||
3. tags
|
||||
4. capabilities
|
||||
5. optional references map (for nested entries, overrides, and aliases)
|
||||
|
||||
No `metadata.yaml` sidecar is part of the end-state contract.
|
||||
|
||||
### URI Contract
|
||||
|
||||
Canonical resource URIs are:
|
||||
|
||||
For the full URI semantics, parameter validation rules, and compatibility policy, see [URI Contract](./contracts/uris.md).
|
||||
|
||||
1. resource://skills/<skill_id>/document
|
||||
2. resource://skills/<skill_id>/references/<ref_id>
|
||||
3. resource://catalog/skills_index
|
||||
4. resource://catalog/skills_index{?q,tag,capability,cursor,limit}
|
||||
5. resource://catalog/skills/{skill_id}
|
||||
6. resource://docs/{path*}
|
||||
7. resource://catalog/prompts_index
|
||||
8. resource://catalog/prompts_index{?q,tag,cursor,limit}
|
||||
9. resource://catalog/prompts/{prompt_id}
|
||||
10. resource://prompts/{prompt_id}/document
|
||||
|
||||
Validation rules:
|
||||
|
||||
1. `skill_id` is lowercase kebab-case and must satisfy the stable skill id contract.
|
||||
2. `ref_id` is lowercase kebab-case and must resolve from either:
|
||||
- top-level auto-discovery of `references/*.md` filename stems, or
|
||||
- an explicit `x-personal-mcp.references` entry.
|
||||
3. `path*` resolves only to normalized markdown paths under `docs/`.
|
||||
|
||||
### Resource Registration Contract
|
||||
|
||||
Resources are registered from the validated registry, not by ad hoc per-skill hardcoding.
|
||||
|
||||
Registration rules:
|
||||
|
||||
1. Use RFC6570 URI templates where appropriate.
|
||||
2. Mark documentation resources as read-only and idempotent.
|
||||
3. Set explicit mime types for resource responses.
|
||||
4. Configure duplicate URI handling with `on_duplicate="error"` for startup safety.
|
||||
|
||||
This keeps runtime behavior deterministic and prevents accidental URI collisions.
|
||||
|
||||
### Versioning Rule
|
||||
|
||||
URIs are unversioned and canonical in this phase.
|
||||
|
||||
1. Breaking URI changes are handled as direct replacement.
|
||||
2. No compatibility aliases or dual URI families are maintained.
|
||||
|
||||
## Static Hosting Pattern
|
||||
|
||||
The docs site is pre-built and served by the same FastAPI runtime process used by the MCP app.
|
||||
|
||||
Runtime behavior:
|
||||
|
||||
1. App starts.
|
||||
2. FastAPI mounts the static docs output directory.
|
||||
3. Requests to docs paths are served as static assets.
|
||||
|
||||
This provides a single deployment artifact with no runtime markdown rendering dependency.
|
||||
|
||||
## Advantages
|
||||
|
||||
### Single Source of Truth
|
||||
|
||||
Methodology is authored once and reused in both MCP resources and docs pages.
|
||||
|
||||
### High-Fidelity Agent Context
|
||||
|
||||
Resources expose the same canonical Markdown that humans author and review.
|
||||
|
||||
### Operational Simplicity
|
||||
|
||||
A single app process serves MCP and docs surfaces.
|
||||
|
||||
### Long-Term Maintainability
|
||||
|
||||
Markdown remains easy to review, while contracts remain stable for clients.
|
||||
|
||||
### Client Independence
|
||||
|
||||
Clients can use Ask, Edit, or Agent modes without requiring prompt-first orchestration. Prompt objects are available as an additive MCP surface, while resource retrieval remains the canonical source path. MCP affordances are still chat-surface-dependent: some clients or sessions expose resource attachment directly, while others make tool invocation the more reliable retrieval path.
|
||||
|
||||
## Authoring and Publishing Lifecycle
|
||||
|
||||
1. Update markdown reference content.
|
||||
2. Update metadata if capability surface changes.
|
||||
3. Build static docs with Zensical.
|
||||
4. Serve built output through FastAPI static mount.
|
||||
|
||||
## Scope and Non-Goals
|
||||
|
||||
In-scope:
|
||||
|
||||
1. Resource-first methodology delivery
|
||||
2. Catalog-based discovery
|
||||
3. Pre-built static docs hosting in app runtime
|
||||
|
||||
Out-of-scope:
|
||||
|
||||
1. Prompt-first orchestration as the primary interface
|
||||
2. Large tool inventories duplicating static guidance across skill modules
|
||||
3. Separate dynamic docs service at runtime
|
||||
|
||||
Allowed exception:
|
||||
|
||||
1. A small catalog-level tool layer is acceptable when it improves client interoperability without creating a second source of truth for skill content.
|
||||
|
||||
## Example Content Inputs
|
||||
|
||||
Existing markdown reference sets are valid examples of authored source material for this architecture:
|
||||
|
||||
1. docs/skills/pytesting/references/pytest-docs.md
|
||||
2. docs/skills/python-logging/references/python-logging-docs.md
|
||||
3. docs/skills/python-logging/references/json-file-logging.md
|
||||
4. docs/skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
||||
|
||||
These inputs are treated as content sources, while resource URIs and catalog payloads remain the machine-facing contracts.
|
||||
@@ -1,262 +0,0 @@
|
||||
---
|
||||
icon: lucide/pencil
|
||||
---
|
||||
|
||||
# Authoring Guide
|
||||
|
||||
This page defines the practical authoring workflow for this repository so Markdown remains the single source of truth for both published docs and MCP resources.
|
||||
|
||||
Primary references:
|
||||
- [Skill contract](./contracts/skill_contract.md)
|
||||
- [Prompt contract](./contracts/prompt.md)
|
||||
- [Frontmatter contract](./contracts/frontmatter.md)
|
||||
- [URI contract](./contracts/uris.md)
|
||||
- [Zensical documentation authoring skill](./skills/zensical-docs/SKILL.md)
|
||||
|
||||
## What You Author
|
||||
|
||||
This repository has two primary authored content types:
|
||||
|
||||
1. Skills under `docs/skills/<skill-id>/`.
|
||||
2. Prompts under `docs/prompts/<prompt-id>/`.
|
||||
|
||||
Each module keeps one canonical document plus optional references:
|
||||
|
||||
```text
|
||||
docs/
|
||||
skills/<skill-id>/
|
||||
SKILL.md
|
||||
references/
|
||||
*.md
|
||||
|
||||
prompts/<prompt-id>/
|
||||
PROMPT.md
|
||||
references/
|
||||
*.md
|
||||
```
|
||||
|
||||
## Source Tree Ownership
|
||||
|
||||
Edit content only under the repository root `docs/` directory. The `src/personal_mcp/docs` path is a relative symlink provided so package-oriented tooling and editable installs see the same files; do not replace it with copied content or author files through a second tree.
|
||||
|
||||
[Hatchling forced inclusion](https://hatch.pypa.io/latest/config/build/#forced-inclusion) projects root `docs/` into `personal_mcp/docs/` when building the wheel. Installed code reads that destination through [`importlib.resources`](https://docs.python.org/3/library/importlib.resources.html), while Zensical continues to build the human-facing site directly from root `docs/`.
|
||||
|
||||
Package import does not load these resources. A runnable MCP or FastAPI server loads and validates them when its factory runs, then caches the immutable registry for that process. Restart initialized development or worker processes after changing authored Markdown.
|
||||
|
||||
## Authoring Principles
|
||||
|
||||
1. Keep Markdown as the canonical source and avoid duplicating content into alternate metadata files.
|
||||
2. Prefer resource-first discovery paths (`resource://catalog/...` then `resource://skills/...` or `resource://prompts/...`).
|
||||
3. Keep pages focused and composable: overview in the primary doc, details in `references/`.
|
||||
4. Use descriptive inline links for external sources instead of bare URLs.
|
||||
5. Use stable ids and slugs; renames are breaking changes and should be intentional.
|
||||
|
||||
## Skill Authoring Workflow
|
||||
|
||||
When creating or updating a skill:
|
||||
|
||||
1. Confirm slug format is lowercase kebab-case.
|
||||
2. Keep directory name, `name`, and `x-personal-mcp.id` aligned.
|
||||
3. Ensure capabilities include `resource://skills/<skill-id>/document`.
|
||||
4. Place supporting material under `references/`.
|
||||
5. Use explicit frontmatter reference entries only when you need overrides or nested mappings.
|
||||
|
||||
Recommended sequence:
|
||||
|
||||
1. Draft `SKILL.md` intent and routing sections.
|
||||
2. Add or refine `references/*.md`.
|
||||
3. Verify links and example commands.
|
||||
4. Run docs build and tests.
|
||||
|
||||
For exact metadata rules, see [Frontmatter contract](./contracts/frontmatter.md) and [Skill contract](./contracts/skill_contract.md).
|
||||
|
||||
## Prompt Authoring Workflow
|
||||
|
||||
When creating or updating a prompt module:
|
||||
|
||||
1. Keep one canonical `PROMPT.md`.
|
||||
2. Keep `name`, `x-personal-mcp.id`, and directory slug aligned.
|
||||
3. Include `resource://prompts/<prompt-id>/document` in capabilities.
|
||||
4. Define prompt arguments in `x-personal-mcp.arguments` when inputs are required.
|
||||
5. Keep long rationale and source notes in `references/` to preserve prompt clarity.
|
||||
|
||||
For exact structure, see [Prompt contract](./contracts/prompt.md).
|
||||
|
||||
## Prompt Argument Mechanics
|
||||
|
||||
When defining prompt inputs, keep argument metadata aligned with the prompt contract and runtime behavior.
|
||||
|
||||
1. Define arguments under `x-personal-mcp.arguments` as a map keyed by argument name.
|
||||
2. Argument names must match Python identifier format: `^[A-Za-z_][A-Za-z0-9_]*$`.
|
||||
3. Each argument entry supports only:
|
||||
- `title` (optional)
|
||||
- `description` (optional)
|
||||
- `required` (optional, defaults to `false`)
|
||||
4. Unknown argument fields are rejected by strict frontmatter validation.
|
||||
5. Prompt argument metadata appears in `resource://catalog/prompts/{prompt_id}`, and MCP prompt objects expose the same arguments for prompt-list/get-prompt workflows.
|
||||
6. Enum-like constraints are not a native argument field; encode allowed values in `description`.
|
||||
|
||||
### Frontmatter Safety Rules
|
||||
|
||||
Use these rules to avoid YAML parse failures in prompt and skill frontmatter:
|
||||
|
||||
1. Quote any scalar value that contains `:` (for example, `description: "Enum: skill | prompt | shim"`).
|
||||
2. Prefer quoted scalars for values with reserved YAML characters such as `#`, `{}`, `[]`, or leading `*`.
|
||||
3. If a description needs multiple lines, use a block scalar (`|`) instead of packing punctuation-heavy text into one line.
|
||||
4. Keep frontmatter keys simple and contract-bound; do not add undeclared argument fields.
|
||||
|
||||
### Validation Timing
|
||||
|
||||
Run validation immediately after frontmatter edits, not only at the end of a task:
|
||||
|
||||
1. First pass after metadata changes: `uv run zensical build`
|
||||
2. Prompt/skill load verification: `uv run pytest -q`
|
||||
3. Final full pass before completion: run the full checklist in [Validation Checklist](#validation-checklist)
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
x-personal-mcp:
|
||||
arguments:
|
||||
artifact_type:
|
||||
title: Artifact type
|
||||
description: Allowed values are skill, prompt, or shim.
|
||||
required: true
|
||||
scope_glob:
|
||||
title: Scope glob
|
||||
description: Optional applyTo glob for shim outputs.
|
||||
required: false
|
||||
```
|
||||
|
||||
References:
|
||||
|
||||
1. [Frontmatter contract](./contracts/frontmatter.md)
|
||||
2. [URI contract](./contracts/uris.md)
|
||||
3. [Resource-First Pattern Module Architecture](./architecture.md)
|
||||
4. [Prompt objects concept docs](https://modelcontextprotocol.io/docs/learn/server-concepts#prompts)
|
||||
|
||||
## Writing Quality Rules
|
||||
|
||||
Apply these defaults to all docs pages:
|
||||
|
||||
1. Prefer short sections with strong headings over long unbroken prose.
|
||||
2. Keep claims source-linked, especially for MCP, FastMCP, pytest, FastAPI, SQLAlchemy, and Zensical behavior.
|
||||
3. Prefer relative links for internal docs paths.
|
||||
4. Use code blocks for commands and configuration snippets.
|
||||
5. Keep examples minimal and actionable.
|
||||
|
||||
Source examples:
|
||||
- [Model Context Protocol docs](https://modelcontextprotocol.io/docs/getting-started/intro)
|
||||
- [FastMCP docs](https://gofastmcp.com/getting-started/welcome)
|
||||
- [Zensical docs](https://zensical.org/docs/)
|
||||
|
||||
## Authoring for GitHub Copilot
|
||||
|
||||
For resource selection or tool-based matching to work well, each skill should have:
|
||||
|
||||
1. precise `description`
|
||||
2. focused `tags`
|
||||
3. explicit `capabilities`
|
||||
4. stable `id` and slug naming
|
||||
|
||||
Weak metadata reduces Copilot match quality and increases wrong context injection.
|
||||
|
||||
### Copilot Instruction Authoring Pattern
|
||||
|
||||
If you want Copilot to use `personal-mcp` skill content more reliably, instruction files should describe three things clearly:
|
||||
|
||||
1. when MCP-backed skill guidance is relevant
|
||||
2. which retrieval path Copilot should prefer first
|
||||
3. how much skill context it should load before answering
|
||||
|
||||
Instructions strongly steer discovery behavior, but they do not force VS Code to auto-attach MCP resources. Keep wording explicit about preferred path and fallback path.
|
||||
|
||||
Repository policy:
|
||||
|
||||
1. start from catalog discovery
|
||||
2. prefer MCP resources when the current chat surface exposes resource attachment
|
||||
3. fall back to catalog tools when resource attachment is unavailable
|
||||
4. keep loaded skill context bounded
|
||||
|
||||
Suggested instruction text:
|
||||
|
||||
```md
|
||||
When a task may match a documented implementation pattern from `personal-mcp`:
|
||||
|
||||
1. Start with catalog-first discovery.
|
||||
2. Prefer MCP resources when the chat surface exposes resource attachment.
|
||||
3. If MCP resource attachment is unavailable, use `list_resources`/`read_resource` first, then thin catalog tools if needed.
|
||||
4. Load only the most relevant skill document, or at most 2 skill documents.
|
||||
5. Reconcile loaded skill guidance with the actual repository code before making changes.
|
||||
|
||||
Preferred resource order:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills/{skill_id}`
|
||||
3. `resource://skills/<skill-id>/document`
|
||||
4. `resource://skills/<skill-id>/references/<ref-id>` when needed
|
||||
|
||||
Preferred tool fallback order:
|
||||
|
||||
1. `list_resources`
|
||||
2. `read_resource`
|
||||
3. `search_patterns`
|
||||
4. `get_pattern_by_id`
|
||||
5. `get_skill_document_by_id`
|
||||
|
||||
Compatibility aliases for clients that use `catalog_*` naming are also available:
|
||||
|
||||
1. `catalog_search_patterns`
|
||||
2. `catalog_get_pattern_by_id`
|
||||
3. `catalog_get_skill_document_by_id`
|
||||
4. `catalog_search_prompts`
|
||||
5. `catalog_get_prompt_by_id`
|
||||
|
||||
Use canonical names first; aliases exist only to preserve interoperability when a client emits non-canonical names.
|
||||
|
||||
If confidence is low after discovery, ask one clarifying question before loading more context.
|
||||
```
|
||||
|
||||
This is guidance, not a guarantee. It defines a reliable policy while preserving the resource-first architecture.
|
||||
|
||||
Thin shim path binding guidance for MCP consumers is covered in [Skill Usage Mechanics](./usage.md).
|
||||
|
||||
## Zensical Details
|
||||
|
||||
When adding or restructuring pages:
|
||||
|
||||
1. Update navigation in `zensical.toml`.
|
||||
2. Ensure top-level pages include frontmatter with an icon.
|
||||
3. Keep naming and labels concise so navigation remains scannable.
|
||||
|
||||
Top-level page pattern:
|
||||
|
||||
```yaml
|
||||
---
|
||||
icon: lucide/pencil
|
||||
---
|
||||
```
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
Run these checks before considering authoring changes complete:
|
||||
|
||||
```bash
|
||||
uv run zensical build
|
||||
uv run ruff check .
|
||||
uv run ty check
|
||||
uv run pytest
|
||||
```
|
||||
|
||||
Address any errors or warnings that result.
|
||||
|
||||
If a change only affects docs content, `uv run zensical build` is still required.
|
||||
|
||||
## Quick Authoring Checklist
|
||||
|
||||
1. Correct location (`skills/` or `prompts/`).
|
||||
2. Frontmatter id and slug alignment.
|
||||
3. Capability URI present.
|
||||
4. Links valid and descriptive.
|
||||
5. Navigation updated when needed.
|
||||
6. Validation commands passed.
|
||||
@@ -1,234 +0,0 @@
|
||||
---
|
||||
icon: lucide/braces
|
||||
---
|
||||
|
||||
# Frontmatter Contract
|
||||
|
||||
This page defines the `SKILL.md` frontmatter and FastMCP metadata contract.
|
||||
|
||||
Prompt modules use the same contract style in `docs/prompts/<prompt-id>/PROMPT.md` with prompt-specific capability and MCP-aligned prompt argument metadata.
|
||||
|
||||
## Validated Frontmatter Surface
|
||||
|
||||
The registry runtime validates a strict, standard-only frontmatter surface:
|
||||
|
||||
1. Top-level fields accepted for skills: `name`, `description`, `x-personal-mcp`.
|
||||
2. Top-level fields accepted for prompts: `name`, `description`, `x-personal-mcp`.
|
||||
3. Unknown top-level fields are rejected during registry load.
|
||||
|
||||
Skill and prompt identifier rules:
|
||||
|
||||
1. `name` is required, 1-64 chars, lowercase kebab-case, and must not contain `anthropic` or `claude`.
|
||||
2. `description` is required, 1-1024 chars.
|
||||
3. `x-personal-mcp.id` must exactly match `name`.
|
||||
4. Directory slug must exactly match `name`.
|
||||
|
||||
Capability invariants:
|
||||
|
||||
1. Skill capabilities must include `resource://skills/<skill-id>/document`.
|
||||
2. Prompt capabilities must include `resource://prompts/<prompt-id>/document`.
|
||||
|
||||
Repository contract decisions:
|
||||
|
||||
1. Treat `name` and `description` as required in all `SKILL.md` files.
|
||||
2. Keep only validated standard fields at top level.
|
||||
3. Keep MCP indexing metadata in a namespaced extension block.
|
||||
4. Reject unsupported optional top-level fields until explicit model support is added.
|
||||
|
||||
Reference specs:
|
||||
|
||||
1. MCP prompts data types: [Prompts](https://modelcontextprotocol.io/specification/latest/server/prompts)
|
||||
2. MCP schema reference for `Prompt` and `PromptArgument`: [Schema](https://modelcontextprotocol.io/specification/latest/schema)
|
||||
|
||||
## Canonical Frontmatter Schema
|
||||
|
||||
Use this two-layer pattern:
|
||||
|
||||
1. Anthropic layer: top-level fields intended for Anthropic and Agent Skills behavior.
|
||||
2. Repository layer: one namespaced block, `x-personal-mcp`, for MCP catalog and routing metadata.
|
||||
|
||||
Canonical shape:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: <skill-id>
|
||||
description: <what this skill does and when to use it>
|
||||
|
||||
# Repository-specific metadata
|
||||
x-personal-mcp:
|
||||
id: <skill-id>
|
||||
version: <semver>
|
||||
tags:
|
||||
- <tag>
|
||||
capabilities:
|
||||
- resource://skills/<skill-id>/document
|
||||
# Optional: overrides and nested references only.
|
||||
# Top-level references/*.md are auto-discovered.
|
||||
references:
|
||||
<ref-id>:
|
||||
path: references/<file>.md
|
||||
mime_type: text/markdown
|
||||
title: <short title>
|
||||
---
|
||||
```
|
||||
|
||||
## Repository Metadata Field Rules
|
||||
|
||||
Rules for `x-personal-mcp`:
|
||||
|
||||
1. `id` is required, must follow the skill id rules from the content contract, and must equal the directory name.
|
||||
2. `version` is required and must be a semantic version string.
|
||||
3. `tags` is optional and should be a list of kebab-case discovery labels.
|
||||
4. `capabilities` is required and lists the MCP URIs the skill publishes.
|
||||
5. `references` is an optional map keyed by `ref-id` for overrides and nested entries.
|
||||
|
||||
Prompt-specific additions:
|
||||
|
||||
1. `arguments` is an optional map keyed by argument name.
|
||||
2. Each argument supports optional `title`, optional `description`, and optional `required`.
|
||||
3. This aligns with MCP `PromptArgument` shape (`name`, optional `title`, optional `description`, optional `required`) where `name` is represented by the map key.
|
||||
4. Prompt `capabilities` must include `resource://prompts/<prompt-id>/document`.
|
||||
|
||||
Example prompt frontmatter:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: initial-test-structure
|
||||
description: Generate a baseline pytest test layout for a target scope.
|
||||
x-personal-mcp:
|
||||
id: initial-test-structure
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- pytest
|
||||
- testing
|
||||
capabilities:
|
||||
- resource://prompts/initial-test-structure/document
|
||||
arguments:
|
||||
target_scope:
|
||||
title: Target scope
|
||||
description: Target package or module under test.
|
||||
required: true
|
||||
---
|
||||
```
|
||||
|
||||
Reference entry rules:
|
||||
|
||||
1. `ref-id` is lowercase kebab-case.
|
||||
2. `path` is a skill-relative markdown path and must stay inside the same skill directory.
|
||||
3. Top-level files under `references/*.md` are auto-discovered with `ref-id` derived from a normalized filename stem (lowercase kebab-case).
|
||||
4. Nested folders under `references/` are not auto-discovered and must be declared explicitly.
|
||||
5. `mime_type` defaults to `text/markdown` when omitted.
|
||||
6. `title` is an optional display label.
|
||||
7. Renaming `ref-id` values is allowed when needed; optional aliases may be used during transitions.
|
||||
|
||||
## Auto-Generated Reference IDs
|
||||
|
||||
Top-level markdown files directly under `references/` are auto-registered as MCP references even when `x-personal-mcp.references` is empty.
|
||||
|
||||
How `ref-id` is derived:
|
||||
|
||||
1. Start from the filename stem (without `.md`).
|
||||
2. Normalize to lowercase kebab-case.
|
||||
3. Publish at `resource://skills/<skill-id>/references/<ref-id>`.
|
||||
|
||||
Examples:
|
||||
|
||||
1. `references/ruff-docs.md` -> `ref-id: ruff-docs`
|
||||
2. `references/Ruff Integrations.md` -> `ref-id: ruff-integrations`
|
||||
3. `references/python_logging_docs.md` -> `ref-id: python-logging-docs`
|
||||
|
||||
When to use explicit `x-personal-mcp.references` entries:
|
||||
|
||||
1. The file is nested, for example `references/guides/ci.md`.
|
||||
2. You need to override defaults (`title`, `mime_type`, or custom `ref-id`).
|
||||
3. You need compatibility aliases during a rename.
|
||||
|
||||
## Validation Models
|
||||
|
||||
The normative runtime model uses strict Pydantic v2 validation:
|
||||
|
||||
1. Models are immutable (`frozen=True`) and reject unknown fields (`extra="forbid"`).
|
||||
2. `SkillFrontmatter` accepts only `name`, `description`, and `x-personal-mcp`.
|
||||
3. `PromptFrontmatter` accepts only `name`, `description`, and `x-personal-mcp`.
|
||||
4. `PromptArgumentEntry` accepts only optional `title`, optional `description`, and optional `required`.
|
||||
5. Skill and prompt metadata enforce semver, kebab-case ids, capability requirements, and id/name/directory consistency.
|
||||
6. Reference paths are validated as markdown files under `references/`.
|
||||
|
||||
Validation behavior contract:
|
||||
|
||||
1. Validate required core fields and relationships during registry load before FastMCP resource or tool registration.
|
||||
2. Reject unknown or unsupported fields at parse and model-validation time.
|
||||
3. Treat hard contract violations, including missing required fields, invalid ids, and broken required mappings, as startup errors.
|
||||
4. Keep failure messages path-aware and field-specific for CI readability.
|
||||
|
||||
Projection mode contract for Anthropic API upload pipelines:
|
||||
|
||||
1. Parse with `SkillFrontmatter` first.
|
||||
2. Emit Anthropic-safe frontmatter with standard fields only.
|
||||
3. Preserve `x-personal-mcp` in source-of-truth documents; projection output is a build artifact.
|
||||
|
||||
## Anthropic Upload Compatibility Rule
|
||||
|
||||
1. Anthropic documentation guarantees behavior for standard frontmatter fields but does not explicitly guarantee handling of arbitrary unknown top-level keys.
|
||||
2. Publishing pipelines that target strict API compatibility should support a projection mode that emits only standard frontmatter fields for upload.
|
||||
3. Source-of-truth authoring remains in `x-personal-mcp`; upload payload shape is an explicit build concern.
|
||||
|
||||
## FastMCP Native Metadata Surfaces
|
||||
|
||||
Resources support native definition metadata:
|
||||
|
||||
1. `name`
|
||||
2. `description`
|
||||
3. `mime_type`
|
||||
4. `tags`
|
||||
5. `annotations`, including `readOnlyHint` and `idempotentHint`
|
||||
6. `icons`
|
||||
7. `meta`
|
||||
8. `version`
|
||||
9. `enabled`, which is deprecated in FastMCP v3 in favor of server-level enable and disable controls
|
||||
|
||||
Resources also support runtime metadata through `ResourceContent.meta` and `ResourceResult.meta`.
|
||||
|
||||
Tools support native definition metadata:
|
||||
|
||||
1. `name`
|
||||
2. `description`
|
||||
3. `tags`
|
||||
4. `annotations`, including `title`, `readOnlyHint`, `destructiveHint`, `idempotentHint`, and `openWorldHint`
|
||||
5. `icons`
|
||||
6. `meta`
|
||||
7. `version`
|
||||
8. `timeout`
|
||||
9. `output_schema`
|
||||
10. `run_in_thread`
|
||||
11. `enabled`, which is deprecated in FastMCP v3 in favor of server-level enable and disable controls
|
||||
|
||||
Tools also support runtime metadata through `ToolResult.meta`.
|
||||
|
||||
## Frontmatter To FastMCP Mapping Contract
|
||||
|
||||
At server startup, map `x-personal-mcp` into FastMCP registration as follows:
|
||||
|
||||
1. `x-personal-mcp.id` defines the canonical URI namespace and identity checks.
|
||||
2. `description` becomes the default description for the primary skill document resource.
|
||||
3. `x-personal-mcp.tags` maps to resource and tool tags.
|
||||
4. `x-personal-mcp.version` maps to resource and tool version metadata.
|
||||
5. `x-personal-mcp.capabilities` becomes the registered URI list and catalog exposure.
|
||||
6. `x-personal-mcp.references[*]` becomes resource templates or concrete resources with `mime_type`, read-only annotations, and `meta` that includes `skill_id`, `ref_id`, and source `path`.
|
||||
|
||||
## Invariants
|
||||
|
||||
This contract guarantees:
|
||||
|
||||
1. Anthropic-required frontmatter stays valid for custom skill upload and Claude Code loading.
|
||||
2. MCP-specific metadata remains embedded in `SKILL.md` frontmatter, with no `metadata.yaml` sidecar.
|
||||
3. FastMCP registration uses native metadata fields for resources and tools.
|
||||
4. Reference ids and metadata can evolve with low-friction updates while internal file layout under `references/` stays refactor-friendly.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
This contract does not define:
|
||||
|
||||
1. URI versioning and deprecation rollout policy details.
|
||||
2. Migration script design from existing `metadata.yaml` files.
|
||||
3. Runtime caching and indexing performance tuning.
|
||||
@@ -1,75 +0,0 @@
|
||||
---
|
||||
icon: lucide/messages-square
|
||||
---
|
||||
|
||||
# Prompt Contract
|
||||
|
||||
This page defines the canonical contract for prompts in the docs-first MCP architecture.
|
||||
|
||||
## Canonical Prompt Shape
|
||||
|
||||
Each prompt is one directory under `docs/prompts/`:
|
||||
|
||||
```mermaid
|
||||
---
|
||||
config:
|
||||
treeView:
|
||||
rowIndent: 20
|
||||
lineThickness: 2
|
||||
themeVariables:
|
||||
treeView:
|
||||
labelColor: '#FFFFFF'
|
||||
lineColor: '#FFFFFF'
|
||||
---
|
||||
treeView-beta
|
||||
"docs/"
|
||||
"... (other docs)"
|
||||
"prompts/"
|
||||
"<prompt-id>/"
|
||||
"PROMPT.md"
|
||||
"references/"
|
||||
"... (one or more markdown files, optional nested folders)"
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
1. `PROMPT.md` is required for every prompt.
|
||||
2. `references/` is the only place for prompt-specific supporting docs.
|
||||
3. Nested folders inside `references/` are allowed so a prompt can reorganize internals without changing global architecture.
|
||||
4. Prompt directories are independent ownership boundaries; no cross-prompt file writes.
|
||||
|
||||
## Metadata Location Constraint
|
||||
|
||||
1. Prompt metadata is embedded in YAML frontmatter in `PROMPT.md`.
|
||||
2. No `metadata.yaml` sidecar exists in the end state.
|
||||
3. Reference lookup metadata is documented and explicit: top-level `references/*.md` are auto-discovered from filenames, while `PROMPT.md` frontmatter declares overrides and nested mappings when needed.
|
||||
|
||||
## Prompt Id Contract
|
||||
|
||||
`prompt-id` is the public identifier and should satisfy all rules below:
|
||||
|
||||
1. Format: lowercase kebab-case only.
|
||||
2. Character set: `a-z`, `0-9`, and `-`.
|
||||
3. Must start with a letter.
|
||||
4. No underscores, spaces, dots, or uppercase characters.
|
||||
5. Directory name should equal `prompt-id` in each committed revision.
|
||||
6. Frontmatter `id` should equal directory name in each committed revision.
|
||||
7. Treat `prompt-id` as immutable after release; any rename is a breaking replacement and clients must move to the new id.
|
||||
|
||||
Valid examples:
|
||||
|
||||
1. `pytest-fill-scaffold`
|
||||
2. `review-pr-comments`
|
||||
3. `scaffold-fastapi-service`
|
||||
|
||||
Invalid examples:
|
||||
|
||||
1. `fill_pytest_scaffold`
|
||||
2. `Prompt-Template`
|
||||
3. `docs.prompt`
|
||||
|
||||
## Direct Documentation Inclusion
|
||||
|
||||
1. For direct API documentation, use mkdocstrings directives rather than pasting large code blocks.
|
||||
2. Keep manually-authored code examples short and task-focused; large implementation excerpts are out of scope for this contract.
|
||||
|
||||
@@ -1,186 +0,0 @@
|
||||
---
|
||||
icon: lucide/link
|
||||
---
|
||||
|
||||
# URI Contract
|
||||
|
||||
This page defines the canonical resource URI contract, template parameter rules, and compatibility policy.
|
||||
|
||||
Conventions in this document follow [MCP resource semantics](https://modelcontextprotocol.io/docs/learn/server-concepts#resources), [URI generic syntax (RFC3986)](https://www.rfc-editor.org/rfc/rfc3986), and [URI templates (RFC6570)](https://www.rfc-editor.org/rfc/rfc6570).
|
||||
|
||||
## Canonical URI Surface
|
||||
|
||||
The public, preferred direct resource URIs are:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills/{skill_id}`
|
||||
3. `resource://skills/{skill_id}/document`
|
||||
4. `resource://skills/{skill_id}/references/{ref_id}`
|
||||
5. `resource://docs/{path*}`
|
||||
6. `resource://catalog/prompts_index`
|
||||
7. `resource://catalog/prompts/{prompt_id}`
|
||||
8. `resource://prompts/{prompt_id}/document`
|
||||
|
||||
The public, preferred resource template URIs are:
|
||||
|
||||
1. `resource://catalog/skills_index{?q,tag,capability,cursor,limit}`
|
||||
2. `resource://catalog/prompts_index{?q,tag,cursor,limit}`
|
||||
|
||||
Contract intent:
|
||||
|
||||
1. Catalog URIs are discovery surfaces.
|
||||
2. Skill URIs are the primary per-skill guidance surfaces.
|
||||
3. Catalog query templates are additive discovery helpers for filtering and pagination.
|
||||
4. The docs wildcard URI is a direct authored-markdown access surface under `docs/`.
|
||||
|
||||
Best-practice alignment:
|
||||
|
||||
1. Resource identifiers are stable and noun-oriented.
|
||||
2. Dynamic lookup variants are represented as RFC6570 templates.
|
||||
3. Resources remain read-oriented and are described with explicit MIME types.
|
||||
|
||||
## URI Semantics
|
||||
|
||||
### `resource://catalog/skills_index`
|
||||
|
||||
1. Returns a compact list of skill records for discovery.
|
||||
2. Contains one entry per `skill_id`.
|
||||
3. Includes enough metadata for client-side selection, at minimum `id`, `name`, `description`, `tags`, and `capabilities`.
|
||||
|
||||
### `resource://catalog/skills/{skill_id}`
|
||||
|
||||
1. Returns one normalized record for `skill_id`.
|
||||
2. Includes the canonical document URI and declared reference ids.
|
||||
3. Returns not found when `skill_id` does not exist.
|
||||
|
||||
### `resource://skills/{skill_id}/document`
|
||||
|
||||
1. Returns the canonical `SKILL.md` authored content for that skill.
|
||||
2. `skill_id` must satisfy the stable skill id rules from the content contract.
|
||||
|
||||
### `resource://skills/{skill_id}/references/{ref_id}`
|
||||
|
||||
1. Returns one reference document declared in the skill frontmatter references manifest.
|
||||
2. `ref_id` is the stable public handle for that reference document.
|
||||
|
||||
### `resource://docs/{path*}`
|
||||
|
||||
1. Returns authored markdown at a normalized relative path under `docs/`.
|
||||
2. Supports nested paths via [RFC6570 wildcard expansion](https://www.rfc-editor.org/rfc/rfc6570).
|
||||
3. Typical examples include `index.md`, `usage.md`, `skills/<skill-id>/SKILL.md`, and `skills/<skill-id>/references/<file>.md`.
|
||||
|
||||
### `resource://catalog/prompts_index`
|
||||
|
||||
1. Returns a compact list of prompt records for discovery.
|
||||
2. Contains one entry per `prompt_id`.
|
||||
3. Includes `id`, `name`, `description`, `tags`, `version`, and canonical document URI.
|
||||
|
||||
### `resource://catalog/skills_index{?q,tag,capability,cursor,limit}`
|
||||
|
||||
1. Returns the same record family as `resource://catalog/skills_index` with optional filtering and pagination.
|
||||
2. Query parameters are optional and composable.
|
||||
3. Unknown query keys are ignored or rejected deterministically by server policy.
|
||||
|
||||
### `resource://catalog/prompts_index{?q,tag,cursor,limit}`
|
||||
|
||||
1. Returns the same record family as `resource://catalog/prompts_index` with optional filtering and pagination.
|
||||
2. Query parameters are optional and composable.
|
||||
3. Unknown query keys are ignored or rejected deterministically by server policy.
|
||||
|
||||
### `resource://catalog/prompts/{prompt_id}`
|
||||
|
||||
1. Returns one normalized record for `prompt_id`.
|
||||
2. Includes prompt argument metadata when declared in frontmatter.
|
||||
3. Returns not found when `prompt_id` does not exist.
|
||||
|
||||
### `resource://prompts/{prompt_id}/document`
|
||||
|
||||
1. Returns the canonical prompt markdown document.
|
||||
2. `prompt_id` must satisfy lowercase kebab-case rules.
|
||||
|
||||
## Template Parameter And Validation Rules
|
||||
|
||||
### `skill_id`
|
||||
|
||||
1. Lowercase kebab-case.
|
||||
2. Must satisfy the stable skill id rules from the content contract.
|
||||
|
||||
### `ref_id`
|
||||
|
||||
1. Lowercase kebab-case.
|
||||
2. Must be declared in the skill's references manifest.
|
||||
|
||||
### `path*`
|
||||
|
||||
1. Relative POSIX path only, expressed as URI path segments under [RFC3986 path syntax](https://www.rfc-editor.org/rfc/rfc3986#section-3.3).
|
||||
2. No leading slash.
|
||||
3. No `..` traversal segments.
|
||||
4. Resolves only inside `docs/`.
|
||||
5. Markdown-only in the end state, meaning `.md` files.
|
||||
6. Any reserved URI characters in path segments must be [percent-encoded](https://www.rfc-editor.org/rfc/rfc3986#section-2.1).
|
||||
|
||||
### `prompt_id`
|
||||
|
||||
1. Lowercase kebab-case.
|
||||
2. Must be unique across prompt ids and must not collide with skill ids.
|
||||
|
||||
## URI Hygiene Rules
|
||||
|
||||
1. Use lowercase, human-readable path segments for stable discoverability.
|
||||
2. Keep identifiers immutable once public whenever practical.
|
||||
3. Keep template variables semantic (`skill_id`, `prompt_id`, `ref_id`, `path*`) and avoid overloading one variable for unrelated meanings.
|
||||
4. Do not include secrets, tokens, or user-identifying data in URI paths or query strings.
|
||||
5. Prefer additive query parameters for discovery over introducing parallel URI families, matching [MCP resource-template discovery patterns](https://modelcontextprotocol.io/docs/learn/server-concepts#resources).
|
||||
6. Return clear not-found semantics for unknown ids and invalid template resolution.
|
||||
|
||||
## URI Versioning Policy
|
||||
|
||||
Default rule:
|
||||
|
||||
1. Keep URIs unversioned by default.
|
||||
2. Allow URI and payload updates when they improve clarity or implementation simplicity.
|
||||
|
||||
Breaking-change rule:
|
||||
|
||||
1. Breaking changes use direct replacement of the canonical URI family.
|
||||
2. No compatibility aliases or dual URI families are maintained.
|
||||
|
||||
FastMCP version metadata usage:
|
||||
|
||||
1. Resource `version` metadata may be used for implementation and version discovery.
|
||||
2. URI readability and maintainability remain the primary contract.
|
||||
|
||||
## Reference Id Compatibility Policy
|
||||
|
||||
`ref_id` is the public identifier for a reference document, separate from file path.
|
||||
|
||||
Rules:
|
||||
|
||||
1. Prefer keeping `ref_id` stable when practical.
|
||||
2. File paths may change without URI churn as long as the mapped `ref_id` still resolves.
|
||||
3. If a reference is renamed, introduce a new `ref_id` and treat the old one as retired.
|
||||
4. Avoid reusing retired `ref_id` values for unrelated content.
|
||||
|
||||
## Invariants
|
||||
|
||||
This contract guarantees:
|
||||
|
||||
1. One canonical URI pattern per core capability surface.
|
||||
2. Fast, low-friction URI evolution through direct replacement of canonical URIs.
|
||||
3. A single canonical catalog URI family with no alias maintenance overhead.
|
||||
4. Reference mappings can evolve with minimal churn.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
This contract does not define:
|
||||
|
||||
1. Implementation-specific transform wiring details, such as `VersionFilter`, mounts, or provider composition.
|
||||
2. Migration script mechanics for auto-generating aliases.
|
||||
3. Authorization policy design for URI-level access control.
|
||||
|
||||
## Sources
|
||||
|
||||
1. [MCP Server Concepts: Resources](https://modelcontextprotocol.io/docs/learn/server-concepts#resources)
|
||||
2. [MCP Architecture Overview](https://modelcontextprotocol.io/docs/learn/architecture)
|
||||
3. [MCP Specification Repository](https://github.com/modelcontextprotocol/spec)
|
||||
4. [RFC6570 URI Template](https://www.rfc-editor.org/rfc/rfc6570)
|
||||
-204
@@ -1,204 +0,0 @@
|
||||
---
|
||||
icon: lucide/bot
|
||||
---
|
||||
|
||||
# Copilot MCP Mechanics
|
||||
|
||||
## Purpose
|
||||
|
||||
This page explains how the GitHub Copilot extension in VS Code behaves as an MCP client when connected to `personal-mcp`, including why tools can appear while resource attachment appears unavailable.
|
||||
|
||||
## Core Model
|
||||
|
||||
Copilot interacts with MCP servers through separate capability lanes:
|
||||
|
||||
1. tools (invoked by the model during execution)
|
||||
2. resources (attached as read-only context)
|
||||
3. prompts (server-provided prompt templates)
|
||||
|
||||
These lanes are related but independently gated in the client.
|
||||
|
||||
Reliable paths are:
|
||||
|
||||
1. attach MCP resources explicitly through `Add Context > MCP Resources` or `MCP: Browse Resources`
|
||||
2. let Copilot invoke MCP tools when the task and tool descriptions make that relevant
|
||||
3. invoke MCP prompts explicitly with `/server.prompt` when your server exposes them
|
||||
|
||||
## What Actually Happens In VS Code
|
||||
|
||||
### MCP server side
|
||||
|
||||
Your server can advertise resources and serve them correctly. In this project that includes catalog resources and skill document resources.
|
||||
|
||||
### Copilot session side
|
||||
|
||||
The chat surface exposes tools, resources, and prompts through different UI paths. In practice, you can encounter sessions where tool use is available but MCP resource attachment is not exposed in `Add Context`.
|
||||
|
||||
That is why you can sometimes see MCP tools before you see `Add Context > MCP Resources`.
|
||||
|
||||
## Why The Picker Sometimes Shows Only Tools
|
||||
|
||||
`MCP Resources...` in Add Context requires at least:
|
||||
|
||||
1. at least one connected MCP server advertises resource capability
|
||||
2. the current chat surface exposes MCP resource attachment
|
||||
|
||||
If the second condition is not met, resources can be available on the server while still being absent from the picker.
|
||||
|
||||
## Practical Workflow
|
||||
|
||||
Use this sequence to confirm behavior:
|
||||
|
||||
1. run `MCP: Browse Resources` and verify resources exist
|
||||
2. use `MCP: List Servers` to verify the server is enabled and running
|
||||
3. open Copilot Chat
|
||||
4. check `Add Context` for `MCP Resources...`
|
||||
5. if still missing, restart the server and reload VS Code window
|
||||
|
||||
## Recommended Usage Pattern
|
||||
|
||||
1. rely on canonical catalog resources for discovery (`skills_index`, then `skills/{skill_id}`)
|
||||
2. fetch only selected skill documents for context
|
||||
3. keep slash commands for deterministic fallback flows
|
||||
|
||||
When resource attachment is unavailable in the active session, use ResourcesAsTools first, then thin catalog discovery tools as parity fallback:
|
||||
|
||||
1. `list_resources`
|
||||
2. `read_resource`
|
||||
3. `search_patterns`
|
||||
4. `get_pattern_by_id`
|
||||
5. `get_skill_document_by_id`
|
||||
|
||||
Canonical naming policy:
|
||||
|
||||
1. Prefer the five canonical tool names above in prompts and instructions.
|
||||
2. For compatibility with clients that emit `catalog_*` naming, the server also exposes:
|
||||
- `catalog_search_patterns`
|
||||
- `catalog_get_pattern_by_id`
|
||||
- `catalog_get_skill_document_by_id`
|
||||
3. Canonical and compatibility alias tools return equivalent payloads for the same input.
|
||||
|
||||
The first two are generated from the canonical resource surface and should be preferred in tool-only clients.
|
||||
|
||||
These should stay read-only, minimal, and schema-aligned with catalog resources.
|
||||
|
||||
For very large tool catalogs, server operators can optionally enable tool search mode (`regex` or `bm25`) while keeping `list_resources` and `read_resource` pinned as always-visible fallback tools.
|
||||
|
||||
## What To Type In Copilot Chat
|
||||
|
||||
Use prompts that tell Copilot which MCP feature path to take.
|
||||
|
||||
### If `MCP Resources...` is available
|
||||
|
||||
Use the resource attachment UI first, then ask Copilot to work from the attached material.
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
I attached the catalog resources and the FastAPI async SQLAlchemy modernization skill document. Use that context to propose a migration plan for this repo.
|
||||
```
|
||||
|
||||
If you want to keep the attachment sequence explicit, use:
|
||||
|
||||
```text
|
||||
I attached personal-mcp catalog resources first. Use them to identify the best matching skill, then work only from the selected skill document.
|
||||
```
|
||||
|
||||
### If only tools are available
|
||||
|
||||
Ask Copilot to explicitly use resource-backed tools first.
|
||||
|
||||
Example resource-backed prompt:
|
||||
|
||||
```text
|
||||
Use personal-mcp tool fallback by first calling list_resources, then read_resource for resource://catalog/skills_index and the selected resource://skills/<skill-id>/document URI. Use only that loaded skill context in your answer.
|
||||
```
|
||||
|
||||
If needed, use the thin catalog tools.
|
||||
|
||||
Example discovery prompt:
|
||||
|
||||
```text
|
||||
Use the personal-mcp catalog tools to search for the most relevant skill for FastAPI async SQLAlchemy modernization. Then load the selected skill document and use it as context for your answer.
|
||||
```
|
||||
|
||||
Example direct-load prompt:
|
||||
|
||||
```text
|
||||
Call get_skill_document_by_id for async-fastapi-sqlmodel and use that document as the main context for this task.
|
||||
```
|
||||
|
||||
Example bounded-selection prompt:
|
||||
|
||||
```text
|
||||
Search personal-mcp skills for NiceGUI UI customization, select at most 2 strong matches, load the best skill document, and answer using only that material plus the workspace code.
|
||||
```
|
||||
|
||||
## Repo Instructions Example
|
||||
|
||||
Repo instructions are the best place to teach Copilot when MCP content is relevant and which path to prefer.
|
||||
|
||||
If you add a repo-level `copilot-instructions.md`, keep the rule simple: prefer catalog-first discovery, keep loaded skill context small, and fall back to tools when resource attachment is unavailable.
|
||||
|
||||
Instructions can strongly steer behavior, but they do not guarantee that VS Code will auto-attach MCP resources for a request. For reliable resource use, either attach resources explicitly or prompt Copilot to use the fallback tools.
|
||||
|
||||
Example:
|
||||
|
||||
```md
|
||||
# MCP Usage
|
||||
|
||||
When a task may benefit from personal-mcp skills, use this sequence:
|
||||
|
||||
1. Start with personal-mcp catalog discovery when the task appears to match documented implementation patterns.
|
||||
2. Prefer MCP resources when the chat surface exposes resource attachment.
|
||||
3. If MCP resource attachment is unavailable, use `list_resources`/`read_resource` first, then thin catalog tools if needed.
|
||||
4. Load only the most relevant skill document or at most 2 skill documents.
|
||||
5. Treat skill documents as guidance, then reconcile them with the actual repository code before making changes.
|
||||
|
||||
Preferred discovery order:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills/{skill_id}`
|
||||
3. `resource://skills/<skill-id>/document`
|
||||
4. `resource://skills/<skill-id>/references/<ref-id>` when needed
|
||||
|
||||
Tool fallback order:
|
||||
|
||||
1. `list_resources`
|
||||
2. `read_resource`
|
||||
3. `search_patterns`
|
||||
4. `get_pattern_by_id`
|
||||
5. `get_skill_document_by_id`
|
||||
|
||||
If confidence is low after catalog discovery, ask one clarifying question before loading more skill documents.
|
||||
```
|
||||
|
||||
That instruction style does two useful things:
|
||||
|
||||
1. it tells Copilot to prefer the MCP server when relevant without forcing it on every prompt
|
||||
2. it keeps context size bounded so skill loading does not become noisy or expensive
|
||||
|
||||
If you want stronger behavior, add one more line that names the MCP server directly:
|
||||
|
||||
```md
|
||||
Use the `personal-mcp` server for skill discovery whenever the task involves documented implementation patterns available from the catalog.
|
||||
```
|
||||
|
||||
## Known Gotcha
|
||||
|
||||
A successful `resources/list` response from the server does not guarantee the resource picker appears in every Copilot session type. UI availability is session-capability-dependent.
|
||||
|
||||
## Further Reading
|
||||
|
||||
### VS Code docs
|
||||
|
||||
1. [Add and manage MCP servers](https://code.visualstudio.com/docs/agent-customization/mcp-servers)
|
||||
2. [MCP configuration reference](https://code.visualstudio.com/docs/agents/reference/mcp-configuration)
|
||||
3. [Manage context for AI](https://code.visualstudio.com/docs/chat/copilot-chat-context)
|
||||
4. [AI features cheat sheet](https://code.visualstudio.com/docs/agents/reference/ai-features-cheat-sheet)
|
||||
|
||||
### Project docs
|
||||
|
||||
1. [Resource-First Pattern Module Architecture](./architecture.md)
|
||||
2. [Static Docs Hosting Pattern](./mcp_layout.md)
|
||||
3. [Skill Usage Mechanics](./usage.md)
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@@ -1,201 +0,0 @@
|
||||
---
|
||||
icon: lucide/server
|
||||
---
|
||||
|
||||
# Static Docs Hosting Pattern
|
||||
|
||||
## Purpose
|
||||
|
||||
This document describes the completed layout and runtime pattern used to host a pre-built static documentation site from the same FastAPI app process that runs the FastMCP server.
|
||||
|
||||
This design intentionally avoids runtime docs rendering and avoids a separate docs hosting service.
|
||||
|
||||
It also treats Markdown as the single source of truth for both MCP resources and published docs.
|
||||
|
||||
## Completed-State Layout
|
||||
|
||||
```mermaid
|
||||
---
|
||||
config:
|
||||
treeView:
|
||||
rowIndent: 40
|
||||
lineThickness: 2
|
||||
themeVariables:
|
||||
treeView:
|
||||
labelColor: '#FFFFFF'
|
||||
lineColor: '#FFFFFF'
|
||||
---
|
||||
treeView-beta
|
||||
"project-root"
|
||||
"pyproject.toml"
|
||||
"uv.lock"
|
||||
"zensical.toml"
|
||||
"docs"
|
||||
"index.md"
|
||||
"<project-docs>.md"
|
||||
"contracts"
|
||||
"index.md"
|
||||
"<contract-pages>.md"
|
||||
"mcp_layout.md"
|
||||
"prompts"
|
||||
"<prompt-id>"
|
||||
"PROMPT.md"
|
||||
"references"
|
||||
"skills"
|
||||
"<skill-id>"
|
||||
"SKILL.md"
|
||||
"references"
|
||||
"<reference>.md"
|
||||
"site"
|
||||
"static build output"
|
||||
"src"
|
||||
"personal_mcp"
|
||||
"__init__.py"
|
||||
"main.py"
|
||||
"mcp.py"
|
||||
"catalog"
|
||||
"<catalog-modules>.py"
|
||||
"registry"
|
||||
"<registry-modules>.py"
|
||||
"web"
|
||||
"<web-modules>.py"
|
||||
"skills"
|
||||
"<skills-modules>.py"
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
1. docs contains both project-authored pages and the canonical skill Markdown tree.
|
||||
2. site contains static build output only.
|
||||
3. docs/skills contains canonical skill Markdown and reference Markdown.
|
||||
4. docs/prompts contains canonical prompt Markdown used for prompt catalog and document surfaces.
|
||||
5. MCP resources and docs site read from the same Markdown sources.
|
||||
|
||||
## Runtime Composition
|
||||
|
||||
The runtime process serves two surfaces:
|
||||
|
||||
1. MCP protocol surface from FastMCP
|
||||
2. Static docs surface from FastAPI static mount
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[Docs Registry Loader] --> B[Validated In-Memory Registry]
|
||||
B --> C[FastMCP Resource Registration]
|
||||
C --> D[MCP Transport]
|
||||
C --> E[FastAPI Application]
|
||||
E --> F[Static Mount /docs]
|
||||
F --> G[Zensical site output directory]
|
||||
```
|
||||
|
||||
Runtime guarantees:
|
||||
|
||||
1. Docs registry load and validation happen before resource exposure.
|
||||
2. Duplicate resource and template registration fails startup (`on_duplicate="error"`).
|
||||
3. Resource registration is metadata-driven from SKILL frontmatter and reference manifests.
|
||||
4. Legacy per-skill Python servers and `metadata.yaml` sidecars are not part of the runtime.
|
||||
|
||||
## Build and Publish Flow
|
||||
|
||||
The docs flow is pre-build only.
|
||||
|
||||
1. Read authored docs pages and skill markdown sources.
|
||||
2. Build static site with Zensical into site.
|
||||
3. Start app and serve site directory as static files.
|
||||
|
||||
No runtime markdown conversion is required.
|
||||
|
||||
## Content Merge Pattern
|
||||
|
||||
The published docs site always contains both:
|
||||
|
||||
1. Project-authored docs pages
|
||||
2. Skill Markdown content from docs/skills/*/SKILL.md and references
|
||||
|
||||
This ensures the public docs reflect architectural guidance and the exact Markdown served by MCP.
|
||||
|
||||
## Markdown-to-Resource Mapping
|
||||
|
||||
MCP resources map directly to canonical Markdown documents.
|
||||
|
||||
Example mapping model:
|
||||
|
||||
1. docs/skills/<skill-id>/SKILL.md -> resource://skills/<skill_id>/document
|
||||
2. docs/skills/<skill-id>/references/<file>.md -> resource://skills/<skill_id>/references/<ref_id> (via frontmatter references manifest)
|
||||
3. docs/<path>.md -> resource://docs/{path*}
|
||||
|
||||
Catalog discovery resources are:
|
||||
|
||||
1. resource://catalog/skills_index
|
||||
2. resource://catalog/skills_index{?q,tag,capability,cursor,limit}
|
||||
3. resource://catalog/skills/{skill_id}
|
||||
4. resource://catalog/prompts_index
|
||||
5. resource://catalog/prompts_index{?q,tag,cursor,limit}
|
||||
6. resource://catalog/prompts/{prompt_id}
|
||||
|
||||
Registry-backed registration details:
|
||||
|
||||
1. `resource://skills/{skill_id}/document` resolves to each skill's SKILL.md.
|
||||
2. `resource://skills/{skill_id}/references/{ref_id}` resolves through frontmatter reference manifests.
|
||||
3. `resource://docs/{path*}` resolves normalized markdown paths under `docs/`.
|
||||
4. Resource metadata includes explicit mime type and read-only/idempotent annotations.
|
||||
|
||||
When clients cannot attach MCP resources directly, thin catalog tools may retrieve the same underlying skill documents indirectly. This does not create a second content source.
|
||||
|
||||
## URI Compatibility Policy
|
||||
|
||||
1. Canonical URIs are the only supported URIs in this runtime.
|
||||
2. No backward-compatibility aliases or dual registration paths are maintained.
|
||||
3. Contract changes should update clients to canonical URIs directly.
|
||||
|
||||
## Why This Pattern
|
||||
|
||||
### Operational Simplicity
|
||||
|
||||
One application process serves both protocol and static docs surfaces.
|
||||
|
||||
### Deterministic Docs
|
||||
|
||||
Published docs are immutable static assets for a given build.
|
||||
|
||||
### Documentation Fidelity
|
||||
|
||||
The docs site and MCP resources resolve from the same Markdown sources.
|
||||
|
||||
### Maintainer Experience
|
||||
|
||||
Authors continue to work in markdown while resource contracts remain machine-consumable.
|
||||
|
||||
## FastAPI Static Mount Expectations
|
||||
|
||||
The FastAPI app is expected to:
|
||||
|
||||
1. Mount static directory containing Zensical output.
|
||||
2. Serve index and asset files from that directory.
|
||||
3. Keep docs route stable across releases.
|
||||
|
||||
Recommended route conventions:
|
||||
|
||||
1. /docs for static site root
|
||||
2. /docs/* for static assets and page routes
|
||||
|
||||
## Update Lifecycle
|
||||
|
||||
For each documentation update:
|
||||
|
||||
1. Edit authored docs and skill markdown content.
|
||||
2. Rebuild static site.
|
||||
3. Restart runtime if needed.
|
||||
|
||||
This keeps docs publication explicit and predictable.
|
||||
|
||||
## Example Source Material
|
||||
|
||||
Existing reference docs remain valid content inputs in this pattern:
|
||||
|
||||
1. docs/skills/pytesting/references/pytest-docs.md
|
||||
2. docs/skills/python-logging/references/python-logging-docs.md
|
||||
3. docs/skills/python-logging/references/json-file-logging.md
|
||||
4. docs/skills/fastapi-uv-docker/references/fastapi-best-practices.md
|
||||
|
||||
These are source documents, not deployment artifacts.
|
||||
@@ -1,139 +0,0 @@
|
||||
---
|
||||
icon: lucide/shield-check
|
||||
---
|
||||
|
||||
# Securing Remote Access
|
||||
|
||||
## Context
|
||||
|
||||
This project exposes two related surfaces from the same runtime:
|
||||
|
||||
1. a static documentation site under `/docs`
|
||||
2. a Streamable HTTP MCP endpoint under `/mcp`
|
||||
|
||||
The same Markdown content backs both surfaces. For the current project shape, the MCP server is resource-first and primarily exposes public skill and documentation text. It is not intended to expose secrets, private data, shell access, filesystem access, or tools with side effects.
|
||||
|
||||
The expected deployment path is:
|
||||
|
||||
```text
|
||||
Public internet
|
||||
-> Cloudflare Tunnel
|
||||
-> Caddy
|
||||
-> personal-mcp container
|
||||
```
|
||||
|
||||
## Decision
|
||||
|
||||
For the current use case, heavy application-level authentication is not required.
|
||||
|
||||
The recommended posture is:
|
||||
|
||||
1. Keep the service behind Cloudflare Tunnel and Caddy.
|
||||
2. Do not expose the container port directly to the public internet.
|
||||
3. Treat everything exposed through MCP as publishable public documentation.
|
||||
4. Add stronger authentication only if the MCP surface later includes sensitive content or tools with meaningful side effects.
|
||||
|
||||
This keeps the deployment simple while preserving a clear upgrade path.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
### Leaving `/mcp` Public
|
||||
|
||||
This is acceptable if `/mcp` exposes only the same public Markdown already available through `/docs`.
|
||||
|
||||
Benefits:
|
||||
|
||||
1. lowest operational friction
|
||||
2. fewer compatibility issues with MCP clients
|
||||
3. no need to implement OAuth, mTLS, JWT validation, or custom auth middleware
|
||||
4. consistent with the project assumption that documentation content is public
|
||||
|
||||
Risks:
|
||||
|
||||
1. random scraping, probing, or fuzzing of a machine endpoint
|
||||
2. possible bandwidth or CPU nuisance traffic
|
||||
3. accidental future exposure if new tools or private resources are added
|
||||
4. less control over who can use the MCP endpoint
|
||||
|
||||
### Protecting `/mcp` With Cloudflare Access
|
||||
|
||||
Cloudflare Access can add a lightweight gate using GitHub, Google, one-time PIN, or service tokens.
|
||||
|
||||
Benefits:
|
||||
|
||||
1. reduces random internet traffic
|
||||
2. requires little app code
|
||||
3. works well for a small trusted team
|
||||
4. provides logs and centralized access control
|
||||
|
||||
Costs:
|
||||
|
||||
1. browser-based login may not work with all MCP clients
|
||||
2. non-browser MCP clients may need Cloudflare Access service tokens
|
||||
3. adds operational configuration for a low-sensitivity endpoint
|
||||
|
||||
### Using mTLS
|
||||
|
||||
mTLS is useful when both client and server environments are tightly controlled.
|
||||
|
||||
Benefits:
|
||||
|
||||
1. strong client identity
|
||||
2. good fit for service-to-service or private infrastructure
|
||||
3. can be used between Cloudflare, Caddy, and the backend if desired
|
||||
|
||||
Costs:
|
||||
|
||||
1. harder certificate provisioning and rotation
|
||||
2. weaker compatibility with normal MCP clients
|
||||
3. unnecessary for public documentation-only content
|
||||
|
||||
For this project, mTLS is not the primary recommendation.
|
||||
|
||||
## Practical Recommendation
|
||||
|
||||
Use a simple public-docs posture unless the endpoint changes.
|
||||
|
||||
Recommended current setup:
|
||||
|
||||
```text
|
||||
/docs public
|
||||
/mcp public or lightly protected
|
||||
```
|
||||
|
||||
If `/mcp` remains public, add only basic operational safeguards:
|
||||
|
||||
1. keep Cloudflare Tunnel and Caddy in front
|
||||
2. avoid publishing `8765` directly
|
||||
3. enable Cloudflare or Caddy rate limiting if traffic becomes noisy
|
||||
4. monitor logs for unusual request volume
|
||||
5. document that MCP resources must remain safe to publish
|
||||
|
||||
A slightly stricter setup is also reasonable:
|
||||
|
||||
```text
|
||||
/docs public
|
||||
/mcp Cloudflare Access or service token
|
||||
```
|
||||
|
||||
This is the best option if the team wants to reduce drive-by MCP traffic without adding auth code to the application.
|
||||
|
||||
## Upgrade Trigger
|
||||
|
||||
Add real authentication before introducing any MCP capability that can:
|
||||
|
||||
1. read non-public files
|
||||
2. access private notes or credentials
|
||||
3. call upstream APIs
|
||||
4. mutate data
|
||||
5. run commands
|
||||
6. expose environment details
|
||||
7. perform expensive computation
|
||||
|
||||
At that point, prefer edge-level authentication first, such as Cloudflare Access, and consider proper OAuth 2.1 resource-server behavior only if broad public MCP client interoperability becomes a goal.
|
||||
|
||||
## Security Invariant
|
||||
|
||||
Everything exposed by the MCP server must be safe to publish publicly.
|
||||
|
||||
If that invariant stops being true, `/mcp` should be protected before the new capability is deployed.
|
||||
@@ -1,157 +0,0 @@
|
||||
---
|
||||
name: nicegui
|
||||
description: 'Reference hub for NiceGUI and FastAPI application structure, typed configuration, ASGI and Uvicorn startup, UI composition, styling, bindable state, interactions, troubleshooting, testing, and source documentation. Use when planning, implementing, reviewing, deploying, or debugging NiceGUI applications; load only the references relevant to the task.'
|
||||
x-personal-mcp:
|
||||
id: nicegui
|
||||
version: 2.5.0
|
||||
tags:
|
||||
- nicegui
|
||||
- fastapi
|
||||
- asgi
|
||||
- uvicorn
|
||||
- pydantic-settings
|
||||
- configuration
|
||||
- deployment
|
||||
- ui
|
||||
- architecture
|
||||
- scaffolding
|
||||
- customization
|
||||
- frontend
|
||||
- testing
|
||||
- source-docs
|
||||
capabilities:
|
||||
- resource://skills/nicegui/document
|
||||
---
|
||||
|
||||
# NiceGUI Reference
|
||||
|
||||
Use this skill as a progressive reference for NiceGUI applications built with FastAPI. Start with the routing map, load only the material needed for the current question, and reconcile it with the target project's NiceGUI version and established conventions.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Planning or reviewing NiceGUI application structure and FastAPI composition.
|
||||
- Building or refactoring pages, components, layouts, and static assets.
|
||||
- Modeling UI state with bindings or bindable dataclasses.
|
||||
- Implementing forms, uploads, refreshes, live updates, or background work.
|
||||
- Diagnosing UI state, concurrency, navigation, or asset problems.
|
||||
- Verifying framework behavior against primary documentation.
|
||||
|
||||
## How to Use This Skill
|
||||
|
||||
1. Classify the request using the discovery map below.
|
||||
2. Load the smallest relevant reference, or at most two references for a mixed concern.
|
||||
3. Inspect the target repository before applying guidance; preserve its sound local patterns.
|
||||
4. Check the pinned NiceGUI and integration versions before relying on version-specific APIs.
|
||||
5. Validate the changed behavior with focused tests and, for UI work, relevant viewport checks.
|
||||
|
||||
## Progressive Discovery Map
|
||||
|
||||
### Application Architecture
|
||||
|
||||
Load [application architecture](./references/architecture.md) for:
|
||||
|
||||
- FastAPI app factories and lifespan ownership
|
||||
- package boundaries and dependency direction
|
||||
- page registration and health routes
|
||||
- optional persistence, LangGraph, or mounted documentation
|
||||
- async responsiveness and baseline tests
|
||||
|
||||
### FastAPI And Uvicorn Startup
|
||||
|
||||
Load [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) for:
|
||||
|
||||
- choosing between `ui.run()` and `ui.run_with()`
|
||||
- understanding the parent FastAPI app and NiceGUI's internal app
|
||||
- composing ASGI lifespan and mounted routes
|
||||
- loading one typed settings snapshot for server and application configuration
|
||||
- serving an app instance or factory with Uvicorn
|
||||
- exposing programmatic startup through `[project.scripts]`
|
||||
- reload, worker, and process-local state constraints
|
||||
|
||||
### Components And Styling
|
||||
|
||||
Load [architecture and styling](./references/architecture-and-styling.md) for:
|
||||
|
||||
- page, component, and service boundaries
|
||||
- component extraction decisions
|
||||
- Quasar props, Tailwind utilities, and custom CSS boundaries
|
||||
- responsive layout and static asset conventions
|
||||
- Tailwind and Quasar breakpoint scales, container queries, and responsive testing
|
||||
- uniformly scaling dialogs on mobile
|
||||
- preserving Quasar field proportions
|
||||
- keeping detached `QSelect` menus anchored
|
||||
- sizing scrollable dialog cards under CSS `zoom`
|
||||
- validating zoomed controls with Playwright or a browser
|
||||
|
||||
### Bindable State
|
||||
|
||||
Load [bindable dataclasses](./references/binding-dataclasses.md) for:
|
||||
|
||||
- typed local UI state
|
||||
- propagation and refresh behavior
|
||||
- nested structures and strict bindings
|
||||
- mutable defaults, performance, and version notes
|
||||
|
||||
### Interaction Patterns
|
||||
|
||||
Load [interaction patterns](./references/interaction-patterns.md) for:
|
||||
|
||||
- uploads and form submission
|
||||
- explicit refreshes
|
||||
- server-sent events and WebSockets
|
||||
- background work and duplicate-submission guards
|
||||
|
||||
### Troubleshooting And Quality
|
||||
|
||||
Load [troubleshooting and quality gates](./references/troubleshooting-and-quality-gates.md) for:
|
||||
|
||||
- upload failures and UI race conditions
|
||||
- stale assets and navigation drift
|
||||
- responsiveness, accessibility, reliability, and maintainability checks
|
||||
|
||||
### Primary Sources
|
||||
|
||||
Load [source documentation](./references/source-documentation.md) when:
|
||||
|
||||
- behavior is version-sensitive or uncertain
|
||||
- an integration recommendation needs verification
|
||||
- upstream NiceGUI, FastAPI, Tailwind, Quasar, SQLAlchemy, Pydantic, or LangGraph documentation is required
|
||||
|
||||
## Common Discovery Paths
|
||||
|
||||
### New Application Or Architecture Review
|
||||
|
||||
1. Load [application architecture](./references/architecture.md).
|
||||
2. Add [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) when FastAPI owns the application or startup must be exposed as a project command.
|
||||
3. Add [architecture and styling](./references/architecture-and-styling.md) only when page and component design is in scope.
|
||||
|
||||
### Page Or Component Work
|
||||
|
||||
1. Load [architecture and styling](./references/architecture-and-styling.md).
|
||||
2. Add [interaction patterns](./references/interaction-patterns.md) or [bindable dataclasses](./references/binding-dataclasses.md) according to the page behavior.
|
||||
|
||||
### Debugging Or Production Review
|
||||
|
||||
1. Start with [troubleshooting and quality gates](./references/troubleshooting-and-quality-gates.md).
|
||||
2. Follow the symptom to one detailed reference.
|
||||
3. Confirm uncertain behavior in [source documentation](./references/source-documentation.md).
|
||||
|
||||
## General Defaults
|
||||
|
||||
- Keep composition, transport, services, pages, and components directionally separated.
|
||||
- Keep business logic out of UI components and event handlers.
|
||||
- Avoid blocking I/O and CPU-heavy work in the UI event loop.
|
||||
- Prefer event-driven updates and explicit refreshes over unrelated polling.
|
||||
- Prefer Tailwind utilities, then Quasar props, then reusable component helpers; use minimal shared CSS when those are insufficient.
|
||||
- Provide loading, success, and failure states for user-triggered work.
|
||||
- Treat version-specific guidance as a prompt to verify the project's dependency version.
|
||||
|
||||
## Reference Use Contract
|
||||
|
||||
When applying this skill:
|
||||
|
||||
- return only guidance relevant to the current task
|
||||
- distinguish repository facts from reference recommendations
|
||||
- cite the appropriate source reference for framework-level claims
|
||||
- state assumptions when application requirements are missing
|
||||
- report the focused checks used to validate implementation changes
|
||||
@@ -1,289 +0,0 @@
|
||||
# NiceGUI Page Layout And Styling
|
||||
|
||||
Use this reference to structure NiceGUI pages, choose component boundaries, apply responsive layout, and introduce custom CSS without fighting Quasar's internal geometry.
|
||||
|
||||
## Ownership And Dependency Boundaries
|
||||
|
||||
Keep dependencies flowing in one direction:
|
||||
|
||||
- pages import components and services
|
||||
- components contain presentation logic only
|
||||
- services contain business logic and do not import UI
|
||||
- bootstrap code mounts static assets and loads shared CSS once
|
||||
|
||||
Suggested module split:
|
||||
|
||||
```text
|
||||
src/my_app/
|
||||
ui/
|
||||
pages/
|
||||
components/
|
||||
static/
|
||||
services/
|
||||
api/
|
||||
```
|
||||
|
||||
Page modules should compose a route from reusable presentation and service calls. They should not own domain rules, persistence, or long-running synchronous work.
|
||||
|
||||
## Page Composition
|
||||
|
||||
Build the outer layout before styling individual controls:
|
||||
|
||||
1. Define the page shell and width constraints.
|
||||
2. Establish responsive rows, columns, gaps, and wrapping.
|
||||
3. Add semantic sections and repeated components.
|
||||
4. Configure Quasar component appearance with props.
|
||||
5. Add custom CSS only for behavior that props and utilities cannot express safely.
|
||||
|
||||
```python
|
||||
with ui.column().classes("w-full max-w-6xl mx-auto gap-6 px-4"):
|
||||
page_header(title="Inventory")
|
||||
|
||||
with ui.row().classes("w-full gap-4 flex-wrap lg:flex-nowrap items-start"):
|
||||
filters_panel().classes("w-full lg:w-72 shrink-0")
|
||||
item_grid().classes("w-full flex-1 min-w-0")
|
||||
```
|
||||
|
||||
Use stable width, minimum-width, and flex constraints so labels, icons, validation messages, and loaded content do not shift the surrounding layout.
|
||||
|
||||
## Component Extraction
|
||||
|
||||
Extract a presentation pattern to `ui/components/` when it appears on two or more pages or when it owns a meaningful interaction boundary. Keep one-off route layout in the page module.
|
||||
|
||||
```python
|
||||
def card_section(title: str, content: str) -> ui.card:
|
||||
with ui.card().classes("w-full max-w-md") as card:
|
||||
ui.label(title).classes("text-lg font-bold")
|
||||
ui.label(content).classes("text-gray-600")
|
||||
return card
|
||||
```
|
||||
|
||||
Reusable components should accept data and event callbacks rather than import page state or business services implicitly.
|
||||
|
||||
## Styling Decision Order
|
||||
|
||||
NiceGUI wraps Quasar components. Choose the styling mechanism according to what it owns:
|
||||
|
||||
1. Use Quasar props for component appearance, density, labels, and popup behavior.
|
||||
2. Use NiceGUI `.classes()` and Tailwind utilities for width, spacing, alignment, and responsive layout.
|
||||
3. Use reusable component functions for repeated visual patterns.
|
||||
4. Use `.style()` for genuinely dynamic inline values.
|
||||
5. Use minimal shared CSS only when props and utilities are insufficient.
|
||||
|
||||
Common Quasar props include:
|
||||
|
||||
- `outlined`
|
||||
- `dense`
|
||||
- `stack-label`
|
||||
- `popup-content-class`
|
||||
- `input-class`
|
||||
- `input-style`
|
||||
|
||||
Avoid overriding internal selectors such as:
|
||||
|
||||
- `.q-field__label`
|
||||
- `.q-field__native`
|
||||
- `.q-field__control`
|
||||
- `.q-field__input`
|
||||
|
||||
Quasar coordinates field height, padding, labels, values, icons, and floating-label transforms. Changing only one internal part tends to cause clipping or overlap.
|
||||
|
||||
## Responsive Layout
|
||||
|
||||
Support these layouts only:
|
||||
|
||||
- mobile: a single-column layout with wrapping toolbars and full-width controls
|
||||
- landscape desktop: $1920 \times 1080$ with side-by-side panels where they improve scanning
|
||||
- portrait desktop: $1080 \times 1920 with stacked panels or a narrow fixed sidebar
|
||||
|
||||
Build the mobile layout first, then add one desktop breakpoint when a row or grid needs more space. Prefer flex wrapping and fluid grids before adding another breakpoint. Use Tailwind classes for page layout and Quasar props for component behavior.
|
||||
|
||||
```python
|
||||
with ui.row().classes('w-full flex-wrap gap-4 lg:flex-nowrap items-start'):
|
||||
filters_panel().classes('w-full lg:w-72 shrink-0')
|
||||
item_grid().classes('w-full flex-1 min-w-0')
|
||||
```
|
||||
|
||||
Use `min-w-0` for flexible children, `flex-wrap` for toolbars, and `max-w-* mx-auto` to keep portrait layouts readable. Do not add device-specific component trees, container queries, or custom breakpoints unless a supported layout demonstrates a concrete failure.
|
||||
|
||||
## Static Assets And Shared CSS
|
||||
|
||||
- Mount static assets from the composition layer.
|
||||
- Load shared CSS once rather than injecting it from individual pages.
|
||||
- Keep custom CSS tokenized with variables and scoped to application classes.
|
||||
- Avoid broad rules against Quasar internals.
|
||||
- Verify mount paths, reverse-proxy rewrites, and cache behavior.
|
||||
|
||||
```python
|
||||
from pathlib import Path
|
||||
|
||||
from fastapi.staticfiles import StaticFiles
|
||||
|
||||
STATIC_DIR = Path(__file__).parent / "ui" / "static"
|
||||
|
||||
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
|
||||
ui.add_css((STATIC_DIR / "css" / "base.css").read_text(encoding="utf-8"))
|
||||
```
|
||||
|
||||
## Responsive Dialog Pattern
|
||||
|
||||
Use whole-card scaling when a form dialog must become uniformly larger on mobile while preserving Quasar's internal proportions. Keep detached select menus unscaled and make the card itself scrollable.
|
||||
|
||||
### Use Normal Field Density
|
||||
|
||||
Normal Quasar fields are approximately `56px` high, while dense fields are approximately `40px` high. Remove `dense` when larger controls are needed.
|
||||
|
||||
```python
|
||||
ui.input("Name").props("outlined")
|
||||
ui.number("Quantity").props("outlined")
|
||||
ui.select(...).props(
|
||||
"outlined popup-content-class=app-item-detail-menu"
|
||||
)
|
||||
ui.textarea("Description").props("outlined autogrow")
|
||||
```
|
||||
|
||||
Add a scoped class to the dialog card:
|
||||
|
||||
```python
|
||||
ui.card().classes("app-detail-card app-item-detail-card")
|
||||
```
|
||||
|
||||
### Scale The Complete Card
|
||||
|
||||
```css
|
||||
:root {
|
||||
--item-dialog-scale: 1;
|
||||
--item-dialog-max-height: calc(100dvh - 3rem);
|
||||
}
|
||||
|
||||
.app-item-detail-card {
|
||||
width: min(50rem, 50vw);
|
||||
max-height: var(--item-dialog-max-height);
|
||||
overflow-y: auto;
|
||||
overscroll-behavior: contain;
|
||||
zoom: var(--item-dialog-scale);
|
||||
}
|
||||
|
||||
/* Restore Quasar's baseline if a global rule overrides it. */
|
||||
.app-item-detail-card .q-field,
|
||||
.app-item-detail-menu {
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
@media (max-width: 599px) {
|
||||
:root {
|
||||
--item-dialog-scale: 1.2;
|
||||
/* 75dvh becomes 90dvh after 1.2x zoom. */
|
||||
--item-dialog-max-height: 75dvh;
|
||||
}
|
||||
|
||||
.app-item-detail-card {
|
||||
width: 80vw;
|
||||
}
|
||||
|
||||
.app-item-detail-menu {
|
||||
font-size: 16.8px;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The main mobile tuning knob is:
|
||||
|
||||
```css
|
||||
--item-dialog-scale: 1.2;
|
||||
```
|
||||
|
||||
### Keep Detached Popups Unscaled
|
||||
|
||||
Do not apply `zoom` or `transform: scale()` to a `QSelect` popup menu. Quasar renders menus outside the dialog and positions them from the unscaled anchor geometry. Scaling the menu container afterward separates it from its field.
|
||||
|
||||
Avoid:
|
||||
|
||||
```css
|
||||
.app-item-detail-card,
|
||||
.app-item-detail-menu {
|
||||
zoom: 1.2;
|
||||
}
|
||||
```
|
||||
|
||||
Use:
|
||||
|
||||
```css
|
||||
.app-item-detail-card {
|
||||
zoom: 1.2;
|
||||
}
|
||||
|
||||
.app-item-detail-menu {
|
||||
font-size: 16.8px;
|
||||
}
|
||||
```
|
||||
|
||||
Use `popup-content-class=app-item-detail-menu` to target the detached menu and enlarge its text without changing its coordinate system.
|
||||
|
||||
### Account For Zoom When Scrolling
|
||||
|
||||
The card's pre-zoom maximum height must account for the scale:
|
||||
|
||||
\[
|
||||
\begin{aligned}
|
||||
h_{\mathrm{pre}} &= \frac{h_{\mathrm{visible}}}{s} \\
|
||||
\text{where } s &= \text{the zoom scale}
|
||||
\end{aligned}
|
||||
\]
|
||||
|
||||
For a desired visual height of `90dvh` at \(1.2\times\):
|
||||
|
||||
\[
|
||||
\frac{90\,\mathrm{dvh}}{1.2} = 75\,\mathrm{dvh}
|
||||
\]
|
||||
|
||||
Therefore:
|
||||
|
||||
```css
|
||||
--item-dialog-max-height: 75dvh;
|
||||
```
|
||||
|
||||
Apply scrolling to the card itself:
|
||||
|
||||
```css
|
||||
.app-item-detail-card {
|
||||
max-height: var(--item-dialog-max-height);
|
||||
overflow-y: auto;
|
||||
overscroll-behavior: contain;
|
||||
}
|
||||
```
|
||||
|
||||
This keeps the dimmed page stationary while the form scrolls.
|
||||
|
||||
### Match The Quasar Breakpoint
|
||||
|
||||
Quasar's extra-small breakpoint ends at `599.98px`. A mobile-only rule can use:
|
||||
|
||||
```css
|
||||
@media (max-width: 599px) {
|
||||
/* Mobile rules. */
|
||||
}
|
||||
```
|
||||
|
||||
Confirm custom breakpoint values against the target application's Quasar configuration.
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
Check each completed page at these three viewports:
|
||||
|
||||
1. A representative mobile viewport, such as $390 \times 844$.
|
||||
2. Landscape desktop at $1920 \times 1080$.
|
||||
3. Portrait desktop at $1080 \times 1920$.
|
||||
|
||||
Confirm that page sections do not overlap, toolbars wrap on mobile, desktop panels use the available space without becoming excessively wide, and dialogs remain visible and scroll to their final field.
|
||||
|
||||
## Sources
|
||||
|
||||
!!! info "Primary sources"
|
||||
- [NiceGUI element styling and props](https://nicegui.io/documentation/element)
|
||||
- [NiceGUI binding properties](https://nicegui.io/documentation/section_binding_properties)
|
||||
- [Quasar components](https://quasar.dev/vue-components)
|
||||
- [Quasar field](https://quasar.dev/vue-components/field/)
|
||||
- [Quasar select](https://quasar.dev/vue-components/select/)
|
||||
- [Tailwind responsive design](https://tailwindcss.com/docs/responsive-design)
|
||||
- [MDN `zoom`](https://developer.mozilla.org/en-US/docs/Web/CSS/zoom)
|
||||
@@ -1,137 +0,0 @@
|
||||
# NiceGUI Application Architecture
|
||||
|
||||
Load this reference for application composition, package boundaries, and optional subsystem decisions.
|
||||
|
||||
## Baseline Package Boundaries
|
||||
|
||||
- `main.py`: process entry point and app factory exposure.
|
||||
- `bootstrap.py`: app composition, router wiring, page registration, and lifespan orchestration.
|
||||
- `config.py`: typed settings and environment parsing.
|
||||
- `logging.py`: centralized logging setup.
|
||||
- `api/`: HTTP transport that delegates to services.
|
||||
- `services/`: business and use-case logic.
|
||||
- `ui/pages/`: route-level NiceGUI pages.
|
||||
- `ui/components/`: shared presentation building blocks.
|
||||
|
||||
Recommended base shape:
|
||||
|
||||
```text
|
||||
.
|
||||
├─ pyproject.toml
|
||||
├─ .env.example
|
||||
├─ src/
|
||||
│ └─ app/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ main.py
|
||||
│ ├─ bootstrap.py
|
||||
│ ├─ config.py
|
||||
│ ├─ logging.py
|
||||
│ ├─ api/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ health.py
|
||||
│ ├─ services/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ example_service.py
|
||||
│ └─ ui/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ components/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ nav.py
|
||||
│ └─ pages/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ home.py
|
||||
│ ├─ dashboard.py
|
||||
│ └─ about.py
|
||||
└─ tests/
|
||||
├─ test_health.py
|
||||
└─ test_pages_registration.py
|
||||
```
|
||||
|
||||
## Required Baseline Behavior
|
||||
|
||||
- FastAPI is the base ASGI app.
|
||||
- `create_app()` composes routes, resources, and NiceGUI.
|
||||
- Lifespan owns startup and shutdown resources.
|
||||
- NiceGUI pages are modular and explicitly registered.
|
||||
- FastAPI exposes a health route such as `/healthz`.
|
||||
- Imports do not trigger runtime global side effects.
|
||||
|
||||
For the ownership relationship between a caller-created FastAPI app, `nicegui.app`, `ui.run_with()`, Uvicorn, and a packaged startup command, load [FastAPI and Uvicorn startup](./fastapi-uvicorn-startup.md).
|
||||
|
||||
## Dependency Direction
|
||||
|
||||
Prefer:
|
||||
|
||||
- `main/bootstrap` -> `config/logging` + `api` + `ui/pages` + `services`
|
||||
- `api` -> `services`
|
||||
- `ui/pages` -> `ui/components` + `services`
|
||||
- `services` -> helpers, clients, and `db/` when enabled
|
||||
|
||||
Avoid imports from services back into API or UI modules.
|
||||
|
||||
## Optional Persistence
|
||||
|
||||
Use only when the product requires durable data.
|
||||
|
||||
```text
|
||||
src/app/db/
|
||||
├─ __init__.py
|
||||
├─ base.py
|
||||
├─ session.py
|
||||
├─ models/
|
||||
└─ repositories/
|
||||
```
|
||||
|
||||
- Create one engine and sessionmaker per process.
|
||||
- Provide request- or operation-scoped sessions with `yield`.
|
||||
- Keep transaction boundaries explicit in service or repository flows.
|
||||
- Never share sessions across concurrent tasks.
|
||||
- Use Alembic as the schema migration source of truth.
|
||||
|
||||
## Optional LangGraph AI
|
||||
|
||||
Use only for multi-step orchestration, resumable work, streaming, or human approval.
|
||||
|
||||
```text
|
||||
src/app/ai/
|
||||
├─ state.py
|
||||
├─ nodes/
|
||||
├─ graphs/
|
||||
├─ runtime.py
|
||||
└─ contracts.py
|
||||
```
|
||||
|
||||
- Keep graph internals outside API and UI modules.
|
||||
- Invoke graphs through a service such as `services/ai_service.py`.
|
||||
- Use stable thread or session IDs for resumable flows.
|
||||
- Keep interrupt payloads JSON-serializable.
|
||||
|
||||
## Optional Mounted Docs
|
||||
|
||||
Use only when generated docs must be served by the application.
|
||||
|
||||
Suggested settings:
|
||||
|
||||
- `docs_enabled`
|
||||
- `docs_mount_path`
|
||||
- `docs_site_dir`
|
||||
- `docs_require_build`
|
||||
|
||||
Mount docs in the composition layer, normalize the mount path, avoid route conflicts, and define behavior for missing build artifacts.
|
||||
|
||||
## Async And Responsiveness
|
||||
|
||||
- Use `async def` where a handler or service path performs I/O.
|
||||
- Prefer non-blocking clients and libraries.
|
||||
- Offload CPU-heavy work to worker or background execution.
|
||||
- Define progress, cancellation, timeout, completion, and error states for long actions.
|
||||
- Stream or chunk results when workflows are long-running or multi-step.
|
||||
|
||||
## Testing Minimums
|
||||
|
||||
- Test the FastAPI health route.
|
||||
- Test page registration wiring.
|
||||
- If persistence is enabled, test session lifecycle and rollback behavior.
|
||||
- If AI is enabled, test happy paths and interrupt/resume behavior.
|
||||
- If docs are enabled, test the mounted index route.
|
||||
- For long actions, test loading, completion, and error states.
|
||||
@@ -1,100 +0,0 @@
|
||||
# Binding Dataclasses Deep Dive
|
||||
|
||||
Use this reference to model NiceGUI state with bindable dataclasses and avoid common propagation and performance pitfalls.
|
||||
|
||||
## Primary Sources
|
||||
|
||||
- NiceGUI binding docs: [binding properties](https://www.nicegui.io/documentation/section_binding_properties)
|
||||
- Python dataclass docs: [dataclasses module](https://docs.python.org/3/library/dataclasses.html)
|
||||
- Data class design rationale: [PEP 557](https://peps.python.org/pep-0557/)
|
||||
|
||||
## Bindable Dataclass Behavior
|
||||
|
||||
`@binding.bindable_dataclass` extends standard dataclasses by turning fields into bindable properties, allowing UI bindings to propagate when a field is assigned.
|
||||
|
||||
```python
|
||||
from nicegui import binding, ui
|
||||
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class Profile:
|
||||
name: str = "Ada"
|
||||
age: int = 37
|
||||
|
||||
|
||||
profile = Profile()
|
||||
|
||||
ui.input("Name").bind_value(profile, "name")
|
||||
ui.number("Age", min=0).bind_value(profile, "age")
|
||||
ui.label().bind_text_from(profile, "name", backward=lambda name: f"User: {name}")
|
||||
```
|
||||
|
||||
## Propagation And Performance
|
||||
|
||||
NiceGUI distinguishes between two link types:
|
||||
|
||||
- Bindable properties propagate efficiently when values are assigned.
|
||||
- Active links are checked in a refresh loop.
|
||||
|
||||
Prefer bindable dataclasses for frequently updated form state. Keep binding transforms pure and inexpensive. If an application has many active links, tune `binding_refresh_interval` in `ui.run(...)` only after measuring the impact.
|
||||
|
||||
## Dataclass Modeling Rules
|
||||
|
||||
- Use `field(default_factory=...)` for mutable defaults.
|
||||
- Avoid `frozen=True` for models edited by UI controls.
|
||||
- Use `slots=True` only after confirming compatibility with inheritance and extension needs.
|
||||
- Keep UI-editable fields explicit and typed.
|
||||
|
||||
```python
|
||||
from dataclasses import field
|
||||
|
||||
from nicegui import binding
|
||||
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class Filters:
|
||||
query: str = ""
|
||||
tags: list[str] = field(default_factory=list)
|
||||
```
|
||||
|
||||
## Nested Structures
|
||||
|
||||
NiceGUI supports tuple paths for nested data structures.
|
||||
|
||||
```python
|
||||
from nicegui import ui
|
||||
|
||||
data = {"user": {"name": "Ada"}}
|
||||
|
||||
ui.input("Name").bind_value(data, ("user", "name"))
|
||||
ui.label().bind_text_from(data, ("user", "name"))
|
||||
```
|
||||
|
||||
Keep nested dataclass updates explicit and predictable at the field level.
|
||||
|
||||
## Strictness And Refactor Safety
|
||||
|
||||
- Object attributes are checked by default.
|
||||
- Dictionary keys are not checked by default.
|
||||
- Use `strict=True` when missing dictionary keys should produce warnings.
|
||||
|
||||
```python
|
||||
from nicegui import app, ui
|
||||
|
||||
ui.input().bind_value(app.storage.user, "display_name", strict=True)
|
||||
```
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
- In-place mutation may not produce immediate UI synchronization. Assign the updated value back to the bound field.
|
||||
- Heavy binding transforms can degrade refresh performance. Move expensive work to event handlers or services.
|
||||
- State shared across unrelated pages or users can leak data. Scope models to the appropriate page, client, or user context.
|
||||
|
||||
## Version Checks
|
||||
|
||||
- `bindable_dataclass` was added in NiceGUI 2.11.0.
|
||||
- Depth-first binding propagation was documented in NiceGUI 2.16.0.
|
||||
- Binding `strict` behavior was documented in NiceGUI 3.0.0.
|
||||
- Tuple paths for nested properties were documented in NiceGUI 3.10.0.
|
||||
|
||||
Verify these behaviors against the NiceGUI version pinned by the target project.
|
||||
@@ -1,110 +0,0 @@
|
||||
# Interaction Patterns Reference
|
||||
|
||||
## Reactive State
|
||||
|
||||
Use bindable dataclasses for local page state.
|
||||
|
||||
```python
|
||||
from dataclasses import field
|
||||
from nicegui import binding, ui
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class PageState:
|
||||
selected_id: int | None = None
|
||||
items: list = field(default_factory=list)
|
||||
|
||||
state = PageState()
|
||||
ui.label().bind_text_from(state, "selected_id")
|
||||
```
|
||||
|
||||
## File Upload Pattern
|
||||
|
||||
- Validate extension and size before storing.
|
||||
- Delegate storage to a service method.
|
||||
- Notify success and failure explicitly.
|
||||
|
||||
```python
|
||||
async def handle_upload(e: ui.events.UploadEventArguments):
|
||||
try:
|
||||
if e.size > 10 * 1024 * 1024:
|
||||
raise ValueError("File too large")
|
||||
if not e.name.endswith(".pdf"):
|
||||
raise ValueError("Only PDF allowed")
|
||||
await file_service.store(e.content.read(), e.name)
|
||||
ui.notify(f"Uploaded: {e.name}", type="positive")
|
||||
except ValueError as err:
|
||||
ui.notify(str(err), type="negative")
|
||||
|
||||
ui.upload(on_upload=handle_upload, auto_upload=True)
|
||||
```
|
||||
|
||||
## Form Submission Pattern
|
||||
|
||||
- Bind UI inputs to dataclass fields.
|
||||
- Perform validation in the service layer.
|
||||
- Clear form state on success.
|
||||
|
||||
```python
|
||||
@binding.bindable_dataclass
|
||||
class FormData:
|
||||
name: str = ""
|
||||
email: str = ""
|
||||
|
||||
data = FormData()
|
||||
ui.input("Name").bind_value(data, "name")
|
||||
ui.input("Email").bind_value(data, "email")
|
||||
|
||||
async def on_submit():
|
||||
try:
|
||||
await user_service.create_user(name=data.name, email=data.email)
|
||||
ui.notify("User created", type="positive")
|
||||
data.name = data.email = ""
|
||||
except ValueError as err:
|
||||
ui.notify(str(err), type="negative")
|
||||
|
||||
ui.button("Submit").on_click(on_submit)
|
||||
```
|
||||
|
||||
## Real-Time Updates Decision
|
||||
|
||||
Use SSE for one-way status streaming.
|
||||
Use WebSocket for bidirectional messaging.
|
||||
|
||||
SSE endpoint example:
|
||||
|
||||
```python
|
||||
@app.get("/events/status")
|
||||
async def status_stream():
|
||||
async def gen():
|
||||
while True:
|
||||
yield f"data: {await get_status()}\\n\\n"
|
||||
await asyncio.sleep(1)
|
||||
return StreamingResponse(gen(), media_type="text/event-stream")
|
||||
```
|
||||
|
||||
## Background Work Pattern
|
||||
|
||||
- Start long jobs in FastAPI background tasks.
|
||||
- Expose status via endpoint or streaming channel.
|
||||
- Guard buttons against duplicate submissions during in-flight tasks.
|
||||
|
||||
## Explicit Refresh Pattern
|
||||
|
||||
Use @ui.refreshable and call refresh intentionally instead of polling unrelated state.
|
||||
|
||||
```python
|
||||
@ui.refreshable
|
||||
async def item_list():
|
||||
items = await service.list()
|
||||
for item in items:
|
||||
ui.label(item.name)
|
||||
|
||||
ui.button("Refresh").on_click(lambda: item_list.refresh())
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
!!! info "Primary sources"
|
||||
- [NiceGUI action events](https://nicegui.io/documentation/section_action_events)
|
||||
- [FastAPI server-sent events](https://fastapi.tiangolo.com/advanced/server-sent-events/)
|
||||
- [FastAPI WebSockets](https://fastapi.tiangolo.com/advanced/websockets/)
|
||||
@@ -1,39 +0,0 @@
|
||||
# Troubleshooting and Quality Gates
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Upload Errors
|
||||
|
||||
- Validate extension and size before storage.
|
||||
- Catch expected exceptions and return negative notifications.
|
||||
- Log unexpected exceptions with request context.
|
||||
|
||||
### UI Race Conditions
|
||||
|
||||
- Disable triggering controls during async work.
|
||||
- Remove duplicate timers and listeners targeting the same state.
|
||||
- Ensure service call ordering is deterministic before render updates.
|
||||
|
||||
### Asset Caching
|
||||
|
||||
- Confirm static mount and proxy rewrite correctness.
|
||||
- Add cache-busting query strings for changed assets.
|
||||
- Avoid per-page CSS injection.
|
||||
|
||||
### Navigation and State Drift
|
||||
|
||||
- Avoid global mutable UI state.
|
||||
- Keep state request-scoped or service-managed.
|
||||
- Rehydrate page data during route load.
|
||||
|
||||
## Production Readiness Gate
|
||||
|
||||
Pass all checks before shipping:
|
||||
|
||||
- Structure: one-way dependencies between pages, components, and services.
|
||||
- Responsiveness: UI validated at both small and large viewport widths.
|
||||
- Accessibility: labels and actions are clear and readable.
|
||||
- Reliability: validation and exception paths surface user feedback.
|
||||
- Maintainability: repeated UI patterns are extracted; business logic remains in services.
|
||||
|
||||
If any check fails, return to the workflow step that owns that concern.
|
||||
@@ -1,95 +0,0 @@
|
||||
---
|
||||
icon: lucide/flask-conical
|
||||
---
|
||||
|
||||
# Testing
|
||||
|
||||
This page describes the current test layout and execution model for this repository.
|
||||
|
||||
Primary guidance sources:
|
||||
- [Pytest scaffolding skill](./skills/pytesting/SKILL.md)
|
||||
- [Pytest docs reference](./skills/pytesting/references/pytest-docs.md)
|
||||
- [FastAPI + uv + Docker skill](./skills/fastapi-uv-docker/SKILL.md)
|
||||
|
||||
## Goals
|
||||
|
||||
1. Keep local feedback fast with deterministic tests.
|
||||
2. Mirror source modules with focused test groups.
|
||||
3. Keep endpoint and MCP surface checks explicit.
|
||||
4. Make marker usage strict and intentional.
|
||||
|
||||
## Current Test Layout
|
||||
|
||||
Current tree:
|
||||
|
||||
```text
|
||||
tests/
|
||||
__init__.py
|
||||
conftest.py
|
||||
registry/
|
||||
ingest/
|
||||
conftest.py
|
||||
test_current_docs.py
|
||||
test_document.py
|
||||
test_prompt.py
|
||||
test_skill.py
|
||||
models/
|
||||
test_document_validation.py
|
||||
test_prompt_validation.py
|
||||
test_registry_payload_models.py
|
||||
test_skill_validation.py
|
||||
web/
|
||||
conftest.py
|
||||
test_endpoint_connections.py
|
||||
test_mcp_skills.py
|
||||
```
|
||||
|
||||
Source-to-test alignment today:
|
||||
- `src/personal_mcp/registry/ingest/` -> `tests/registry/ingest/`
|
||||
- `src/personal_mcp/registry/models/` -> `tests/registry/models/`
|
||||
- `src/personal_mcp/web/` and MCP HTTP surface -> `tests/web/`
|
||||
|
||||
## Markers And Strictness
|
||||
|
||||
Configured markers in `pyproject.toml`:
|
||||
- `unit`: fast deterministic tests with no external dependencies
|
||||
- `integration`: framework or component integration tests
|
||||
- `smoke`: thin critical-path checks
|
||||
|
||||
Pytest runs with `--strict-markers`, so any unregistered marker fails the test run.
|
||||
|
||||
## Fixture Layering
|
||||
|
||||
Fixture placement follows test scope:
|
||||
1. `tests/conftest.py` for cross-suite defaults.
|
||||
2. `tests/registry/ingest/conftest.py` for ingest-specific setup.
|
||||
3. `tests/web/conftest.py` for web and endpoint client setup.
|
||||
|
||||
Prefer adding fixtures at the narrowest scope that serves more than one test.
|
||||
|
||||
## Command Baseline
|
||||
|
||||
Canonical invocation:
|
||||
|
||||
```bash
|
||||
uv run pytest
|
||||
```
|
||||
|
||||
Useful filtered runs:
|
||||
|
||||
```bash
|
||||
uv run pytest --collect-only -q
|
||||
uv run pytest -m unit -q
|
||||
uv run pytest -m integration -q
|
||||
uv run pytest -m smoke -q
|
||||
```
|
||||
|
||||
## Adding New Tests
|
||||
|
||||
When adding coverage:
|
||||
1. Place tests under the nearest existing module subtree (`registry/` or `web/`).
|
||||
2. Mirror the source path where practical.
|
||||
3. Reuse existing `conftest.py` files before adding new fixture layers.
|
||||
4. Add markers only when they convey execution intent, and register new markers in `pyproject.toml` first.
|
||||
|
||||
This keeps the suite aligned with the current architecture while preserving a fast local test loop.
|
||||
-366
@@ -1,366 +0,0 @@
|
||||
---
|
||||
icon: lucide/workflow
|
||||
---
|
||||
|
||||
# Skill Usage Mechanics
|
||||
|
||||
## Purpose
|
||||
|
||||
This page explains practical usage mechanics for the GitHub Copilot extension in VS Code when `personal-mcp` is configured as an MCP server:
|
||||
|
||||
1. explicit `/` command flows when you want deterministic control
|
||||
2. guided skill loading when relevance can be inferred
|
||||
|
||||
The goal is to show how Copilot behaves as a client and how to shape that behavior.
|
||||
|
||||
## Mental Model
|
||||
|
||||
In Copilot Chat, there are two distinct mechanisms:
|
||||
|
||||
1. `/` commands are user-invoked orchestration shortcuts.
|
||||
2. MCP resources are server-published knowledge units that can be attached as read-only context, while MCP tools provide an execution path for discovery and retrieval.
|
||||
|
||||
In this repository, skill guidance is exposed as MCP resources, not as server-owned prompt execution. Copilot remains the orchestrator.
|
||||
|
||||
Prompt guidance is now exposed through both prompt resources and MCP prompt objects. Prompt objects are additive; authored markdown remains the canonical source.
|
||||
|
||||
## Background Mechanics
|
||||
|
||||
### What the server publishes
|
||||
|
||||
`personal-mcp` registers resources from the validated docs registry and exposes catalog discovery resources:
|
||||
|
||||
1. `resource://catalog/skills_index`
|
||||
2. `resource://catalog/skills_index{?q,tag,capability,cursor,limit}`
|
||||
3. `resource://catalog/skills/{skill_id}`
|
||||
4. `resource://catalog/prompts_index`
|
||||
5. `resource://catalog/prompts_index{?q,tag,cursor,limit}`
|
||||
6. `resource://catalog/prompts/{prompt_id}`
|
||||
|
||||
Each skill publishes a canonical Markdown document resource:
|
||||
|
||||
1. `resource://skills/<skill-id>/document`
|
||||
2. `resource://skills/<skill-id>/references/<ref-id>`
|
||||
|
||||
Prompts publish a canonical prompt document resource:
|
||||
|
||||
1. `resource://prompts/<prompt-id>/document`
|
||||
|
||||
The document payload is loaded from `docs/skills/<skill-id>/SKILL.md` and returned with metadata.
|
||||
|
||||
### What Copilot does as the client
|
||||
|
||||
When connected to MCP, Copilot can do the following at runtime:
|
||||
|
||||
1. interpret the current chat request
|
||||
2. use attached MCP resources that you provide through the chat UI
|
||||
3. invoke MCP tools when the task and tool descriptions make that relevant
|
||||
4. summarize relevant sections into working context
|
||||
5. apply guidance while generating edits or recommendations
|
||||
|
||||
This behavior is shaped by the active chat surface, prompt or instruction guidance, and available MCP tools.
|
||||
|
||||
For reliable progressive discovery, use one of these sequences:
|
||||
|
||||
1. explicit resource path: attach a catalog resource first, then attach only selected skill documents
|
||||
2. tool path: call catalog tools first, then load only selected skill documents
|
||||
|
||||
### What `/` commands do
|
||||
|
||||
`/` commands in VS Code are client-side prompt entry points (for example in prompt files). They do not replace MCP resources. In Copilot, they typically:
|
||||
|
||||
1. enforce a known sequence
|
||||
2. collect missing inputs
|
||||
3. call discovery/read steps in a predictable order
|
||||
|
||||
Think of `/` commands as orchestration shortcuts on top of MCP resources.
|
||||
|
||||
### What automatic loading means here
|
||||
|
||||
In this project, "automatic loading" should be read as a preference you express through instructions and prompts, not as a guaranteed VS Code feature that auto-attaches MCP resources.
|
||||
|
||||
In practice, there are two reliable ways to make skill content available in chat:
|
||||
|
||||
1. explicit resource attachment through `Add Context > MCP Resources` or `MCP: Browse Resources`
|
||||
2. MCP tool invocation using `list_resources`/`read_resource` (ResourcesAsTools), with thin catalog tools as parity fallback
|
||||
|
||||
For prompt content, there is a third option when the client supports MCP prompt APIs:
|
||||
|
||||
1. prompt-object discovery and invocation through MCP prompt lists and `get_prompt`
|
||||
|
||||
Instruction quality and metadata quality still matter, because they influence whether Copilot recognizes that the MCP server is relevant and chooses the tool path well.
|
||||
|
||||
## Invocation Mechanics Deep Dive
|
||||
|
||||
This section expands on how invocation works at runtime across chat entry points.
|
||||
|
||||
### Invocation Surfaces
|
||||
|
||||
A user request can arrive through one of these surfaces:
|
||||
|
||||
1. plain chat request in Ask/Edit/Agent mode
|
||||
2. slash command invocation of a prompt or skill
|
||||
3. chat request with manually attached MCP resources
|
||||
|
||||
Each surface changes how much discovery Copilot must do before applying guidance.
|
||||
|
||||
### Resolution Order
|
||||
|
||||
When multiple retrieval paths are possible, use this priority order:
|
||||
|
||||
1. attached MCP resources already in context
|
||||
2. explicit slash-command workflow steps
|
||||
3. catalog-first discovery via MCP resources
|
||||
4. tool fallback (`list_resources` then `read_resource`, then thin catalog parity tools)
|
||||
|
||||
This ordering keeps behavior predictable while minimizing unnecessary context expansion.
|
||||
|
||||
### Prompt Invocation Pipeline
|
||||
|
||||
For prompt-oriented flows, treat invocation as this sequence:
|
||||
|
||||
1. parse prompt frontmatter and argument hints
|
||||
2. validate required inputs and ask one clarifying question if blocked
|
||||
3. run bounded discovery against prompt or skill catalogs
|
||||
4. fetch only selected document resources
|
||||
5. apply instructions to produce edits, recommendations, or commands
|
||||
6. report what was loaded and why
|
||||
|
||||
Prompt objects and prompt document resources are additive mechanisms. The authored Markdown prompt document remains the canonical contract.
|
||||
|
||||
### Argument Syntax Nuance
|
||||
|
||||
Invocation strings such as target_modules=src/personal_mcp/registry/ingest/skill.py, mode=plan-only are a structured authoring convention, not a guaranteed client-level grammar.
|
||||
|
||||
In practice:
|
||||
|
||||
1. Prompt metadata defines expected argument names and intent.
|
||||
2. Prompt body instructions define how those inputs should be interpreted.
|
||||
3. Copilot may receive equivalent intent in freeform phrasing and still resolve it correctly.
|
||||
|
||||
Implication for authors:
|
||||
|
||||
1. Treat key=value examples as clarity aids for users.
|
||||
2. Do not assume strict parser enforcement unless your prompt explicitly validates and rejects malformed input.
|
||||
3. Include accepted invocation examples and one fallback freeform example so behavior is predictable for both humans and the model.
|
||||
|
||||
This distinction is important because argument hints improve discoverability, while robust prompt instructions determine actual runtime reliability.
|
||||
|
||||
### Skill Invocation Pipeline
|
||||
|
||||
For guided skill loading, use this sequence:
|
||||
|
||||
1. start from `resource://catalog/skills_index` or scoped index query
|
||||
2. inspect one or two top candidates for intent and capability fit
|
||||
3. fetch `resource://skills/<skill-id>/document`
|
||||
4. load references only when the task needs deeper detail
|
||||
5. apply only relevant sections and keep context bounded
|
||||
|
||||
This avoids the common failure mode where many skill documents are loaded up front.
|
||||
|
||||
### Determinism vs Flexibility
|
||||
|
||||
Use this decision rule:
|
||||
|
||||
1. choose slash-command invocation when repeatability and step order are critical
|
||||
2. choose guided loading when requests vary and speed matters more than strict orchestration
|
||||
3. escalate from guided loading to slash-command flow when confidence is low or conflicting skills appear
|
||||
|
||||
### Invocation Trace (What to Log in Results)
|
||||
|
||||
For transparent operation, include a concise invocation trace in task outputs:
|
||||
|
||||
1. entry surface used (plain chat, slash command, or attached resource)
|
||||
2. discovery source used (catalog resource or tool path)
|
||||
3. resources fetched (ids only)
|
||||
4. clarifying questions asked (if any)
|
||||
5. reason for fallback or escalation (if used)
|
||||
|
||||
This makes behavior auditable and easier to tune over time.
|
||||
|
||||
## Operating Pattern
|
||||
|
||||
Use both modes intentionally in Copilot Chat.
|
||||
|
||||
### Mode A: Explicit `/` command
|
||||
|
||||
Use when you need predictable, repeatable behavior across teammates.
|
||||
|
||||
Good fits:
|
||||
|
||||
1. onboarding workflows
|
||||
2. compliance-sensitive tasks
|
||||
3. repetitive scaffolding
|
||||
|
||||
### Mode B: Guided skill loading
|
||||
|
||||
Use when requests are varied and you want lower friction during normal chat.
|
||||
|
||||
Good fits:
|
||||
|
||||
1. ad hoc implementation questions
|
||||
2. mixed-topic debugging
|
||||
3. architecture tradeoff discussions
|
||||
|
||||
### Mode C: Fallback flow
|
||||
|
||||
Start with guided loading in chat; escalate to a `/` command when:
|
||||
|
||||
1. confidence is low
|
||||
2. multiple skills conflict
|
||||
3. the user wants strict repeatability
|
||||
|
||||
## Suggested Resolution Flow
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[User request in Copilot Chat] --> B{Deterministic workflow needed?}
|
||||
B -- Yes --> C[/Run slash command/]
|
||||
C --> D[Copilot fetches known catalog and skill resources]
|
||||
B -- No --> E[Copilot uses attached resources or catalog tools]
|
||||
E --> F{Confident skill match?}
|
||||
F -- Yes --> G[Copilot fetches skill documents]
|
||||
F -- No --> H[Ask clarifying question or suggest slash command]
|
||||
D --> I[Apply guidance to task]
|
||||
G --> I
|
||||
H --> I
|
||||
```
|
||||
|
||||
## Authoring Requirements
|
||||
|
||||
Authoring rules for metadata quality and instruction patterns are maintained in [Authoring Guide](./authoring.md).
|
||||
|
||||
## Practical Guidelines
|
||||
|
||||
1. Keep `/` commands minimal and high-value.
|
||||
2. Do not duplicate full methodology text inside command files.
|
||||
3. Keep canonical guidance in `docs/skills/*/SKILL.md`.
|
||||
4. In Copilot instructions, prefer catalog-first discovery before skill fetch.
|
||||
5. Prefer small, relevant context slices over loading every skill.
|
||||
6. Keep slash commands focused on deterministic orchestration, not content duplication.
|
||||
|
||||
If you skip the catalog/index step, behavior is less predictable and may either miss relevant skills or pull too much context.
|
||||
|
||||
## Optional Tool Search Mode
|
||||
|
||||
When tool catalogs grow, FastMCP search transforms can reduce tool-list noise for tool-only clients.
|
||||
|
||||
Runtime switches:
|
||||
|
||||
1. `PERSONAL_MCP_TOOL_SEARCH=none|regex|bm25` (default `none`)
|
||||
2. `PERSONAL_MCP_TOOL_SEARCH_MAX_RESULTS=<positive int>` (default `5`)
|
||||
|
||||
Behavior:
|
||||
|
||||
1. `regex` uses deterministic regex matching for targeted queries.
|
||||
2. `bm25` uses ranked natural-language matching.
|
||||
3. `list_resources` and `read_resource` stay visible so resource-backed fallback remains primary.
|
||||
|
||||
## Failure Modes and Recovery
|
||||
|
||||
Common failure modes:
|
||||
|
||||
1. No relevant skill selected.
|
||||
2. Too many skills selected (context bloat).
|
||||
3. Stale assumptions from old metadata.
|
||||
4. Slash command bypasses normal discovery and forces the wrong skill.
|
||||
|
||||
Recovery sequence:
|
||||
|
||||
1. re-run catalog lookup
|
||||
2. narrow by tags and intent
|
||||
3. fetch only top candidates
|
||||
4. if still ambiguous, ask one clarifying question
|
||||
5. use explicit `/` workflow for deterministic fallback
|
||||
|
||||
## Checklist
|
||||
|
||||
Use this checklist when configuring GitHub Copilot in VS Code against `personal-mcp`:
|
||||
|
||||
1. confirm server connectivity
|
||||
2. verify catalog resources are readable
|
||||
3. verify at least one `resource://skills/<id>/document` can be fetched
|
||||
4. add one deterministic `/` command for fallback
|
||||
5. confirm your workspace instruction policy exists (see [Authoring Guide](./authoring.md))
|
||||
6. verify context size remains bounded
|
||||
7. validate behavior in Ask/Edit/Agent-style workflows with at least one task each
|
||||
|
||||
## Runtime Discovery Workflow
|
||||
|
||||
Use this runtime sequence in chat sessions:
|
||||
|
||||
1. Start with catalog-first discovery.
|
||||
2. Prefer MCP resources when the chat surface exposes resource attachment.
|
||||
3. Otherwise use tool fallback to load one or two likely skill documents.
|
||||
4. Prefer `list_resources`/`read_resource` first when operating in tool-only clients.
|
||||
5. If confidence is low, ask one clarifying question before loading more.
|
||||
|
||||
## Thin Shim Path Binding Pattern
|
||||
|
||||
For repositories that consume this MCP server, thin shims are a usage pattern for binding path scopes to the right MCP resources. The "thin shims" are just lightweight, repo-specific instructions files that tell Copilot to use certain MCP resources when editing files that match a pattern. That helps with ensuring Copilot uses the intended resources without too much specific goading in the prompt.
|
||||
|
||||
Use thin shims in Copilot instruction files to bind file-path scopes to:
|
||||
|
||||
1. the most relevant docs page for human-readable conventions
|
||||
2. the matching MCP resource URI for machine retrieval
|
||||
|
||||
Keep each shim short: trigger, primary resource, minimal execution pattern, and one fallback rule.
|
||||
|
||||
Recommended binding pattern:
|
||||
|
||||
1. Put shims in `.github/instructions/*.instructions.md`.
|
||||
2. Scope each shim with `applyTo` so it activates only where needed.
|
||||
3. Point to one primary `resource://skills/<skill-id>/document` URI.
|
||||
4. Link one repository docs page as the human-facing companion.
|
||||
5. Expand to references only when the task needs deeper detail.
|
||||
|
||||
Current repository examples:
|
||||
|
||||
| applyTo scope | Primary docs page | Primary MCP resource |
|
||||
| --- | --- | --- |
|
||||
| `**/*.md` | [docs/authoring.md](./authoring.md) | `resource://skills/zensical-docs/document` |
|
||||
| `tests/**` | [docs/testing.md](./testing.md) | `resource://skills/pytesting/document` |
|
||||
| `.vscode/**` | [docs/skills/vscode-configuration/SKILL.md](./skills/vscode-configuration/SKILL.md) | `resource://skills/vscode-configuration/document` |
|
||||
|
||||
Minimal shim shape:
|
||||
|
||||
```md
|
||||
---
|
||||
name: <short scope name>
|
||||
description: Route <path scope> edits to the Personal MCP <skill-id> resource.
|
||||
applyTo: '<glob>'
|
||||
---
|
||||
|
||||
When editing files matching <glob>, use `resource://skills/<skill-id>/document` as the primary guidance source.
|
||||
|
||||
Execution pattern:
|
||||
|
||||
1. Load the primary skill document first.
|
||||
2. Apply only sections relevant to the file being edited.
|
||||
3. Keep edits minimal and aligned with repository conventions.
|
||||
4. If confidence is low, ask one clarifying question before editing.
|
||||
|
||||
Companion docs page: [docs/<page>.md](./<page>.md)
|
||||
```
|
||||
|
||||
When to use thin shims:
|
||||
|
||||
1. Repositories that want thin local policy while keeping canonical guidance in MCP resources.
|
||||
2. Stable, repeated workflows with clear path ownership.
|
||||
3. Cases where teams need predictable retrieval behavior.
|
||||
|
||||
When not to use thin shims:
|
||||
|
||||
1. Broad, ambiguous tasks with unclear ownership boundaries.
|
||||
2. Cases where one shim would need many exceptions.
|
||||
3. Situations better handled by catalog-first discovery at runtime.
|
||||
|
||||
## Summary
|
||||
|
||||
The intended model is:
|
||||
|
||||
1. skills are canonical MCP resources
|
||||
2. `/` commands are explicit Copilot control shortcuts
|
||||
3. guided skill loading should be catalog-driven, bounded, and explicit about whether it is using resources or tools
|
||||
|
||||
Using all three together gives predictable control when needed and low-friction assistance by default in VS Code.
|
||||
+17
-12
@@ -1,26 +1,27 @@
|
||||
[project]
|
||||
name = "prompts"
|
||||
version = "0.1.0"
|
||||
name = "personal_mcp"
|
||||
version = "2.0.0"
|
||||
requires-python = ">=3.12"
|
||||
dependencies = [
|
||||
"fastapi>=0.115.0",
|
||||
"fastmcp>=2.10.0",
|
||||
"pydantic-settings>=2.0.0",
|
||||
"python-json-logger>=4.1.0",
|
||||
"fastapi>=0.133.0",
|
||||
"fastmcp==4.0.0b4",
|
||||
"pydantic-settings>=2",
|
||||
"pyyaml>=6.0.2",
|
||||
"python-json-logger>=4",
|
||||
"uvicorn[standard]>=0.34.0",
|
||||
"zensical>=0.0.45",
|
||||
]
|
||||
|
||||
[tool.uv]
|
||||
constraint-dependencies = ["fastmcp-slim==4.0.0b4"]
|
||||
|
||||
[project.scripts]
|
||||
personal-mcp = "personal_mcp.main:main"
|
||||
personal-mcp = "personal_mcp.__main__:main"
|
||||
mcp-stdio = "personal_mcp.mcp:run_stdio"
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/personal_mcp"]
|
||||
requires = ["uv_build>=0.12.7,<0.13"]
|
||||
build-backend = "uv_build"
|
||||
|
||||
[dependency-groups]
|
||||
dev = [
|
||||
@@ -30,9 +31,12 @@ dev = [
|
||||
"ty>=0.0.51",
|
||||
]
|
||||
test = [
|
||||
"asgi-lifespan>=2.1.0",
|
||||
"httpx2>=2.9.1",
|
||||
"pytest>=9.1.1",
|
||||
"pytest-asyncio>=1.4.0",
|
||||
"pytest-cov>=7.1.0",
|
||||
"pyyaml>=6.0.2",
|
||||
]
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
@@ -47,3 +51,4 @@ markers = [
|
||||
|
||||
[tool.ty.src]
|
||||
include = ["src", "tests"]
|
||||
exclude = ["src/personal_mcp/docs/skills/*/examples/*.py"]
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
import uvicorn
|
||||
|
||||
from .config import get_settings
|
||||
|
||||
|
||||
def main(cli: bool = True) -> None:
|
||||
"""Run the root MCP server."""
|
||||
settings = get_settings(cli=cli)
|
||||
uvicorn.run(
|
||||
"personal_mcp.app:create_app",
|
||||
factory=True,
|
||||
host=settings.host,
|
||||
port=settings.port,
|
||||
reload=settings.reload,
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,112 @@
|
||||
from contextlib import asynccontextmanager
|
||||
from importlib.resources import as_file
|
||||
from importlib.resources import files
|
||||
from pathlib import Path
|
||||
|
||||
from fastapi import FastAPI
|
||||
from fastapi import Response
|
||||
from fastapi import status
|
||||
from fastapi.responses import RedirectResponse
|
||||
from fastapi.staticfiles import StaticFiles
|
||||
from fastmcp.utilities.lifespan import combine_lifespans
|
||||
|
||||
from .config import Settings
|
||||
from .config import get_settings
|
||||
from .mcp import create_mcp
|
||||
|
||||
|
||||
def create_app(settings: Settings | None = None) -> FastAPI:
|
||||
runtime_settings = settings if settings is not None else get_settings()
|
||||
docs_route = runtime_settings.mounts.docs.rstrip("/") or "/docs"
|
||||
mcp_route = runtime_settings.mounts.mcp.rstrip("/") or "/mcp"
|
||||
mcp_app = create_mcp().http_app(
|
||||
path=mcp_route,
|
||||
json_response=True,
|
||||
stateless_http=True,
|
||||
transport="http",
|
||||
)
|
||||
app = FastAPI(
|
||||
debug=runtime_settings.debug,
|
||||
docs_url=None,
|
||||
redoc_url=None,
|
||||
openapi_url=None,
|
||||
lifespan=combine_lifespans(app_lifespan, mcp_app.lifespan),
|
||||
)
|
||||
app.state.settings = runtime_settings
|
||||
|
||||
async def redirect_root_to_docs() -> RedirectResponse:
|
||||
return RedirectResponse(
|
||||
url=docs_route,
|
||||
status_code=status.HTTP_307_TEMPORARY_REDIRECT,
|
||||
)
|
||||
|
||||
app.add_api_route(
|
||||
"/",
|
||||
redirect_root_to_docs,
|
||||
methods=["GET", "HEAD"],
|
||||
include_in_schema=False,
|
||||
)
|
||||
|
||||
app.router.routes.extend(mcp_app.routes)
|
||||
return app
|
||||
|
||||
|
||||
@asynccontextmanager
|
||||
async def app_lifespan(app: FastAPI):
|
||||
from . import __name__ as package_root_name
|
||||
|
||||
site_resource = files(package_root_name).joinpath("site")
|
||||
with as_file(site_resource) as site_dir:
|
||||
mount_docs(
|
||||
app,
|
||||
docs_route=app.state.settings.mounts.docs,
|
||||
site_dir=site_dir,
|
||||
)
|
||||
yield
|
||||
|
||||
|
||||
def mount_docs(app: FastAPI, *, docs_route: str, site_dir: Path) -> None:
|
||||
"""Mount the pre-built static docs site, or expose a clear missing-build response."""
|
||||
normalized_route = docs_route.rstrip("/") or "/docs"
|
||||
docs_root = f"{normalized_route}/"
|
||||
|
||||
async def redirect_to_docs_root() -> RedirectResponse:
|
||||
return RedirectResponse(
|
||||
url=docs_root,
|
||||
status_code=status.HTTP_307_TEMPORARY_REDIRECT,
|
||||
)
|
||||
|
||||
app.add_api_route(
|
||||
normalized_route,
|
||||
redirect_to_docs_root,
|
||||
methods=["GET", "HEAD"],
|
||||
include_in_schema=False,
|
||||
)
|
||||
|
||||
if site_dir.is_dir():
|
||||
app.mount(
|
||||
normalized_route,
|
||||
StaticFiles(directory=site_dir, html=True),
|
||||
name="docs",
|
||||
)
|
||||
return
|
||||
|
||||
async def docs_not_built() -> Response:
|
||||
return Response(
|
||||
content=("Static docs have not been built yet. Run `uv run zensical build` before using this route."),
|
||||
media_type="text/plain",
|
||||
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
|
||||
)
|
||||
|
||||
app.add_api_route(
|
||||
normalized_route,
|
||||
docs_not_built,
|
||||
methods=["GET"],
|
||||
include_in_schema=False,
|
||||
)
|
||||
app.add_api_route(
|
||||
f"{normalized_route}/{{path:path}}",
|
||||
docs_not_built,
|
||||
methods=["GET"],
|
||||
include_in_schema=False,
|
||||
)
|
||||
@@ -1,19 +0,0 @@
|
||||
from personal_mcp.catalog.server import build_prompt_detail_payload
|
||||
from personal_mcp.catalog.server import build_prompts_index_payload
|
||||
from personal_mcp.catalog.server import build_skill_detail_payload
|
||||
from personal_mcp.catalog.server import build_skills_index_payload
|
||||
from personal_mcp.catalog.server import get_pattern_by_id_payload
|
||||
from personal_mcp.catalog.server import get_prompt_by_id_payload
|
||||
from personal_mcp.catalog.server import search_patterns_payload
|
||||
from personal_mcp.catalog.server import search_prompts_payload
|
||||
|
||||
__all__ = [
|
||||
"build_prompt_detail_payload",
|
||||
"build_prompts_index_payload",
|
||||
"build_skill_detail_payload",
|
||||
"build_skills_index_payload",
|
||||
"get_pattern_by_id_payload",
|
||||
"get_prompt_by_id_payload",
|
||||
"search_patterns_payload",
|
||||
"search_prompts_payload",
|
||||
]
|
||||
@@ -1,250 +0,0 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from personal_mcp.registry.models.registry import DocsRegistry
|
||||
from personal_mcp.registry.models.registry import PromptRecord
|
||||
from personal_mcp.registry.models.registry import PromptSummaryPayload
|
||||
from personal_mcp.registry.models.registry import SkillPatternPayload
|
||||
from personal_mcp.registry.models.registry import SkillRecord
|
||||
from personal_mcp.registry.models.registry import SkillSummaryPayload
|
||||
|
||||
DEFAULT_LIMIT = 20
|
||||
MAX_LIMIT = 100
|
||||
|
||||
|
||||
def _skill_matches(
|
||||
skill: SkillRecord,
|
||||
*,
|
||||
query: str | None,
|
||||
tag: str | None,
|
||||
capability: str | None,
|
||||
) -> bool:
|
||||
if query:
|
||||
lowered = query.strip().lower()
|
||||
if lowered:
|
||||
haystack = " ".join(
|
||||
[
|
||||
skill.skill_id,
|
||||
skill.name,
|
||||
skill.description,
|
||||
" ".join(skill.tags),
|
||||
]
|
||||
).lower()
|
||||
terms = [term for term in lowered.replace("-", " ").split() if term]
|
||||
if any(term not in haystack for term in terms):
|
||||
return False
|
||||
|
||||
if tag and tag not in skill.tags:
|
||||
return False
|
||||
|
||||
return not (capability and capability not in skill.capabilities)
|
||||
|
||||
|
||||
def _prompt_matches(
|
||||
prompt: PromptRecord,
|
||||
*,
|
||||
query: str | None,
|
||||
tag: str | None,
|
||||
) -> bool:
|
||||
if query:
|
||||
lowered = query.strip().lower()
|
||||
if lowered:
|
||||
haystack = " ".join(
|
||||
[
|
||||
prompt.prompt_id,
|
||||
prompt.name,
|
||||
prompt.description,
|
||||
" ".join(prompt.tags),
|
||||
" ".join(sorted(prompt.arguments)),
|
||||
]
|
||||
).lower()
|
||||
terms = [term for term in lowered.replace("-", " ").split() if term]
|
||||
if any(term not in haystack for term in terms):
|
||||
return False
|
||||
|
||||
return not (tag and tag not in prompt.tags)
|
||||
|
||||
|
||||
def build_skills_index_payload(
|
||||
registry: DocsRegistry,
|
||||
*,
|
||||
query: str | None = None,
|
||||
tag: str | None = None,
|
||||
capability: str | None = None,
|
||||
cursor: str | None = None,
|
||||
limit: int | None = None,
|
||||
) -> dict[str, Any]:
|
||||
normalized_limit = DEFAULT_LIMIT if limit is None else max(1, min(limit, MAX_LIMIT))
|
||||
try:
|
||||
start = 0 if cursor is None else max(0, int(cursor))
|
||||
except ValueError as exc:
|
||||
raise ValueError("cursor must be an integer string") from exc
|
||||
|
||||
ordered = [registry.skills_by_id[skill_id] for skill_id in registry.skills_in_load_order]
|
||||
matches = [skill for skill in ordered if _skill_matches(skill, query=query, tag=tag, capability=capability)]
|
||||
|
||||
page = matches[start : start + normalized_limit]
|
||||
next_cursor = start + normalized_limit
|
||||
|
||||
return {
|
||||
"skills": [SkillSummaryPayload.from_record(skill).model_dump() for skill in page],
|
||||
"total": len(matches),
|
||||
"cursor": str(start),
|
||||
"limit": normalized_limit,
|
||||
"next_cursor": str(next_cursor) if next_cursor < len(matches) else None,
|
||||
}
|
||||
|
||||
|
||||
def build_skill_detail_payload(registry: DocsRegistry, skill_id: str) -> dict[str, Any]:
|
||||
if skill_id not in registry.skills_by_id:
|
||||
raise KeyError(skill_id)
|
||||
|
||||
skill = registry.skills_by_id[skill_id]
|
||||
return {
|
||||
"id": skill.skill_id,
|
||||
"name": skill.name,
|
||||
"description": skill.description,
|
||||
"version": skill.version,
|
||||
"tags": list(skill.tags),
|
||||
"capabilities": list(skill.capabilities),
|
||||
"resources": {
|
||||
"document": skill.document_uri,
|
||||
"references": {
|
||||
ref_id: {
|
||||
"uri": ref.uri,
|
||||
"mime_type": ref.mime_type,
|
||||
"title": ref.title,
|
||||
"path": ref.relpath.as_posix(),
|
||||
}
|
||||
for ref_id, ref in sorted(skill.references.items())
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def build_prompts_index_payload(
|
||||
registry: DocsRegistry,
|
||||
*,
|
||||
query: str | None = None,
|
||||
tag: str | None = None,
|
||||
cursor: str | None = None,
|
||||
limit: int | None = None,
|
||||
) -> dict[str, Any]:
|
||||
normalized_limit = DEFAULT_LIMIT if limit is None else max(1, min(limit, MAX_LIMIT))
|
||||
try:
|
||||
start = 0 if cursor is None else max(0, int(cursor))
|
||||
except ValueError as exc:
|
||||
raise ValueError("cursor must be an integer string") from exc
|
||||
|
||||
ordered = [registry.prompts_by_id[prompt_id] for prompt_id in registry.prompts_in_load_order]
|
||||
matches = [prompt for prompt in ordered if _prompt_matches(prompt, query=query, tag=tag)]
|
||||
|
||||
page = matches[start : start + normalized_limit]
|
||||
next_cursor = start + normalized_limit
|
||||
|
||||
return {
|
||||
"prompts": [PromptSummaryPayload.from_record(prompt).model_dump() for prompt in page],
|
||||
"total": len(matches),
|
||||
"cursor": str(start),
|
||||
"limit": normalized_limit,
|
||||
"next_cursor": str(next_cursor) if next_cursor < len(matches) else None,
|
||||
}
|
||||
|
||||
|
||||
def build_prompt_detail_payload(registry: DocsRegistry, prompt_id: str) -> dict[str, Any]:
|
||||
if prompt_id not in registry.prompts_by_id:
|
||||
raise KeyError(prompt_id)
|
||||
|
||||
prompt = registry.prompts_by_id[prompt_id]
|
||||
return {
|
||||
"id": prompt.prompt_id,
|
||||
"name": prompt.name,
|
||||
"description": prompt.description,
|
||||
"version": prompt.version,
|
||||
"tags": list(prompt.tags),
|
||||
"capabilities": list(prompt.capabilities),
|
||||
"resources": {
|
||||
"document": prompt.document_uri,
|
||||
},
|
||||
"arguments": {
|
||||
arg_name: arg.model_dump(exclude_none=True) for arg_name, arg in sorted(prompt.arguments.items())
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def search_patterns_payload(
|
||||
registry: DocsRegistry,
|
||||
*,
|
||||
query: str = "",
|
||||
tags: list[str] | None = None,
|
||||
skip: int = 0,
|
||||
limit: int = DEFAULT_LIMIT,
|
||||
) -> dict[str, Any]:
|
||||
normalized_skip = max(skip, 0)
|
||||
normalized_limit = max(1, min(limit, MAX_LIMIT))
|
||||
|
||||
requested_tags = [tag.strip() for tag in (tags or []) if tag and tag.strip()]
|
||||
|
||||
matches: list[SkillRecord] = []
|
||||
for skill_id in registry.skills_in_load_order:
|
||||
skill = registry.skills_by_id[skill_id]
|
||||
if not _skill_matches(skill, query=query, tag=None, capability=None):
|
||||
continue
|
||||
if requested_tags and any(tag not in skill.tags for tag in requested_tags):
|
||||
continue
|
||||
matches.append(skill)
|
||||
|
||||
page = matches[normalized_skip : normalized_skip + normalized_limit]
|
||||
return {
|
||||
"patterns": [SkillPatternPayload.from_record(skill).model_dump() for skill in page],
|
||||
"total": len(matches),
|
||||
"skip": normalized_skip,
|
||||
"limit": normalized_limit,
|
||||
}
|
||||
|
||||
|
||||
def get_pattern_by_id_payload(registry: DocsRegistry, skill_id: str) -> dict[str, Any]:
|
||||
if skill_id not in registry.skills_by_id:
|
||||
return {"found": False, "id": skill_id}
|
||||
return {"found": True, "pattern": SkillPatternPayload.from_record(registry.skills_by_id[skill_id]).model_dump()}
|
||||
|
||||
|
||||
def search_prompts_payload(
|
||||
registry: DocsRegistry,
|
||||
*,
|
||||
query: str = "",
|
||||
tags: list[str] | None = None,
|
||||
skip: int = 0,
|
||||
limit: int = DEFAULT_LIMIT,
|
||||
) -> dict[str, Any]:
|
||||
normalized_skip = max(skip, 0)
|
||||
normalized_limit = max(1, min(limit, MAX_LIMIT))
|
||||
|
||||
requested_tags = [tag.strip() for tag in (tags or []) if tag and tag.strip()]
|
||||
|
||||
matches: list[PromptRecord] = []
|
||||
for prompt_id in registry.prompts_in_load_order:
|
||||
prompt = registry.prompts_by_id[prompt_id]
|
||||
if not _prompt_matches(prompt, query=query, tag=None):
|
||||
continue
|
||||
if requested_tags and any(tag not in prompt.tags for tag in requested_tags):
|
||||
continue
|
||||
matches.append(prompt)
|
||||
|
||||
page = matches[normalized_skip : normalized_skip + normalized_limit]
|
||||
return {
|
||||
"prompts": [PromptSummaryPayload.from_record(prompt).model_dump() for prompt in page],
|
||||
"total": len(matches),
|
||||
"skip": normalized_skip,
|
||||
"limit": normalized_limit,
|
||||
}
|
||||
|
||||
|
||||
def get_prompt_by_id_payload(registry: DocsRegistry, prompt_id: str) -> dict[str, Any]:
|
||||
if prompt_id not in registry.prompts_by_id:
|
||||
return {"found": False, "id": prompt_id}
|
||||
return {
|
||||
"found": True,
|
||||
"prompt": build_prompt_detail_payload(registry, prompt_id),
|
||||
}
|
||||
@@ -1,15 +1,13 @@
|
||||
from functools import cache
|
||||
from pathlib import Path
|
||||
from typing import Literal
|
||||
|
||||
from pydantic import BaseModel
|
||||
from pydantic import DirectoryPath
|
||||
from pydantic import Field
|
||||
from pydantic_settings import BaseSettings
|
||||
from pydantic_settings import SettingsConfigDict
|
||||
|
||||
DEFAULT_ENV_FILE = Path(".env").resolve()
|
||||
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||
DEFAULT_SITE_DIR = Path("site").resolve()
|
||||
|
||||
|
||||
class Mounts(BaseModel):
|
||||
@@ -24,18 +22,20 @@ class Settings(BaseSettings):
|
||||
env_file=DEFAULT_ENV_FILE,
|
||||
env_prefix="PERSONAL_MCP_",
|
||||
extra="ignore",
|
||||
cli_implicit_flags=True,
|
||||
)
|
||||
|
||||
debug: bool = False
|
||||
log_level: str = "info"
|
||||
mounts: Mounts = Field(default_factory=Mounts)
|
||||
mcp_transport: Literal["http", "sse"] = "http"
|
||||
site_dir: DirectoryPath = Field(default=_REPO_ROOT / "site")
|
||||
host: str = "localhost"
|
||||
port: int = 8080
|
||||
reload: bool = True
|
||||
|
||||
|
||||
@cache
|
||||
def get_settings(**overrides) -> Settings:
|
||||
return Settings(**overrides)
|
||||
def get_settings(*, cli: bool = False, **overrides) -> Settings:
|
||||
return Settings(**overrides, _cli_parse_args=cli) # pyright: ignore[reportCallIssue]
|
||||
|
||||
|
||||
def refresh_settings(**overrides):
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../../docs
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
icon: lucide/library
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
Personal MCP is a small publishing service. Markdown is written once and made available in two ways:
|
||||
|
||||
1. as an MCP server for AI clients
|
||||
2. as a documentation website for people
|
||||
|
||||
## How It Fits Together
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[Markdown in src/personal_mcp/docs] --> B[MCP resources and prompts]
|
||||
A --> C[Documentation website]
|
||||
B --> D[AI clients]
|
||||
C --> E[Human readers]
|
||||
```
|
||||
|
||||
The running application has two routes:
|
||||
|
||||
- `/mcp` is the MCP endpoint.
|
||||
- `/docs/` is the pre-built documentation site.
|
||||
|
||||
The root URL redirects to the website.
|
||||
|
||||
## Content Types
|
||||
|
||||
The server publishes three kinds of Markdown content:
|
||||
|
||||
- **Skills** are reusable guidance that clients read as `skill://` resources.
|
||||
- **Prompts** are parameterized workflows that clients invoke as MCP prompts.
|
||||
- **Documentation** is available to clients through `resource://docs/...` and to people on the website.
|
||||
|
||||
FastMCP provides the MCP behavior. FastAPI hosts that server beside the static site, and Zensical builds the site from the same Markdown files.
|
||||
|
||||
## Source Of Truth
|
||||
|
||||
All authored content lives under `src/personal_mcp/docs/`. The generated `src/personal_mcp/site/` directory is build output and should not be edited by hand.
|
||||
|
||||
For exact file formats and URI rules, see the [content contracts](./contracts/index.md). For everyday changes, start with the [Authoring Guide](./authoring.md).
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
icon: lucide/pencil
|
||||
---
|
||||
|
||||
# Authoring Guide
|
||||
|
||||
All authored content lives under `src/personal_mcp/docs/`. The same files feed the MCP server and the documentation website.
|
||||
|
||||
## Source Tree Ownership
|
||||
|
||||
```text
|
||||
src/personal_mcp/docs/
|
||||
*.md # General documentation
|
||||
prompts/<prompt-id>/
|
||||
PROMPT.md # One MCP prompt
|
||||
skills/<skill-name>/
|
||||
SKILL.md # Main skill guidance
|
||||
references/ # Optional supporting material
|
||||
```
|
||||
|
||||
Do not edit `src/personal_mcp/site/` by hand. It is generated by Zensical.
|
||||
|
||||
## Documentation Pages
|
||||
|
||||
Add general documentation as Markdown under `src/personal_mcp/docs/`. Use relative links between pages. Top-level pages need an `icon` in their frontmatter, and navigation changes belong in `zensical.toml`.
|
||||
|
||||
## Skill Authoring
|
||||
|
||||
Skills follow the [Agent Skills specification](https://agentskills.io/specification). Each skill is a directory containing a required `SKILL.md` file with YAML frontmatter and Markdown instructions:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: <skill-name>
|
||||
description: <what this skill covers and when to use it>
|
||||
---
|
||||
```
|
||||
|
||||
The specification requires:
|
||||
|
||||
1. `name` must match the directory name, contain 1-64 lowercase letters, numbers, or hyphens, and have no leading, trailing, or consecutive hyphens.
|
||||
2. `description` must contain 1-1024 characters and explain both what the skill does and when an agent should use it.
|
||||
3. The body of `SKILL.md` must contain the instructions an agent needs after selecting the skill.
|
||||
|
||||
This repository adds two narrower conventions: names start with a letter, and frontmatter contains only the required `name` and `description`. The specification also defines optional `license`, `compatibility`, `metadata`, and experimental `allowed-tools` fields, but they are not part of this repository's current [Skill Contract](./contracts/skill_contract.md).
|
||||
|
||||
Write skills for progressive disclosure. Keep discovery information in the frontmatter, the main workflow in `SKILL.md`, and detailed material in focused files under `references/`. Link to supporting files with paths relative to the skill root, and avoid chains of references that require an agent to open several files before finding the useful content.
|
||||
|
||||
The Agent Skills specification also permits `scripts/`, `assets/`, and other supporting directories. This project is primarily a guidance library, so prefer `references/` unless the skill genuinely needs executable or static resources.
|
||||
|
||||
[FastMCP's Skills Provider](https://gofastmcp.com/servers/providers/skills) publishes each compliant directory as MCP resources, including the main file, a generated manifest, and any supporting files. The specification's [`skills-ref` validator](https://github.com/agentskills/agentskills/tree/main/skills-ref) can validate an individual skill before the repository-wide checks run.
|
||||
|
||||
## Prompt Authoring
|
||||
|
||||
A prompt is one `PROMPT.md` file under `src/personal_mcp/docs/prompts/<prompt-id>/`. Its `prompt` frontmatter describes the workflow and arguments; its Markdown body contains the instructions.
|
||||
|
||||
Use each declared argument as a `{{placeholder}}` in the body. The server validates prompt metadata and placeholders when the prompt is discovered.
|
||||
|
||||
The [Prompt Contract](./contracts/prompt.md) and [Frontmatter Contract](./contracts/frontmatter.md) contain the exact schema.
|
||||
|
||||
## Validate Changes
|
||||
|
||||
```bash
|
||||
uv run zensical build
|
||||
uv run ruff check .
|
||||
uv run ty check
|
||||
uv run pytest
|
||||
```
|
||||
|
||||
Restart a running server after changing content so every surface reads the latest package data.
|
||||
|
||||
For detailed rules, see the [content contracts](./contracts/index.md). For writing and site features, use the [Zensical documentation skill](./skills/zensical-docs/SKILL.md).
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
icon: lucide/braces
|
||||
---
|
||||
|
||||
# Frontmatter Contract
|
||||
|
||||
This page defines frontmatter ownership for native skills and prompt documentation.
|
||||
|
||||
## Skill Frontmatter
|
||||
|
||||
Skills use the standard Agent Skills fields consumed by the [FastMCP Skills Provider](https://gofastmcp.com/servers/providers/skills):
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: <skill-id>
|
||||
description: <what the skill does and when to use it>
|
||||
---
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
1. `name` and `description` are required.
|
||||
2. `name` must equal the skill directory name.
|
||||
3. The repository uses lowercase kebab-case directory names.
|
||||
4. Skill frontmatter contains no `x-personal-mcp` catalog metadata.
|
||||
5. Supporting files require no frontmatter manifest. The provider discovers files recursively and generates `_manifest` with relative paths, byte sizes, and SHA256 hashes.
|
||||
|
||||
The provider uses the directory name as the URI identity and the frontmatter `description` as the main resource description. Repository tests enforce directory/name parity and reject extra skill frontmatter fields.
|
||||
|
||||
## Prompt Documentation Frontmatter
|
||||
|
||||
Each prompt stores runtime metadata in a nested `prompt` mapping beside fields consumed by the static documentation site. The runtime mapping uses this shape:
|
||||
|
||||
```yaml
|
||||
---
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Describe when to use the prompt.
|
||||
tags: [example, prompts]
|
||||
arguments: {topic: {description: "Topic to process.", required: true, choices: [first, second]}, notes: {description: "Optional constraints.", required: false}}
|
||||
---
|
||||
```
|
||||
|
||||
Prompt rules:
|
||||
|
||||
1. `version`, `description`, `tags`, and `arguments` are required; unknown fields inside `prompt` or an argument are rejected.
|
||||
2. The directory name supplies the prompt id. Do not add a duplicate `name` field.
|
||||
3. Argument names must be valid identifiers and preserve their authored mapping order.
|
||||
4. Every argument requires a non-empty `description` and explicit `required` boolean.
|
||||
5. Optional `choices` must be a non-empty list of unique, non-empty strings.
|
||||
6. Markdown placeholders must exactly match the declared argument names.
|
||||
7. Top-level fields such as `icon` remain owned by the documentation site and are not runtime prompt metadata.
|
||||
|
||||
See the MCP [prompts concept documentation](https://modelcontextprotocol.io/docs/learn/server-concepts#prompts) and [schema reference](https://modelcontextprotocol.io/specification/latest/schema) for the protocol-level prompt shape.
|
||||
|
||||
## Validation Timing
|
||||
|
||||
Skill validation is file- and provider-oriented:
|
||||
|
||||
1. `SkillsDirectoryProvider` discovers each directory containing `SKILL.md`.
|
||||
2. FastMCP parses the description and scans all files when the provider is created.
|
||||
3. Repository tests enforce the stricter standard-only frontmatter and directory/name rules.
|
||||
|
||||
Prompt validation is provider- and renderer-oriented. Every list or get request reloads and validates the authored files. A malformed definition fails the request instead of publishing a partial prompt set.
|
||||
|
||||
## Invariants
|
||||
|
||||
1. Skills remain directly portable to tools that understand standard Agent Skills directories.
|
||||
2. Native skill discovery has no parallel catalog metadata source.
|
||||
3. Prompts use FastMCP's native component metadata and protocol surface without a parallel catalog or Python component file.
|
||||
4. All authored content remains under `src/personal_mcp/docs/`.
|
||||
@@ -21,13 +21,13 @@ This page defines the authored content contract for the docs-first MCP architect
|
||||
|
||||
## Canonical Source Of Truth
|
||||
|
||||
1. All authored Markdown lives under `docs/`.
|
||||
1. All authored Markdown lives under `src/personal_mcp/docs/`.
|
||||
2. MCP resources and static docs are two distribution surfaces of the same authored files.
|
||||
3. No parallel authored markdown is allowed in `src/` or other package-only paths.
|
||||
3. No parallel authored Markdown is allowed in a root `docs/` directory or another source tree.
|
||||
|
||||
## Canonical Content Shape
|
||||
|
||||
Authored content is organized under `docs/`:
|
||||
Authored content is organized under `src/personal_mcp/docs/`:
|
||||
|
||||
```mermaid
|
||||
---
|
||||
@@ -41,7 +41,7 @@ config:
|
||||
lineColor: '#FFFFFF'
|
||||
---
|
||||
treeView-beta
|
||||
"docs/"
|
||||
"src/personal_mcp/docs/"
|
||||
"*.md (top-level docs pages)"
|
||||
"contracts/"
|
||||
"prompt.md"
|
||||
@@ -59,9 +59,9 @@ treeView-beta
|
||||
|
||||
## File Placement And Ownership Boundaries
|
||||
|
||||
1. Top-level project docs stay in `docs/*.md`.
|
||||
2. Skill docs stay in `docs/skills/<skill-id>/...`.
|
||||
3. Prompt docs stay in `docs/prompts/<prompt-id>/...`.
|
||||
1. Top-level project docs stay in `src/personal_mcp/docs/*.md`.
|
||||
2. Skill docs stay in `src/personal_mcp/docs/skills/<skill-id>/...`.
|
||||
3. Prompt docs stay in `src/personal_mcp/docs/prompts/<prompt-id>/...`.
|
||||
4. A skill or prompt may link across sections, but must not store content in another artifact's directory.
|
||||
5. Server and runtime code may index and serve docs, but must not be the source of authored markdown.
|
||||
|
||||
@@ -74,7 +74,7 @@ treeView-beta
|
||||
|
||||
This contract guarantees:
|
||||
|
||||
1. One authored source tree in `docs/` for both website and MCP.
|
||||
1. One authored source tree in `src/personal_mcp/docs/` for both website and MCP.
|
||||
2. Skill and prompt artifacts remain path-stable within their own sections.
|
||||
3. Cross-surface publishing remains deterministic because authored content paths are canonical.
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
icon: lucide/messages-square
|
||||
---
|
||||
|
||||
# Prompt Contract
|
||||
|
||||
This page defines the canonical contract for declarative prompts published through a custom [FastMCP provider](https://gofastmcp.com/servers/providers/custom).
|
||||
|
||||
## Canonical Prompt Shape
|
||||
|
||||
Each prompt is one self-describing Markdown document:
|
||||
|
||||
```mermaid
|
||||
---
|
||||
config:
|
||||
treeView:
|
||||
rowIndent: 20
|
||||
lineThickness: 2
|
||||
themeVariables:
|
||||
treeView:
|
||||
labelColor: '#FFFFFF'
|
||||
lineColor: '#FFFFFF'
|
||||
---
|
||||
treeView-beta
|
||||
"src/personal_mcp/docs/prompts/"
|
||||
"<prompt-id>/"
|
||||
"PROMPT.md"
|
||||
"src/personal_mcp/prompts/"
|
||||
"content.py"
|
||||
"models.py"
|
||||
"provider.py"
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
1. The parent directory name defines the public prompt id.
|
||||
2. The nested `prompt` frontmatter block defines version, description, tags, and arguments.
|
||||
3. Argument declarations define names, descriptions, requiredness, and optional string choices.
|
||||
4. The Markdown body owns the rendered prompt prose and uses `{{argument_name}}` placeholders.
|
||||
5. Declared arguments and body placeholders must match exactly.
|
||||
6. No Python file is added when authoring a prompt.
|
||||
|
||||
## Ownership Boundary
|
||||
|
||||
1. Each `PROMPT.md` owns both its runtime metadata and prose.
|
||||
2. Python owns only generic parsing, validation, rendering, and provider behavior.
|
||||
3. There is no central prompt catalog, generated signature, or metadata sidecar.
|
||||
4. The provider scans direct children of packaged `personal_mcp/docs/prompts/` on each list or get request.
|
||||
5. Additions, edits, and deletions become visible on the next request without restarting the server.
|
||||
6. Reload is pull-based; the provider does not watch files or emit proactive change notifications.
|
||||
|
||||
## Prompt Id Contract
|
||||
|
||||
`prompt-id` is the public identifier and should satisfy all rules below:
|
||||
|
||||
1. Format: lowercase kebab-case only.
|
||||
2. Character set: `a-z`, `0-9`, and `-`.
|
||||
3. Must start with a letter.
|
||||
4. No underscores, spaces, dots, or uppercase characters.
|
||||
5. Directory name should equal `prompt-id` in each committed revision.
|
||||
6. The provider derives the prompt name from the directory; frontmatter must not duplicate it.
|
||||
7. Treat `prompt-id` as immutable after release; a rename is a breaking replacement.
|
||||
|
||||
Valid examples:
|
||||
|
||||
1. `pytest-fill-scaffold`
|
||||
2. `review-pr-comments`
|
||||
3. `scaffold-fastapi-service`
|
||||
|
||||
Invalid examples:
|
||||
|
||||
1. `fill_pytest_scaffold`
|
||||
2. `Prompt-Template`
|
||||
3. `docs.prompt`
|
||||
|
||||
## Rendering Contract
|
||||
|
||||
1. The loader requires one leading YAML frontmatter block and validates its nested `prompt` mapping strictly.
|
||||
2. All MCP arguments are strings; `choices` optionally restricts accepted values.
|
||||
3. Missing required arguments, unknown arguments, and invalid choices fail before rendering.
|
||||
4. An omitted optional value renders as `Not provided`.
|
||||
5. Unknown prompt ids, malformed metadata, and mismatched placeholders fail immediately.
|
||||
6. Prompt content is read through [importlib resources](https://docs.python.org/3/library/importlib.resources.html) and does not depend on the working directory.
|
||||
|
||||
+17
-7
@@ -8,7 +8,7 @@ This page defines the canonical contract for skills in the docs-first MCP archit
|
||||
|
||||
## Canonical Skill Shape
|
||||
|
||||
Each skill is one directory under `docs/skills/`:
|
||||
Each skill is one directory under `src/personal_mcp/docs/skills/`:
|
||||
|
||||
```mermaid
|
||||
---
|
||||
@@ -22,7 +22,7 @@ config:
|
||||
lineColor: '#FFFFFF'
|
||||
---
|
||||
treeView-beta
|
||||
"docs/"
|
||||
"src/personal_mcp/docs/"
|
||||
"... (other docs)"
|
||||
"skills/"
|
||||
"<skill-id>/"
|
||||
@@ -40,9 +40,9 @@ Rules:
|
||||
|
||||
## Metadata Location Constraint
|
||||
|
||||
1. Skill metadata is embedded in YAML frontmatter in `SKILL.md`.
|
||||
2. No `metadata.yaml` sidecar exists in the end state.
|
||||
3. Reference lookup metadata is documented and explicit: top-level `references/*.md` are auto-discovered from filenames, while `SKILL.md` frontmatter declares overrides and nested mappings when needed.
|
||||
1. `SKILL.md` frontmatter contains only standard `name` and `description` fields.
|
||||
2. No `metadata.yaml` sidecar or repository-specific skill metadata block exists.
|
||||
3. The provider discovers supporting files recursively; their real relative paths are published in the generated `_manifest`.
|
||||
|
||||
## Skill Id Contract
|
||||
|
||||
@@ -52,8 +52,8 @@ Rules:
|
||||
2. Character set: `a-z`, `0-9`, and `-`.
|
||||
3. Must start with a letter.
|
||||
4. No underscores, spaces, dots, or uppercase characters.
|
||||
5. Directory name should equal `skill-id` in each committed revision.
|
||||
6. Frontmatter `id` should equal directory name in each committed revision.
|
||||
5. Directory name equals `skill-id` in each committed revision.
|
||||
6. Frontmatter `name` equals the directory name.
|
||||
7. Treat `skill-id` as immutable after release; any rename is a breaking replacement and clients must move to the new id.
|
||||
|
||||
Valid examples:
|
||||
@@ -68,6 +68,16 @@ Invalid examples:
|
||||
2. `Zensical-Docs`
|
||||
3. `docs.zensical`
|
||||
|
||||
## Provider Publication
|
||||
|
||||
[`SkillsDirectoryProvider`](https://gofastmcp.com/servers/providers/skills) scans packaged `personal_mcp/docs/skills/` with `supporting_files="template"` and publishes:
|
||||
|
||||
1. `skill://<skill-id>/SKILL.md`
|
||||
2. `skill://<skill-id>/_manifest`
|
||||
3. `skill://<skill-id>/{path*}` for supporting files
|
||||
|
||||
Only the main file and manifest appear in `resources/list`. Clients inspect the manifest before reading supporting paths.
|
||||
|
||||
## Direct Documentation Inclusion
|
||||
|
||||
1. For direct API documentation, use mkdocstrings directives rather than pasting large code blocks.
|
||||
@@ -0,0 +1,77 @@
|
||||
---
|
||||
icon: lucide/link
|
||||
---
|
||||
|
||||
# URI Contract
|
||||
|
||||
This page defines the public resource URI contract for native skills and general authored documentation.
|
||||
|
||||
## Native Skill URIs
|
||||
|
||||
The [FastMCP Skills Provider](https://gofastmcp.com/servers/providers/skills) publishes each skill through the `skill://` scheme:
|
||||
|
||||
1. `skill://<skill-name>/SKILL.md`
|
||||
2. `skill://<skill-name>/_manifest`
|
||||
3. `skill://<skill-name>/<supporting-path>`
|
||||
|
||||
The first two are concrete resources returned by `resources/list`. Supporting files use a per-skill wildcard resource template when the provider is configured with `supporting_files="template"`:
|
||||
|
||||
```text
|
||||
skill://<skill-name>/{path*}
|
||||
```
|
||||
|
||||
### Main File
|
||||
|
||||
`skill://<skill-name>/SKILL.md` returns the canonical authored skill document. The skill directory name supplies `<skill-name>`, and the resource description comes from `SKILL.md` frontmatter.
|
||||
|
||||
### Manifest
|
||||
|
||||
`skill://<skill-name>/_manifest` returns JSON containing the skill name and every file beneath its directory. Each file entry includes:
|
||||
|
||||
1. relative POSIX path
|
||||
2. byte size
|
||||
3. SHA256 hash
|
||||
|
||||
Clients read the manifest before requesting supporting files. FastMCP client utilities such as `list_skills()` and `get_skill_manifest()` understand this contract directly.
|
||||
|
||||
### Supporting Files
|
||||
|
||||
Supporting files retain their real skill-relative paths. For example:
|
||||
|
||||
```text
|
||||
skill://pytesting/references/pytest-docs.md
|
||||
```
|
||||
|
||||
FastMCP confines reads to the selected skill directory. Absolute paths, traversal outside the directory, missing files, directories, and symlinks that resolve outside the skill root are rejected.
|
||||
|
||||
## General Docs URI
|
||||
|
||||
General authored documentation is exposed through `resource://docs/{path*}`. The wildcard accepts normalized relative POSIX Markdown paths beneath packaged `personal_mcp/docs/`, excludes the provider-owned `skills/` subtree, and rejects absolute paths, traversal segments, backslashes, and non-Markdown targets.
|
||||
|
||||
Prompts are MCP prompt components rather than resources. Clients discover them with the protocol `prompts/list` operation and render them with `prompts/get`.
|
||||
|
||||
## Discovery Order
|
||||
|
||||
For skills:
|
||||
|
||||
1. list resources or call FastMCP `list_skills()`
|
||||
2. select a skill by name and description
|
||||
3. read `skill://<skill-name>/SKILL.md`
|
||||
4. read `_manifest` when supporting material may be needed
|
||||
5. fetch only the supporting paths relevant to the task
|
||||
|
||||
For prompts, use the native MCP prompt APIs.
|
||||
|
||||
## Stability Policy
|
||||
|
||||
The provider and protocol surfaces documented here are the complete public contract. Contract changes replace the affected surface directly.
|
||||
|
||||
Skill renames are breaking because the directory name is part of every native skill URI. Supporting-file renames change the corresponding manifest path and URI.
|
||||
|
||||
## Sources
|
||||
|
||||
1. [FastMCP Skills Provider](https://gofastmcp.com/servers/providers/skills)
|
||||
2. [MCP resources](https://modelcontextprotocol.io/specification/latest/server/resources)
|
||||
3. [RFC 3986 URI syntax](https://www.rfc-editor.org/rfc/rfc3986)
|
||||
4. [RFC 6570 URI templates](https://www.rfc-editor.org/rfc/rfc6570)
|
||||
5. [FastMCP prompts](https://gofastmcp.com/servers/prompts)
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
icon: lucide/bot
|
||||
---
|
||||
|
||||
# Using With GitHub Copilot
|
||||
|
||||
Once Personal MCP is configured as a VS Code MCP server, Copilot can use its resources, prompts, and read-only tools.
|
||||
|
||||
For general connection details, see [Using Personal MCP](./usage.md). For VS Code setup options, see [Add and manage MCP servers](https://code.visualstudio.com/docs/agent-customization/mcp-servers).
|
||||
|
||||
## Skills And Documentation
|
||||
|
||||
Use **MCP: Browse Resources** to inspect the server's resources. Skills appear as `skill://<name>/SKILL.md`; general pages appear under `resource://docs/...`.
|
||||
|
||||
For a task that needs guidance:
|
||||
|
||||
1. choose the skill whose description best matches the task
|
||||
2. read its main `SKILL.md`
|
||||
3. read `_manifest` only when supporting material is needed
|
||||
4. attach or read only the relevant supporting files
|
||||
|
||||
When the current chat surface supports MCP resource attachments, the same resources are available from **Add Context**.
|
||||
|
||||
## Prompts
|
||||
|
||||
Personal MCP prompts appear as `/<server>.<prompt>` chat commands. Select a command and fill in its arguments to start the workflow. Arguments with a fixed list of choices offer completion as you type.
|
||||
|
||||
## Automatic Use
|
||||
|
||||
Copilot can use four fallback tools when the chat surface does not expose resources or prompts directly:
|
||||
|
||||
- `list_resources` and `read_resource`
|
||||
- `list_prompts` and `get_prompt`
|
||||
|
||||
These tools access the same content as the native features. A repository instruction can guide Copilot toward the intended order:
|
||||
|
||||
```text
|
||||
When a task matches a personal-mcp skill:
|
||||
1. Prefer an attached skill resource, or browse resources and choose one by description.
|
||||
2. Read its main file and load supporting material only when needed.
|
||||
3. Reconcile the guidance with the current repository before editing.
|
||||
```
|
||||
|
||||
Instructions guide resource use but do not force VS Code to attach resources automatically.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
1. Use `MCP: List Servers` to confirm the server is enabled.
|
||||
2. Use `MCP: Browse Resources` to confirm resources are available.
|
||||
3. Restart the MCP server after changing its content.
|
||||
4. Reload the VS Code window if the server is healthy but the resource or tool list remains stale.
|
||||
|
||||
## Further Reading
|
||||
|
||||
1. [VS Code MCP configuration](https://code.visualstudio.com/docs/agents/reference/mcp-configuration)
|
||||
2. [Managing context in VS Code](https://code.visualstudio.com/docs/chat/copilot-chat-context)
|
||||
3. [Using Personal MCP](./usage.md)
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
icon: lucide/rocket
|
||||
---
|
||||
|
||||
# Personal MCP
|
||||
|
||||
Personal MCP is a library of software development guidance for people and AI assistants. Content is written once in Markdown and published as both a documentation website and an MCP server.
|
||||
|
||||
## What It Provides
|
||||
|
||||
- **Skills** provide focused guidance for development tasks.
|
||||
- **Prompts** provide reusable workflows with named inputs.
|
||||
- **Documentation** makes the same material easy to browse and maintain.
|
||||
|
||||
The HTTP service exposes the [MCP](https://modelcontextprotocol.io/docs/getting-started/intro) endpoint at `/mcp` and the website at `/docs/`.
|
||||
|
||||
## Quick Start
|
||||
|
||||
Install dependencies, build the website, and start the server:
|
||||
|
||||
```bash
|
||||
uv sync
|
||||
uv run zensical build
|
||||
uv run personal-mcp --host 127.0.0.1 --port 8765
|
||||
```
|
||||
|
||||
Then open `http://127.0.0.1:8765/docs/` or connect an MCP client to `http://127.0.0.1:8765/mcp`.
|
||||
|
||||
The MCP server can also run over standard input and output:
|
||||
|
||||
```bash
|
||||
uv run mcp-stdio
|
||||
```
|
||||
|
||||
For Docker:
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
## Read Next
|
||||
|
||||
- [Using Personal MCP](./usage.md)
|
||||
- [Authoring Guide](./authoring.md)
|
||||
- [Architecture](./architecture.md)
|
||||
- [Running the Server](./mcp_layout.md)
|
||||
- [Testing](./testing.md)
|
||||
- [Security](./securing.md)
|
||||
- [Content Contracts](./contracts/index.md)
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
icon: lucide/server
|
||||
---
|
||||
|
||||
# Running The Server
|
||||
|
||||
Personal MCP can run as an HTTP service or as a local stdio process.
|
||||
|
||||
## Local HTTP Server
|
||||
|
||||
Build the website before starting the application:
|
||||
|
||||
```bash
|
||||
uv sync
|
||||
uv run zensical build
|
||||
uv run personal-mcp --host 127.0.0.1 --port 8765
|
||||
```
|
||||
|
||||
The server then provides:
|
||||
|
||||
- `http://127.0.0.1:8765/docs/` for the website
|
||||
- `http://127.0.0.1:8765/mcp` for MCP clients
|
||||
|
||||
The host, port, log level, debug mode, and reload behavior can be set with command-line options or `PERSONAL_MCP_` environment variables.
|
||||
|
||||
## Local Stdio Server
|
||||
|
||||
For clients that manage the server process themselves:
|
||||
|
||||
```bash
|
||||
uv run mcp-stdio
|
||||
```
|
||||
|
||||
This mode provides MCP only; it does not host the website.
|
||||
|
||||
## Docker
|
||||
|
||||
The included Compose configuration builds the website into the image and publishes the service on port `8765`:
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
For a remote deployment, place the service behind a reverse proxy and review the [security guidance](./securing.md).
|
||||
+19
-29
@@ -1,33 +1,21 @@
|
||||
---
|
||||
name: authoring
|
||||
description: Provide a practical checklist and baseline template for authoring docs-first MCP modules and repository-specific Copilot instruction shims.
|
||||
x-personal-mcp:
|
||||
id: authoring
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- authoring
|
||||
- mcp
|
||||
- fastmcp
|
||||
- copilot
|
||||
- prompts
|
||||
- scaffolding
|
||||
capabilities:
|
||||
- resource://prompts/authoring/document
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Provide a practical checklist and baseline template for authoring docs-first MCP modules and repository-specific Copilot instruction shims.
|
||||
tags: [authoring, mcp, fastmcp, copilot, prompts, scaffolding]
|
||||
arguments:
|
||||
artifact_type:
|
||||
title: Artifact type
|
||||
description: "Enum (case-sensitive): skill | prompt | shim."
|
||||
description: Artifact type to create.
|
||||
required: true
|
||||
choices: [skill, prompt, shim]
|
||||
artifact_id:
|
||||
title: Artifact id
|
||||
description: Lowercase kebab-case id for the module or shim.
|
||||
required: true
|
||||
goal:
|
||||
title: Goal
|
||||
description: One-sentence capability statement describing what to create and when to use it.
|
||||
description: One-sentence capability statement.
|
||||
required: true
|
||||
scope_glob:
|
||||
title: Scope glob
|
||||
description: Optional applyTo glob for shim outputs.
|
||||
required: false
|
||||
---
|
||||
@@ -36,6 +24,13 @@ x-personal-mcp:
|
||||
|
||||
Use this prompt to author or update docs-first MCP modules in this repository, including repository-specific Copilot thin shims.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `artifact_type`: {{artifact_type}}
|
||||
- `artifact_id`: {{artifact_id}}
|
||||
- `goal`: {{goal}}
|
||||
- `scope_glob`: {{scope_glob}}
|
||||
|
||||
## Inputs
|
||||
|
||||
1. artifact_type: one of skill, prompt, shim
|
||||
@@ -51,7 +46,7 @@ Load only what matches the requested artifact:
|
||||
2. Prompt metadata and structure: [Prompt Contract](../../contracts/prompt.md)
|
||||
3. Skill metadata and structure (only for skill outputs): [Skill Contract](../../contracts/skill_contract.md)
|
||||
4. Thin shim mechanics and path binding: [Skill Usage Mechanics](../../usage.md)
|
||||
5. Copilot resource attachment and fallback behavior: [Copilot MCP Mechanics](../../copilot.md)
|
||||
5. Copilot resource attachment behavior: [Copilot MCP Mechanics](../../copilot.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
@@ -69,14 +64,9 @@ Load only what matches the requested artifact:
|
||||
7. Produce only the requested artifact type.
|
||||
8. Keep guidance deterministic and minimal, with explicit references to source docs.
|
||||
9. If artifact_type is shim:
|
||||
- bind one applyTo scope to one primary skill resource URI
|
||||
- prefer MCP resource attachment first
|
||||
- if resource attachment is unavailable, use fallback tool order:
|
||||
1. list_resources
|
||||
2. read_resource
|
||||
3. search_patterns
|
||||
4. get_pattern_by_id
|
||||
5. get_skill_document_by_id
|
||||
- bind one applyTo scope to one `skill://<name>/SKILL.md` resource URI
|
||||
- use MCP resource attachment
|
||||
- inspect the selected skill's `_manifest` only when supporting material is needed
|
||||
10. Return created or updated file paths and any validation commands that should be run.
|
||||
|
||||
## Output Contract
|
||||
+26
-31
@@ -1,41 +1,36 @@
|
||||
---
|
||||
name: greenfield-architecture
|
||||
description: Research established patterns and design a high-level architecture for a new app or library with explicit tradeoffs and test strategy.
|
||||
x-personal-mcp:
|
||||
id: greenfield-architecture
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- architecture
|
||||
- planning
|
||||
- greenfield
|
||||
- design
|
||||
- testing
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/greenfield-architecture/document
|
||||
arguments:
|
||||
scope_type:
|
||||
title: Scope type
|
||||
description: "Scope type: app or library."
|
||||
required: true
|
||||
intent_document:
|
||||
title: Intent document
|
||||
description: Optional full document describing goals, context, and desired outcomes.
|
||||
required: false
|
||||
problem_domain:
|
||||
title: Problem domain
|
||||
description: Domain and business goal for the new app or library when no full intent document is provided.
|
||||
required: false
|
||||
constraints:
|
||||
title: Constraints
|
||||
description: Runtime, deployment, and non-functional constraints.
|
||||
required: false
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Research established patterns and design a high-level architecture for a new app or library with explicit tradeoffs and test strategy.
|
||||
tags: [architecture, planning, greenfield, design, testing, prompts]
|
||||
arguments:
|
||||
scope_type:
|
||||
description: Scope type to design.
|
||||
required: true
|
||||
choices: [app, library]
|
||||
intent_document:
|
||||
description: Optional full document describing goals and context.
|
||||
required: false
|
||||
problem_domain:
|
||||
description: Problem domain and business goal.
|
||||
required: false
|
||||
constraints:
|
||||
description: Runtime, deployment, and non-functional constraints.
|
||||
required: false
|
||||
---
|
||||
|
||||
# Greenfield Architecture Planner
|
||||
|
||||
Use this prompt to design a new software app or library architecture in generic terms.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `scope_type`: {{scope_type}}
|
||||
- `intent_document`: {{intent_document}}
|
||||
- `problem_domain`: {{problem_domain}}
|
||||
- `constraints`: {{constraints}}
|
||||
|
||||
## Inputs
|
||||
|
||||
1. intent_document: optional full document that explains goals, context, constraints, and desired outcomes
|
||||
+17
-15
@@ -1,25 +1,27 @@
|
||||
---
|
||||
name: jsfiddle-page-layout
|
||||
description: Create a responsive sample page layout for a user-supplied domain and return paste-ready HTML and CSS for JSFiddle.
|
||||
x-personal-mcp:
|
||||
id: jsfiddle-page-layout
|
||||
version: 1.1.0
|
||||
tags:
|
||||
- frontend
|
||||
- html
|
||||
- css
|
||||
- jsfiddle
|
||||
- layout
|
||||
- prototyping
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/jsfiddle-page-layout/document
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.1.0"
|
||||
description: Create a responsive sample page layout for a user-supplied domain and return paste-ready HTML and CSS for JSFiddle.
|
||||
tags: [frontend, html, css, jsfiddle, layout, prototyping, prompts]
|
||||
arguments:
|
||||
domain:
|
||||
description: Product, service, organization, or subject represented by the page.
|
||||
required: true
|
||||
layout_brief:
|
||||
description: Optional page type, sections, priorities, or visual constraints.
|
||||
required: false
|
||||
---
|
||||
|
||||
# JSFiddle Page Layout
|
||||
|
||||
Create a polished sample page layout for the supplied domain. The result must run by pasting the markup and styles into the [JSFiddle](https://jsfiddle.net/) HTML and CSS panes.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `domain`: {{domain}}
|
||||
- `layout_brief`: {{layout_brief}}
|
||||
|
||||
## Inputs
|
||||
|
||||
1. `domain`: the product, service, organization, or subject represented by the page, including its intended audience when known
|
||||
+27
-37
@@ -1,29 +1,21 @@
|
||||
---
|
||||
name: mcp-consumer-repo-shim
|
||||
description: Create one repository-specific thin shim instruction file that binds a file scope to a user-selected Personal MCP skill resource and enforces resource-first Copilot retrieval behavior.
|
||||
x-personal-mcp:
|
||||
id: mcp-consumer-repo-shim
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- copilot
|
||||
- mcp
|
||||
- instructions
|
||||
- shims
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/mcp-consumer-repo-shim/document
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Create one repository-specific thin shim instruction file that binds a file scope to a user-selected Personal MCP skill resource.
|
||||
tags: [copilot, mcp, instructions, shims, prompts]
|
||||
arguments:
|
||||
apply_to_glob:
|
||||
description: File glob scope for the shim applyTo field, such as tests/** or **/*.md.
|
||||
description: File glob scope for the shim applyTo field.
|
||||
required: true
|
||||
primary_skill_resource:
|
||||
description: Primary skill resource URI, usually resource://skills/<skill-id>/document.
|
||||
description: Primary native skill:// resource URI.
|
||||
required: true
|
||||
shim_title:
|
||||
description: Human-readable name for the instruction shim frontmatter.
|
||||
description: Optional human-readable instruction shim name.
|
||||
required: false
|
||||
companion_docs_page:
|
||||
description: Optional relative docs link for human-facing companion guidance.
|
||||
description: Optional relative companion documentation link.
|
||||
required: false
|
||||
---
|
||||
|
||||
@@ -31,6 +23,13 @@ x-personal-mcp:
|
||||
|
||||
Use this prompt to generate exactly one repository-scoped Copilot instruction shim for an MCP consumer repository.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `apply_to_glob`: {{apply_to_glob}}
|
||||
- `primary_skill_resource`: {{primary_skill_resource}}
|
||||
- `shim_title`: {{shim_title}}
|
||||
- `companion_docs_page`: {{companion_docs_page}}
|
||||
|
||||
## Inputs
|
||||
|
||||
- Required:
|
||||
@@ -45,30 +44,26 @@ Use this prompt to generate exactly one repository-scoped Copilot instruction sh
|
||||
Load only sections relevant to the requested shim:
|
||||
|
||||
1. Thin shim pattern and scope guidance: [Skill Usage Mechanics](../../usage.md)
|
||||
2. VS Code Copilot MCP behavior and fallback mechanics: [Copilot MCP Mechanics](../../copilot.md)
|
||||
2. VS Code Copilot MCP resource behavior: [Copilot MCP Mechanics](../../copilot.md)
|
||||
3. Authoring workflow and validation checklist: [Authoring Guide](../../authoring.md)
|
||||
4. Instruction metadata expectations and examples: [Copilot customization skill](../../skills/copilot-customization/SKILL.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Validate that apply_to_glob and primary_skill_resource are present.
|
||||
2. If either value is missing or ambiguous, ask exactly one clarifying question before generating output.
|
||||
3. Generate one .instructions.md file content block only.
|
||||
4. Keep the shim concise and deterministic:
|
||||
2. Validate that primary_skill_resource uses the `skill://<skill-name>/SKILL.md` form.
|
||||
3. If either value is missing or ambiguous, ask exactly one clarifying question before generating output.
|
||||
4. Generate one .instructions.md file content block only.
|
||||
5. Keep the shim concise and deterministic:
|
||||
- include YAML frontmatter with name, description, and applyTo
|
||||
- include a primary rule that uses the selected primary_skill_resource first
|
||||
- include a bounded execution pattern (load primary doc, apply only relevant sections, keep edits minimal)
|
||||
5. Include VS Code/Copilot integration mechanics in the shim body:
|
||||
- prefer MCP resource attachment when available
|
||||
- if attachment is unavailable, use tool fallback order:
|
||||
1. list_resources
|
||||
2. read_resource
|
||||
3. search_patterns
|
||||
4. get_pattern_by_id
|
||||
5. get_skill_document_by_id
|
||||
6. Include VS Code/Copilot integration mechanics in the shim body:
|
||||
- use MCP resource attachment
|
||||
- inspect `_manifest` only when the task needs supporting material
|
||||
- ask one clarifying question when confidence is low
|
||||
6. If companion_docs_page is provided, include it as a companion docs link line.
|
||||
7. Do not generate additional files, code changes, or batch shim packs.
|
||||
7. If companion_docs_page is provided, include it as a companion docs link line.
|
||||
8. Do not generate additional files, code changes, or batch shim packs.
|
||||
|
||||
## Output Format
|
||||
|
||||
@@ -98,12 +93,7 @@ Execution pattern:
|
||||
2. Apply only sections relevant to the file being edited.
|
||||
3. Keep edits minimal and aligned with repository conventions.
|
||||
4. Prefer MCP resource attachment when available in the current chat surface.
|
||||
5. If MCP resource attachment is unavailable, use tool fallback in this order:
|
||||
1. list_resources
|
||||
2. read_resource
|
||||
3. search_patterns
|
||||
4. get_pattern_by_id
|
||||
5. get_skill_document_by_id
|
||||
5. Read the selected skill's `_manifest` only when supporting material is needed.
|
||||
6. If confidence is low, ask one clarifying question before editing.
|
||||
|
||||
Companion docs page: <optional-relative-doc-link>
|
||||
+29
-34
@@ -1,41 +1,35 @@
|
||||
---
|
||||
name: nicegui-component-extraction
|
||||
description: Extract a user-selected component from a JSFiddle page layout and implement it as a reusable NiceGUI render function with responsive styling and typed bindable state where needed.
|
||||
x-personal-mcp:
|
||||
id: nicegui-component-extraction
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- nicegui
|
||||
- components
|
||||
- frontend
|
||||
- refactoring
|
||||
- jsfiddle
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/nicegui-component-extraction/document
|
||||
arguments:
|
||||
component:
|
||||
title: Component
|
||||
description: Component or page region to extract, identified by its visible label, semantic role, or selector.
|
||||
required: true
|
||||
source_layout:
|
||||
title: Source layout
|
||||
description: Optional HTML and CSS from the JSFiddle page layout prompt; when omitted, use the latest applicable output in the conversation.
|
||||
required: false
|
||||
target_location:
|
||||
title: Target location
|
||||
description: Optional target NiceGUI page, module, or package in which to create and integrate the component.
|
||||
required: false
|
||||
behavior_requirements:
|
||||
title: Behavior requirements
|
||||
description: Optional interactions, state, callbacks, or content variations the extracted component must support.
|
||||
required: false
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Extract a user-selected component from a JSFiddle page layout and implement it as a reusable NiceGUI render function.
|
||||
tags: [nicegui, components, frontend, refactoring, jsfiddle, prompts]
|
||||
arguments:
|
||||
component:
|
||||
description: Visible label, semantic role, or selector identifying the component.
|
||||
required: true
|
||||
source_layout:
|
||||
description: Optional source HTML and CSS.
|
||||
required: false
|
||||
target_location:
|
||||
description: Optional target NiceGUI page, module, or package.
|
||||
required: false
|
||||
behavior_requirements:
|
||||
description: Optional interactions, state, callbacks, or variations.
|
||||
required: false
|
||||
---
|
||||
|
||||
# NiceGUI Component Extraction
|
||||
|
||||
Extract one user-selected component from the output of the [JSFiddle Page Layout](../jsfiddle-page-layout/PROMPT.md) prompt and implement it as a reusable NiceGUI component in the target repository.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `component`: {{component}}
|
||||
- `source_layout`: {{source_layout}}
|
||||
- `target_location`: {{target_location}}
|
||||
- `behavior_requirements`: {{behavior_requirements}}
|
||||
|
||||
## Inputs
|
||||
|
||||
1. `component`: required visible label, semantic role, or selector identifying the component to extract
|
||||
@@ -47,10 +41,11 @@ If the selected component or source layout cannot be identified unambiguously, a
|
||||
|
||||
## Required References
|
||||
|
||||
Apply both references before implementation:
|
||||
Apply these references before implementation:
|
||||
|
||||
1. Component boundaries, responsive layout, Quasar props, Tailwind utilities, and shared CSS: [NiceGUI Page Layout and Styling](../../skills/nicegui/references/architecture-and-styling.md)
|
||||
2. Typed UI state, propagation, mutable defaults, binding strictness, and version checks: [Binding Dataclasses Deep Dive](../../skills/nicegui/references/binding-dataclasses.md)
|
||||
1. Package boundaries, dependency direction, and page or component ownership: [NiceGUI Application Architecture](../../skills/nicegui/references/architecture.md)
|
||||
2. Responsive layout, Quasar props, Tailwind utilities, and shared CSS: [NiceGUI Styling and Customization](../../skills/nicegui/references/styling-and-customization.md)
|
||||
3. Typed UI state, propagation, mutable defaults, binding strictness, and version checks: [Binding Dataclasses Deep Dive](../../skills/nicegui/references/binding-dataclasses.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
+26
-25
@@ -1,35 +1,36 @@
|
||||
---
|
||||
name: pytest-fill-scaffold
|
||||
description: Fill scaffolded pytest test methods with assertions, fixtures, and minimal test data while preserving concise test names and one-line intent docstrings.
|
||||
x-personal-mcp:
|
||||
id: pytest-fill-scaffold
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- pytest
|
||||
- testing
|
||||
- scaffolding
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/pytest-fill-scaffold/document
|
||||
arguments:
|
||||
target_files:
|
||||
description: Target test file paths under tests/.
|
||||
required: true
|
||||
stack:
|
||||
description: Runtime stack type for fixture and marker choices.
|
||||
required: true
|
||||
strategy:
|
||||
description: Balance between minimal and comprehensive implementation.
|
||||
required: false
|
||||
marker_lane:
|
||||
description: Preferred marker lane when applicable.
|
||||
required: false
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Fill scaffolded pytest methods with assertions, fixtures, and minimal test data while preserving reviewed structure.
|
||||
tags: [pytest, testing, scaffolding, prompts]
|
||||
arguments:
|
||||
target_files:
|
||||
description: Target test file paths under tests/.
|
||||
required: true
|
||||
stack:
|
||||
description: Runtime stack type for fixture and marker choices.
|
||||
required: true
|
||||
choices: [pure-python, fastapi, sqlalchemy-sync, sqlalchemy-async, mixed]
|
||||
strategy:
|
||||
description: Optional minimal or comprehensive implementation preference.
|
||||
required: false
|
||||
marker_lane:
|
||||
description: Optional pytest marker lane.
|
||||
required: false
|
||||
---
|
||||
|
||||
# Pytest Fill Scaffold
|
||||
|
||||
Use this prompt after test scaffolding exists and method names/docstrings are already in place.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `target_files`: {{target_files}}
|
||||
- `stack`: {{stack}}
|
||||
- `strategy`: {{strategy}}
|
||||
- `marker_lane`: {{marker_lane}}
|
||||
|
||||
## Inputs
|
||||
|
||||
- Target test file(s) under tests/.
|
||||
+17
-16
@@ -1,28 +1,22 @@
|
||||
---
|
||||
name: pytest-scaffold
|
||||
description: Plan and optionally scaffold pytest file and class structure for selected Python modules while preserving concise behavior-focused test names and one-line intent docstrings.
|
||||
x-personal-mcp:
|
||||
id: pytest-scaffold
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- pytest
|
||||
- testing
|
||||
- scaffolding
|
||||
- prompts
|
||||
capabilities:
|
||||
- resource://prompts/pytest-scaffold/document
|
||||
icon: lucide/messages-square
|
||||
prompt:
|
||||
version: "1.0.0"
|
||||
description: Plan and optionally scaffold pytest file and class structure for selected Python modules.
|
||||
tags: [pytest, testing, scaffolding, prompts]
|
||||
arguments:
|
||||
target_modules:
|
||||
description: Target module path(s) under src/.
|
||||
description: Target module paths under src/.
|
||||
required: true
|
||||
mode:
|
||||
description: Execution mode, either plan-only or scaffold.
|
||||
description: Whether to plan only or create scaffold files.
|
||||
required: true
|
||||
choices: [plan-only, scaffold]
|
||||
path_strategy:
|
||||
description: Optional mapping preference for src to tests paths.
|
||||
description: Optional src-to-tests path mapping preference.
|
||||
required: false
|
||||
naming_style:
|
||||
description: Optional preference for concise method naming style.
|
||||
description: Optional concise test naming preference.
|
||||
required: false
|
||||
---
|
||||
|
||||
@@ -30,6 +24,13 @@ x-personal-mcp:
|
||||
|
||||
Use this prompt to consistently plan and scaffold pytest test modules for selected Python source modules.
|
||||
|
||||
## Supplied Inputs
|
||||
|
||||
- `target_modules`: {{target_modules}}
|
||||
- `mode`: {{mode}}
|
||||
- `path_strategy`: {{path_strategy}}
|
||||
- `naming_style`: {{naming_style}}
|
||||
|
||||
## Inputs
|
||||
|
||||
- Required:
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
icon: lucide/shield-check
|
||||
---
|
||||
|
||||
# Security
|
||||
|
||||
## Public By Design
|
||||
|
||||
The application does not implement authentication. Its current purpose is to publish read-only guidance, so everything exposed through the server must be safe to make public.
|
||||
|
||||
This includes:
|
||||
|
||||
- the website under `/docs/`
|
||||
- resources and prompts under `/mcp`
|
||||
- the four read-only fallback tools
|
||||
|
||||
Do not add secrets, private notes, credentials, or sensitive environment details to the authored content.
|
||||
|
||||
## Remote Deployment
|
||||
|
||||
Place the service behind a reverse proxy or tunnel rather than exposing the container directly. The edge can provide TLS, rate limiting, access logs, and optional authentication without adding those concerns to this small application.
|
||||
|
||||
A simple deployment is:
|
||||
|
||||
```text
|
||||
Internet -> reverse proxy or tunnel -> personal-mcp
|
||||
```
|
||||
|
||||
The website and MCP endpoint can remain public while they contain only public, read-only content. Use edge authentication if access should be limited.
|
||||
|
||||
## When Authentication Becomes Required
|
||||
|
||||
Protect `/mcp` before adding any capability that can:
|
||||
|
||||
1. read non-public files
|
||||
2. access private data or credentials
|
||||
3. call authenticated services
|
||||
4. mutate data
|
||||
5. run commands
|
||||
6. perform expensive work
|
||||
|
||||
At that point, choose authentication based on the clients that need to connect. Edge authentication is the simplest option for a small trusted audience; standards-based MCP authorization is more appropriate when broad client interoperability is required.
|
||||
-15
@@ -1,21 +1,6 @@
|
||||
---
|
||||
name: async-fastapi-sqlmodel
|
||||
description: 'Explain and apply async database principles for FastAPI, SQLAlchemy 2.x, and SQLModel. Use when: learning or reviewing cached AsyncEngine and session-factory lifecycles, AsyncSession scopes and injection, FastAPI lifespan and yield dependencies, transaction boundaries, concurrency safety, implicit ORM I/O, pooling, testing, or SQLModel integration.'
|
||||
x-personal-mcp:
|
||||
id: async-fastapi-sqlmodel
|
||||
version: 1.2.0
|
||||
tags:
|
||||
- fastapi
|
||||
- sqlalchemy
|
||||
- sqlmodel
|
||||
- async
|
||||
- asyncio
|
||||
- database
|
||||
- transactions
|
||||
- resource-lifecycle
|
||||
- architecture
|
||||
capabilities:
|
||||
- resource://skills/async-fastapi-sqlmodel/document
|
||||
---
|
||||
|
||||
# Async FastAPI, SQLAlchemy, and SQLModel
|
||||
@@ -0,0 +1,239 @@
|
||||
---
|
||||
name: cli-client
|
||||
description: 'Design, implement, review, or refine Python command-line clients for remote APIs. Use for command structure, automation-friendly input and output, configuration, authentication, HTTP transport, pagination, retries, errors and exit codes, state-changing operations, packaging, or CLI testing.'
|
||||
---
|
||||
|
||||
# Python API CLI Clients
|
||||
|
||||
Use this skill as a conceptual reference for command-line applications that operate remote services. Preserve established project conventions, but make the command surface predictable for people, scripts, CI jobs, and shell composition.
|
||||
|
||||
## Design Priorities
|
||||
|
||||
A good API CLI should be:
|
||||
|
||||
- **Task-oriented:** commands reflect user goals rather than HTTP endpoints or internal service classes.
|
||||
- **Predictable:** names, flags, defaults, output, errors, and exit statuses behave consistently.
|
||||
- **Composable:** successful data goes to stdout, diagnostics go to stderr, and machine-readable output is stable.
|
||||
- **Safe:** destructive operations are explicit, retries respect operation semantics, and secrets never enter output or logs.
|
||||
- **Layered:** command parsing, application behavior, API resources, transport, authentication, and persistence have distinct owners.
|
||||
- **Inspectable:** users can discover commands and effective configuration without reading source code.
|
||||
|
||||
Use the [Command Line Interface Guidelines](https://clig.dev/) as the general human-interface baseline. Prefer the target project's established command framework and HTTP library over introducing replacements without a concrete need.
|
||||
|
||||
## Command Model
|
||||
|
||||
Design the command tree around a small, consistent grammar:
|
||||
|
||||
```text
|
||||
mycli <resource> <action> [arguments] [options]
|
||||
mycli projects list --owner alice
|
||||
mycli projects get PROJECT_ID
|
||||
mycli projects create --name NAME
|
||||
mycli projects delete PROJECT_ID
|
||||
```
|
||||
|
||||
- Use nouns for resource groups and familiar verbs for actions.
|
||||
- Keep equivalent operations parallel across resources: `list`, `get`, `create`, `update`, and `delete` should not change meaning by command group.
|
||||
- Prefer explicit positional arguments for primary identities and named options for modifiers.
|
||||
- Reserve global options for behavior that applies consistently across commands, such as profile, endpoint, output format, verbosity, and non-interactive mode.
|
||||
- Give every command useful `--help` output with a one-line purpose, argument meaning, defaults, and behavior-changing caveats.
|
||||
- Avoid mirroring every server endpoint. Combine low-level calls when one user task requires them, and omit endpoints that do not form a coherent CLI operation.
|
||||
|
||||
Do not make users memorize hidden context. When a command depends on an active account, project, region, or profile, make that context discoverable and overridable.
|
||||
|
||||
## Responsibility Boundaries
|
||||
|
||||
Keep the command layer thin and dependencies directional:
|
||||
|
||||
```text
|
||||
entry point and bootstrap
|
||||
└── command groups
|
||||
└── application services
|
||||
└── API client and resources
|
||||
└── authenticated HTTP transport
|
||||
└── HTTP library
|
||||
|
||||
configuration ───────────────┘
|
||||
credentials ──> authentication
|
||||
renderers <──── command results
|
||||
```
|
||||
|
||||
| Layer | Owns | Avoid |
|
||||
| --- | --- | --- |
|
||||
| Entry point | Dependency construction, top-level exception mapping, process exit | Business logic and API calls |
|
||||
| Command | Parsing, prompts, presentation, command-specific orchestration | Raw HTTP details and credential refresh |
|
||||
| Application service | Multi-request use cases and domain decisions | Terminal formatting |
|
||||
| API resource | Endpoint paths, request parameters, and response models | CLI prompts and global process state |
|
||||
| Transport | Base URL, headers, serialization, timeouts, retries, and response decoding | Resource-specific business rules |
|
||||
| Authentication | Credential acquisition, storage, and renewal | API resource behavior |
|
||||
| Renderer | Human and machine-readable output | Network calls and state mutation |
|
||||
|
||||
Keep framework objects at the command boundary. Core operations should accept ordinary typed values and return structured results so they can be tested without invoking a subprocess.
|
||||
|
||||
## Input And Interaction
|
||||
|
||||
- Accept flags for every value that automation may need to provide. Prompts are an interactive convenience, not the only input path.
|
||||
- Prompt only when stdin and stderr are attached to a terminal and the user has not selected non-interactive mode.
|
||||
- In non-interactive mode, fail quickly with a specific missing-input error instead of waiting for input.
|
||||
- Read large request bodies from a file or stdin; avoid forcing structured documents into shell-escaped arguments.
|
||||
- Distinguish an omitted option from an explicit empty value when the API supports partial updates.
|
||||
- Validate syntax locally, but let the service remain authoritative for remote identities, permissions, and business rules.
|
||||
- Support `--` before pass-through values or positional arguments that can begin with a hyphen.
|
||||
|
||||
For destructive or difficult-to-reverse operations, state the target precisely and require confirmation in interactive sessions. Provide an explicit option such as `--yes` for automation; never silently infer consent merely because input is non-interactive.
|
||||
|
||||
## Output Contract
|
||||
|
||||
Treat output as a public interface.
|
||||
|
||||
- Write requested results to stdout and diagnostics, progress, warnings, and errors to stderr.
|
||||
- Make the default human output concise and scannable. Do not print the same result as both prose and a table.
|
||||
- Provide one stable machine-readable format, usually `--output json` or `--json`, for commands whose results are useful in automation.
|
||||
- Serialize machine output from typed result models rather than scraping human-formatted strings.
|
||||
- Keep machine-readable stdout clean: no progress bars, update notices, color codes, or explanatory prefixes.
|
||||
- Disable color and animated progress when the output stream is not a terminal or when the user requests it.
|
||||
- Use a pager only for interactive human output, and provide a consistent way to disable it.
|
||||
- Document whether list commands emit one aggregate value or a stream of records; do not switch shapes based on result count.
|
||||
|
||||
When adding fields, preserve existing machine-readable fields where practical. Treat renaming, removing, or changing the type of a field as a compatibility decision.
|
||||
|
||||
## Configuration Model
|
||||
|
||||
Use one documented precedence order:
|
||||
|
||||
```text
|
||||
command-line option > environment variable > selected profile/config file > built-in default
|
||||
```
|
||||
|
||||
- Resolve configuration once near startup and pass a validated settings object inward.
|
||||
- Keep endpoint, profile, timeout, output mode, and similar behavior visible through a config or diagnostics command.
|
||||
- Show provenance when troubleshooting precedence, but redact secret values.
|
||||
- Store configuration in platform-appropriate user directories rather than the current working directory unless project-local configuration is intentional.
|
||||
- Keep credentials behind a separate storage abstraction. A convenient config file is not automatically an acceptable secret store.
|
||||
- Validate incompatible options together and report the conflict in the user's vocabulary.
|
||||
|
||||
## HTTP And API Behavior
|
||||
|
||||
Centralize remote-call behavior in the transport or API client:
|
||||
|
||||
- Set explicit connect, read, write, and pool timeouts appropriate to the service.
|
||||
- Send a useful user agent containing the CLI name and version.
|
||||
- Map service errors into a small application error taxonomy before they reach commands.
|
||||
- Retry only transient failures, honor `Retry-After`, cap attempts and elapsed time, and add jitter where concurrent clients may synchronize.
|
||||
- Automatically retry state-changing requests only when they are demonstrably replay-safe, such as through an idempotency key accepted by the service.
|
||||
- Preserve server request or correlation IDs in verbose diagnostics without exposing sensitive response data.
|
||||
- Keep pagination in the API layer. Let commands choose whether to fetch one page, stream pages, or collect all results based on output and memory requirements.
|
||||
- Make cancellation responsive between requests and during long-running operations.
|
||||
|
||||
Do not leak raw HTTP-library exceptions as the normal user interface. Preserve the original exception as the cause for debugging while presenting a stable CLI-level error.
|
||||
|
||||
## Authentication
|
||||
|
||||
Choose authentication from the service contract and execution context. Keep credential acquisition and renewal out of command handlers and API resources.
|
||||
|
||||
For OAuth-protected APIs, load [OAuth 2.0 for installed CLI clients](./references/oauth.md). It covers public clients, Authorization Code with PKCE, loopback callbacks, device authorization, Authlib and HTTPX2 boundaries, protected token storage, synchronized refresh, scopes, discovery, and bounded authentication retries.
|
||||
|
||||
For API keys or static tokens:
|
||||
|
||||
- Accept them through an explicit credential provider such as an OS credential store, environment variable, or CI secret integration.
|
||||
- Define precedence when more than one provider is configured.
|
||||
- Never place credentials in command arguments by default because process listings and shell history may expose them.
|
||||
- Redact credentials and credential-like headers from errors, debug logs, traces, and support bundles.
|
||||
|
||||
For unattended workloads, use a service identity and grant intended for machines. Do not reuse a person's interactive credentials as automation identity.
|
||||
|
||||
## Errors And Exit Status
|
||||
|
||||
Keep a small documented taxonomy and map it once at the entry point:
|
||||
|
||||
| Category | User-facing behavior | Exit-status requirement |
|
||||
| --- | --- | --- |
|
||||
| Usage or validation | Explain the invalid input and show the nearest help hint | Stable nonzero status distinct from remote failure |
|
||||
| Authentication | Explain whether login or credential repair is required | Stable nonzero status |
|
||||
| Authorization | Identify the denied operation without claiming credentials are expired | Stable nonzero status |
|
||||
| Not found or conflict | Name the target and preserve actionable server context | Stable nonzero status if scripts branch on it |
|
||||
| Rate limit or transient service failure | Explain retryability and any known retry time | Stable nonzero status |
|
||||
| Unexpected failure | Concise message plus opt-in diagnostic detail | Generic nonzero status |
|
||||
|
||||
- Return zero only when the requested operation completed according to its contract.
|
||||
- Do not require scripts to parse prose to distinguish common failure categories.
|
||||
- Keep normal errors concise. Put tracebacks, request details, and internal context behind an explicit debug or verbose mode.
|
||||
- Handle interruption without a traceback by default and use the platform's conventional interrupted-process status.
|
||||
- Preserve partial-success information for batch operations and define whether partial success is a failing exit status.
|
||||
|
||||
## State-Changing Operations
|
||||
|
||||
- Display or return the identity of the affected resource.
|
||||
- Support a dry-run or plan mode when the service can accurately predict a consequential change.
|
||||
- Use idempotency keys for retried creates or actions when the API supports them.
|
||||
- Do not claim rollback if the remote API cannot provide it.
|
||||
- For batch changes, define ordering, concurrency limits, stop/continue behavior, and partial-failure reporting.
|
||||
- Keep local caches disposable unless their contents are explicitly part of the user contract.
|
||||
|
||||
## Concurrency And Async Boundaries
|
||||
|
||||
Use concurrency only where it improves a measured workflow such as independent page or resource retrieval. Bound concurrent requests to respect service and local limits.
|
||||
|
||||
Choose one owner for the event loop. Command handlers may call an async application boundary, but lower layers should not invoke nested event-loop runners. Keep synchronous and asynchronous APIs separate or adapt them in one explicit place.
|
||||
|
||||
## Suggested Package Shape
|
||||
|
||||
Adapt this shape to the project's size and existing conventions:
|
||||
|
||||
```text
|
||||
src/mycli/
|
||||
├── __main__.py
|
||||
├── cli.py
|
||||
├── config.py
|
||||
├── errors.py
|
||||
├── output.py
|
||||
├── api/
|
||||
│ ├── client.py
|
||||
│ ├── transport.py
|
||||
│ └── resources/
|
||||
└── auth/
|
||||
```
|
||||
|
||||
Small clients can combine modules while preserving the conceptual boundaries. Split code when a boundary has distinct dependencies, state, tests, or change cadence, not merely to reproduce the example tree.
|
||||
|
||||
## Design Sequence
|
||||
|
||||
1. Inventory the user tasks, execution environments, API capabilities, and existing project conventions.
|
||||
2. Define the command grammar, required inputs, destructive-operation policy, output modes, and exit-status contract before wiring endpoints.
|
||||
3. Define typed configuration and its precedence, including credential providers and active context.
|
||||
4. Establish API resource, transport, authentication, and error boundaries.
|
||||
5. Implement one vertical command path through parsing, service behavior, transport, rendering, and error mapping.
|
||||
6. Verify the path both in-process and as an installed subprocess before repeating the pattern.
|
||||
7. Add concurrency, retries, caching, rich presentation, and convenience prompts only where requirements justify them.
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- Unit-test command-independent services, API resources, renderers, configuration resolution, and error mapping directly.
|
||||
- Test command invocation with isolated environment variables, config directories, stdin, stdout, and stderr.
|
||||
- Assert exit status, stdout, and stderr independently.
|
||||
- Cover human and machine-readable output, including empty and multi-page results.
|
||||
- Use a mock transport for timeouts, malformed responses, pagination, rate limits, transient retries, and permanent failures.
|
||||
- Verify interactive confirmation and non-interactive refusal for destructive operations.
|
||||
- Test redaction with realistic secret shapes in headers, URLs, response bodies, and nested exceptions.
|
||||
- Add live-service tests only for behavior a local fake cannot represent, using isolated accounts and CI-managed credentials.
|
||||
- Build and install the distribution in a clean environment to verify the console entry point and runtime dependencies.
|
||||
|
||||
## Reference Map
|
||||
|
||||
| Topic | Load when | Reference |
|
||||
| --- | --- | --- |
|
||||
| Python library selection | Choosing or comparing a parser framework, terminal output, TUI, configuration, HTTP, authentication, testing, or packaging stack | [Python CLI library selection](./references/library-selection.md) |
|
||||
| OAuth for installed applications | The API uses OAuth, OIDC discovery, refresh tokens, loopback callbacks, or device authorization | [OAuth 2.0 for installed CLI clients](./references/oauth.md) |
|
||||
|
||||
## Completion Checks
|
||||
|
||||
1. Commands model recognizable user tasks with consistent names and options.
|
||||
2. Interactive conveniences have explicit non-interactive equivalents.
|
||||
3. Stdout, stderr, machine output, and exit statuses form a stable automation contract.
|
||||
4. Configuration has one visible precedence order and credentials use an appropriate protected source.
|
||||
5. Commands do not own raw HTTP, authentication lifecycle, or terminal-independent business logic.
|
||||
6. Timeouts, retries, pagination, cancellation, and state-changing request safety are explicit.
|
||||
7. Errors are actionable, categorized, redacted, and mapped at one process boundary.
|
||||
8. Destructive and batch operations define confirmation, idempotency, and partial-failure behavior.
|
||||
9. Tests exercise installed command behavior as well as isolated application and transport logic.
|
||||
10. Help text and diagnostics let users discover the command surface and effective non-secret configuration.
|
||||
@@ -0,0 +1,175 @@
|
||||
# Python CLI Library Selection
|
||||
|
||||
Use this reference when choosing libraries for a new Python CLI or deciding whether an existing stack still fits. Choose each layer independently: a command parser, terminal renderer, terminal UI, settings model, HTTP client, authentication implementation, test runner, and package manager solve different problems.
|
||||
|
||||
## Default Stack
|
||||
|
||||
For a new typed application CLI, start with:
|
||||
|
||||
| Concern | Default | Why |
|
||||
| --- | --- | --- |
|
||||
| Command parsing | [Cyclopts](https://cyclopts.readthedocs.io/en/latest/) | Type-driven commands, rich type support, docstring-derived help, validation, command groups, configuration sources, and testing helpers |
|
||||
| Human terminal output | [Rich](https://rich.readthedocs.io/en/stable/) | Tables, progress, status, syntax, terminal detection, and separate output consoles |
|
||||
| Settings and data validation | [Pydantic](https://docs.pydantic.dev/latest/) and [Pydantic Settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/) | Typed models and explicit environment, dotenv, secret, and custom settings sources |
|
||||
| HTTP | [HTTPX2](https://pydantic.dev/docs/httpx2/) | Actively maintained synchronous and asynchronous APIs, explicit clients, timeouts, streaming, and testable transports |
|
||||
| OAuth | [Authlib 1.8+](https://pypi.org/project/Authlib/) | OAuth implementation integrated with HTTPX2; use the [OAuth reference](./oauth.md) for architecture and security requirements |
|
||||
| Tests | [pytest](https://docs.pytest.org/en/stable/) | Fixtures, parametrization, output capture, monkeypatching, and a broad plugin ecosystem |
|
||||
| Project and environment | [uv](https://docs.astral.sh/uv/) | Project dependencies, lockfiles, environments, scripts, builds, and tool execution |
|
||||
|
||||
Add [Textual](https://textual.textualize.io/) only when the product needs a persistent, event-driven terminal interface. It complements a command parser; it does not replace the scriptable command surface.
|
||||
|
||||
This is a starting point, not a mandate. Preserve a sound existing stack unless a requirement exposes a concrete limitation.
|
||||
|
||||
## Choose The Command Framework
|
||||
|
||||
### Use Cyclopts by default for a new typed application CLI
|
||||
|
||||
[Cyclopts](https://cyclopts.readthedocs.io/en/latest/) derives commands and parameters from Python function signatures and supports built-in and user-defined types, including unions, literals, dataclasses, Pydantic models, and attrs classes. It can derive help from docstrings and provides converters, validators, nested commands, lazy loading, configuration sources, documentation integration, and testing guidance.
|
||||
|
||||
Choose Cyclopts when:
|
||||
|
||||
- Modern type annotations should be the primary command schema.
|
||||
- Commands accept structured dataclasses or validation models.
|
||||
- Rich unions, literals, nested structures, or reusable parameter groups matter.
|
||||
- The project values concise declarations and generated documentation.
|
||||
- A newer and smaller ecosystem is an acceptable tradeoff.
|
||||
|
||||
Before committing, prototype the hardest command signature, help page, validation error, completion behavior, and test invocation. Do not evaluate a framework only on a one-command example.
|
||||
|
||||
### Use Typer for the mainstream type-driven choice
|
||||
|
||||
[Typer](https://typer.tiangolo.com/) also derives CLI arguments and options from Python type hints and provides automatic help, shell completion, nested command groups, Rich-formatted output, packaging guidance, and test helpers. It is a strong choice when contributor familiarity, established examples, and ecosystem recognition matter more than Cyclopts' broader type model.
|
||||
|
||||
Since Typer 0.26.0, [Typer vendors Click](https://typer.tiangolo.com/#click-code) rather than depending on the external Click package. Do not assume an arbitrary Click extension or subclass will integrate with modern Typer; verify that requirement against the installed Typer release.
|
||||
|
||||
Choose Typer when:
|
||||
|
||||
- The team already knows Typer or follows the FastAPI ecosystem.
|
||||
- The command types fit Typer's supported parameter model.
|
||||
- A familiar, established type-driven framework lowers contributor cost.
|
||||
- Existing Typer conventions or integrations outweigh framework-switching benefits.
|
||||
|
||||
### Use Click when explicit control is the requirement
|
||||
|
||||
[Click](https://click.palletsprojects.com/en/stable/) models commands, groups, contexts, parameters, types, and invocation explicitly. It supports arbitrary command nesting, lazy subcommand loading, custom parameter types, extension APIs, testing utilities, and a mature plugin ecosystem.
|
||||
|
||||
Choose Click when:
|
||||
|
||||
- The CLI is itself a framework or plugin host.
|
||||
- Commands must be discovered or loaded lazily.
|
||||
- Parsing, context propagation, invocation, or help behavior needs unusual customization.
|
||||
- Existing Click extensions are a hard dependency.
|
||||
- Explicit declarations are preferable to inference from application types.
|
||||
|
||||
Do not choose Click merely because it is mature. For ordinary application commands, the extra parser-level detail may duplicate function types, defaults, validation, and documentation.
|
||||
|
||||
### Use argparse when dependency constraints dominate
|
||||
|
||||
[`argparse`](https://docs.python.org/3/library/argparse.html) is the standard-library parser and supports subcommands, generated help, custom actions and types, argument files, and parser-level error handling. Python 3.14 added colored help and `suggest_on_error`, making its default experience more capable than older comparisons imply.
|
||||
|
||||
Choose argparse when:
|
||||
|
||||
- The tool must remain standard-library-only.
|
||||
- It is a small utility with a stable and modest command surface.
|
||||
- Conservative deployment environments value availability over declaration ergonomics.
|
||||
- Adding a runtime dependency has a real operational cost.
|
||||
|
||||
For a substantial typed application, account for the duplication between parser declarations and the application's function signatures, models, defaults, validation, and help text.
|
||||
|
||||
### Use Fire for exposure, not deliberate public design
|
||||
|
||||
[Python Fire](https://github.com/google/python-fire) generates a CLI from functions, classes, modules, mappings, and other Python objects. This is useful for developer tools, debugging, exploration, and rapidly exposing an internal Python API.
|
||||
|
||||
Avoid Fire as the default for a stable public CLI. Exposing the Python object model couples command names, arguments, and behavior to implementation details instead of treating the CLI as a deliberately designed compatibility surface.
|
||||
|
||||
## Framework Decision Table
|
||||
|
||||
| Primary requirement | Choose | Main tradeoff |
|
||||
| --- | --- | --- |
|
||||
| New, typed application with rich parameter models | Cyclopts | Smaller ecosystem and less accumulated operational history |
|
||||
| Type-driven CLI with maximum contributor familiarity | Typer | Verify complex typing and Click-extension assumptions |
|
||||
| Plugin framework or unusual parser behavior | Click | More explicit declarations and parser-specific code |
|
||||
| Standard-library-only or tiny utility | argparse | Imperative setup and duplicated schema information |
|
||||
| Rapid internal exposure of Python objects | Fire | Python implementation becomes the CLI contract |
|
||||
|
||||
When Cyclopts and Typer both fit, build the same representative vertical slice in each. Include the most complex parameter model, nested command registration, configuration injection, help output, validation failure, shell completion, and command test. Select from that evidence rather than syntax preference.
|
||||
|
||||
## Keep Complementary Libraries In Their Layer
|
||||
|
||||
### Rich is presentation, not parsing
|
||||
|
||||
Use [Rich](https://rich.readthedocs.io/en/stable/) behind a renderer abstraction for human-readable tables, progress, status displays, syntax, and styled errors. Keep structured output on a separate serialization path so `--output json` never contains decoration, progress, or terminal control codes.
|
||||
|
||||
Typer includes Rich as a dependency and uses it for formatted errors. Cyclopts can also produce Rich-oriented help and errors. This does not remove the need for an application-owned output boundary.
|
||||
|
||||
### Textual is an optional interactive mode
|
||||
|
||||
Use [Textual](https://textual.textualize.io/) when users need a persistent screen, navigation, reactive widgets, keyboard actions, or live dashboards. Keep ordinary parser commands for automation and direct operations:
|
||||
|
||||
```text
|
||||
mycli projects list -> scriptable command
|
||||
mycli interactive -> Textual application
|
||||
both -> application services -> API client
|
||||
```
|
||||
|
||||
The command and TUI adapters should call the same application services. Do not embed API and domain behavior separately in Textual event handlers.
|
||||
|
||||
## Supporting Stack Decisions
|
||||
|
||||
### Configuration and models
|
||||
|
||||
Use dataclasses when configuration is small, already parsed, and needs no source orchestration. Use [Pydantic](https://docs.pydantic.dev/latest/) for structured request, response, configuration, or command models that benefit from validation and serialization. Use [Pydantic Settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/) when environment variables, dotenv files, secret files, or custom settings sources participate in explicit precedence.
|
||||
|
||||
Do not pass framework parameter objects into application services. Convert parser output into ordinary typed values or application models at the command boundary.
|
||||
|
||||
### HTTP
|
||||
|
||||
Use [HTTPX2](https://pydantic.dev/docs/httpx2/) for new API clients. It is the actively developed continuation of HTTPX and supports synchronous and asynchronous clients, explicit timeouts, streaming, custom authentication, and mock transports. [Authlib 1.8+](https://pypi.org/project/Authlib/) integrates with HTTPX2 directly. Reuse a client with explicit timeouts rather than calling top-level request functions throughout resource methods.
|
||||
|
||||
Preserve [HTTPX](https://www.python-httpx.org/) in a sound existing client until its dependencies, type checks, and transport tests are ready to migrate. Do not use HTTPX2's process-wide import alias from reusable library code, and do not keep HTTPX and HTTPX2 as permanent parallel transports without a concrete compatibility requirement.
|
||||
|
||||
Use [aiohttp](https://docs.aiohttp.org/en/stable/) when the project already standardizes on its async client, depends on its streaming or WebSocket behavior, or has measured requirements that justify a different transport. Do not introduce both HTTPX2 and aiohttp without a clear ownership boundary.
|
||||
|
||||
### Authentication
|
||||
|
||||
Use [Authlib 1.8+](https://pypi.org/project/Authlib/) for OAuth protocol behavior rather than implementing grants, PKCE, token parsing, and refresh directly. Keep it behind an authentication abstraction. For OAuth-enabled installed applications, follow [OAuth 2.0 for installed CLI clients](./oauth.md).
|
||||
|
||||
Use [keyring](https://keyring.readthedocs.io/en/latest/) to access operating-system credential stores when the deployment environment provides one. Treat headless secret storage as an explicit deployment decision rather than silently falling back to plaintext configuration.
|
||||
|
||||
### Testing and packaging
|
||||
|
||||
Use [pytest](https://docs.pytest.org/en/stable/) for application and command tests. Combine framework-level invocation helpers with subprocess tests of the installed console entry point; a runner helper alone does not verify packaging or startup behavior.
|
||||
|
||||
Use [uv](https://docs.astral.sh/uv/) for dependency management, lockfiles, isolated tool execution, and project commands when the repository adopts uv. Declare the CLI through a `[project.scripts]` entry point in [`pyproject.toml`](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#creating-and-packaging-command-line-tools) so installation, tests, and users invoke the same bootstrap path.
|
||||
|
||||
## Architecture Rule
|
||||
|
||||
Do not couple application behavior to the chosen CLI framework:
|
||||
|
||||
```text
|
||||
Cyclopts / Typer / Click / argparse
|
||||
|
|
||||
v
|
||||
thin command adapters
|
||||
|
|
||||
v
|
||||
application services
|
||||
|
|
||||
v
|
||||
API client
|
||||
```
|
||||
|
||||
Command functions should parse or receive values, call an application service, and hand the result to a renderer. Keep API calls, authentication, retries, and domain decisions outside parser decorators and callbacks. This makes framework-specific tests small and keeps a future parser migration bounded.
|
||||
|
||||
## Selection Checklist
|
||||
|
||||
1. Identify the minimum supported Python version and dependency constraints.
|
||||
2. Model the hardest real command, not the smallest demonstration command.
|
||||
3. Decide whether type annotations or explicit parser objects should own the command schema.
|
||||
4. Check complex types, nested commands, lazy loading, plugins, completion, help, validation, and test support against actual requirements.
|
||||
5. Separate parsing from Rich presentation and optional Textual interaction.
|
||||
6. Select configuration, HTTP, authentication, testing, and packaging libraries independently.
|
||||
7. Prototype ambiguous framework choices with the same vertical slice.
|
||||
8. Pin compatible versions and verify behavior against installed-library documentation before implementation.
|
||||
9. Keep application services free of CLI-framework types.
|
||||
10. Preserve stable stdout, stderr, and exit-status contracts regardless of library defaults.
|
||||
@@ -0,0 +1,513 @@
|
||||
# OAuth 2.0 For Installed CLI Clients
|
||||
|
||||
Use this reference when a Python CLI calls an OAuth-protected API. Keep authentication, token lifecycle, HTTP transport, and API resources as separate ownership boundaries.
|
||||
|
||||
## Recommended Default
|
||||
|
||||
For an interactive installed CLI, use:
|
||||
|
||||
> Public client + Authorization Code + PKCE using `S256` + loopback callback + Authlib 1.8+ + HTTPX2 + protected credential store + centralized token refresh + minimum scopes.
|
||||
|
||||
Follow the current [OAuth 2.0 Security Best Current Practice](https://www.rfc-editor.org/rfc/rfc9700) and the [OAuth 2.0 guidance for native applications](https://www.rfc-editor.org/rfc/rfc8252). Do not use the implicit grant, Resource Owner Password Credentials grant, or an embedded client secret.
|
||||
|
||||
## Responsibility Boundaries
|
||||
|
||||
Keep dependencies pointed inward toward authentication and transport primitives:
|
||||
|
||||
```text
|
||||
CLI commands
|
||||
├── login/logout/status -> OAuthManager -> authorization server
|
||||
└── API commands -> ApiClient/resources -> OAuthTransport
|
||||
└── TokenManager
|
||||
├── TokenStore
|
||||
└── OAuth client / HTTP transport
|
||||
```
|
||||
|
||||
| Component | Owns | Must not own |
|
||||
| --- | --- | --- |
|
||||
| `OAuthManager` | Interactive login, callback validation, token exchange, logout | API resource methods |
|
||||
| `TokenStore` | Loading, atomically saving, and deleting sensitive token state | Refresh policy or HTTP requests |
|
||||
| `TokenManager` | Expiry checks, refresh synchronization, and valid access-token retrieval | CLI presentation or resource URLs |
|
||||
| `OAuthTransport` | Bearer-token injection and one bounded authentication retry | Interactive login UX |
|
||||
| `ApiClient` and resources | API operations, request models, and response models | OAuth grants, refresh tokens, or credential storage |
|
||||
|
||||
Keep [Authlib's HTTPX2 OAuth client](https://github.com/authlib/authlib/blob/v1.8.0/authlib/integrations/httpx_client/oauth2_client.py) behind the authentication boundary. API resources should request an authenticated transport or call `TokenManager.get_valid_access_token()`; they should not depend directly on Authlib.
|
||||
|
||||
## Library Selection
|
||||
|
||||
Use one library per responsibility and keep each one behind an application-owned interface:
|
||||
|
||||
| Concern | Default for new code | Use something else when |
|
||||
| --- | --- | --- |
|
||||
| OAuth protocol | [Authlib 1.8+](https://pypi.org/project/Authlib/) | A provider supplies an official, maintained SDK that correctly implements its non-standard behavior |
|
||||
| API and OAuth HTTP | [HTTPX2 2.x](https://pydantic.dev/docs/httpx2/) | Preserve HTTPX in an existing stable client until its dependencies and test doubles are ready to migrate |
|
||||
| Desktop credential storage | [keyring](https://keyring.readthedocs.io/en/latest/) | The target platforms are explicitly supported by a reviewed native alternative, or the deployment already owns a managed vault |
|
||||
| Async coordination | [`asyncio`](https://docs.python.org/3/library/asyncio-sync.html) for an asyncio-only CLI | The application already standardizes on [AnyIO](https://anyio.readthedocs.io/en/stable/) or supports multiple async backends |
|
||||
| Tests | [pytest](https://docs.pytest.org/en/stable/) and [`httpx2.MockTransport`](https://pydantic.dev/docs/httpx2/advanced/transports/#mock-transports) | The repository has an established equivalent |
|
||||
|
||||
[HTTPX2](https://pypi.org/project/httpx2/) is the actively developed continuation of HTTPX under Pydantic stewardship. It keeps the familiar client, request, response, authentication, and mock-transport APIs while using the `httpx2` import. Authlib 1.8 moved its HTTP client integration to HTTPX2, so new OAuth clients can use one HTTP implementation:
|
||||
|
||||
```bash
|
||||
uv add "Authlib>=1.8" "httpx2>=2" keyring
|
||||
```
|
||||
|
||||
Do not call [`httpx2.alias_httpx()`](https://pydantic.dev/docs/httpx2/api/api/#httpx2.alias_httpx) from reusable library code. It changes imports process-wide and exists as a temporary application-level migration aid. If an existing dependency still requires `httpx`, keep both clients behind local abstractions and remove HTTPX only after dependency and transport tests pass.
|
||||
|
||||
## Configuration And Secret State
|
||||
|
||||
Separate public OAuth configuration from sensitive OAuth state.
|
||||
|
||||
Public configuration may contain:
|
||||
|
||||
- Client ID for the registered public client.
|
||||
- Issuer, authorization endpoint, token endpoint, and optional revocation or device-authorization endpoint.
|
||||
- Exact registered redirect URI rules.
|
||||
- Required scopes and, when supported, resource or audience indicators.
|
||||
|
||||
Sensitive state includes:
|
||||
|
||||
- Access tokens.
|
||||
- Refresh tokens.
|
||||
- Token expiry and related token response fields when they reveal account or authorization state.
|
||||
|
||||
Represent the complete token response and store it through a narrow abstraction. A `TypedDict` documents the common fields without discarding provider-specific fields from the runtime dictionary:
|
||||
|
||||
```python
|
||||
from typing import Protocol, Required, TypedDict
|
||||
|
||||
|
||||
class OAuthToken(TypedDict, total=False):
|
||||
access_token: Required[str]
|
||||
refresh_token: str
|
||||
token_type: str
|
||||
expires_at: float
|
||||
expires_in: int
|
||||
scope: str
|
||||
|
||||
|
||||
class TokenStore(Protocol):
|
||||
async def load(self) -> OAuthToken | None: ...
|
||||
async def save(self, token: OAuthToken) -> None: ...
|
||||
async def delete(self) -> None: ...
|
||||
```
|
||||
|
||||
For a desktop CLI, [keyring](https://keyring.readthedocs.io/en/latest/) remains the conservative default because it selects macOS Keychain, Windows Credential Locker, Secret Service, or KWallet as available. Its API is synchronous, so move calls off the event-loop thread. Store one JSON document per account so access-token and refresh-token rotation is replaced as one logical update:
|
||||
|
||||
```python
|
||||
import json
|
||||
from typing import cast
|
||||
|
||||
import anyio
|
||||
import keyring
|
||||
from keyring.backend import KeyringBackend
|
||||
from keyring.errors import KeyringError
|
||||
|
||||
|
||||
class CredentialStoreError(RuntimeError):
|
||||
pass
|
||||
|
||||
|
||||
class KeyringTokenStore:
|
||||
def __init__(
|
||||
self,
|
||||
service: str,
|
||||
account: str,
|
||||
backend: KeyringBackend | None = None,
|
||||
) -> None:
|
||||
self._service = service
|
||||
self._account = account
|
||||
self._backend = backend or keyring.get_keyring()
|
||||
if self._backend.priority <= 0:
|
||||
raise CredentialStoreError("No protected credential store is available")
|
||||
|
||||
async def load(self) -> OAuthToken | None:
|
||||
try:
|
||||
raw = await anyio.to_thread.run_sync(
|
||||
self._backend.get_password, self._service, self._account
|
||||
)
|
||||
except KeyringError as error:
|
||||
raise CredentialStoreError("Could not read OAuth credentials") from error
|
||||
if raw is None:
|
||||
return None
|
||||
try:
|
||||
value = json.loads(raw)
|
||||
except json.JSONDecodeError as error:
|
||||
raise CredentialStoreError("Stored OAuth credentials are invalid") from error
|
||||
if not isinstance(value, dict) or not isinstance(value.get("access_token"), str):
|
||||
raise CredentialStoreError("Stored OAuth credentials are invalid")
|
||||
return cast("OAuthToken", value)
|
||||
|
||||
async def save(self, token: OAuthToken) -> None:
|
||||
encoded = json.dumps(token, separators=(",", ":"))
|
||||
try:
|
||||
await anyio.to_thread.run_sync(
|
||||
self._backend.set_password,
|
||||
self._service,
|
||||
self._account,
|
||||
encoded,
|
||||
)
|
||||
except KeyringError as error:
|
||||
raise CredentialStoreError("Could not save OAuth credentials") from error
|
||||
|
||||
async def delete(self) -> None:
|
||||
if await self.load() is None:
|
||||
return
|
||||
try:
|
||||
await anyio.to_thread.run_sync(
|
||||
self._backend.delete_password, self._service, self._account
|
||||
)
|
||||
except KeyringError as error:
|
||||
raise CredentialStoreError("Could not delete OAuth credentials") from error
|
||||
```
|
||||
|
||||
Fail closed when no recommended backend is available. Do not install [`keyrings.alt`](https://pypi.org/project/keyrings.alt/) as an automatic fallback; it intentionally includes possibly insecure backends.
|
||||
|
||||
### Storage Alternatives
|
||||
|
||||
- Consider [`rust-native-keyring`](https://pypi.org/project/rust-native-keyring/) when native compiled wheels, the Rust [keyring ecosystem](https://github.com/open-source-cooperative/keyring-rs), and its richer credential-store selection fit the supported platforms. Its Python package is still `0.x`, so pin it, verify wheel availability, and test lock/unlock and deletion behavior on every target OS before preferring it over `keyring`.
|
||||
- Consider the official [1Password Python SDK](https://www.1password.dev/sdks/) when users already rely on 1Password and desktop authorization prompts, auditing, or shared vault policy are product requirements. It is asynchronous and supports desktop-app authorization, but its SDK is also still version `0`; it is not a transparent local-keyring replacement.
|
||||
- Use a managed service such as [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets-python-sdk.html), [Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-python), [Google Secret Manager](https://docs.cloud.google.com/secret-manager/docs/reference/libraries), or [HashiCorp Vault](https://developer.hashicorp.com/vault/docs/get-started/developer-qs) for unattended or centrally governed deployments. Authenticate with workload identity or another deployment-owned mechanism; do not solve storage by introducing a second long-lived bootstrap secret.
|
||||
|
||||
For a headless environment without a credential service, require an explicit storage backend appropriate to its threat model; do not silently fall back to plaintext config. Never emit tokens through logs, telemetry, exceptions, shell output, or status commands.
|
||||
|
||||
## Interactive Authorization
|
||||
|
||||
Use Authorization Code with PKCE for browser-based login:
|
||||
|
||||
1. Generate a cryptographically random `state` and a fresh PKCE `code_verifier` for every attempt.
|
||||
2. Derive the `S256` code challenge and construct the authorization URL with the exact requested redirect URI and minimum scopes.
|
||||
3. Bind a temporary listener to `127.0.0.1` on an ephemeral port. Do not expose it on all interfaces.
|
||||
4. Open the system browser and wait for one callback with a short timeout and cancellation path.
|
||||
5. Reject OAuth errors, a missing code, or any callback whose `state` does not exactly match.
|
||||
6. Exchange the code using the original verifier and redirect URI.
|
||||
7. Persist the complete returned token state atomically, then stop the listener immediately.
|
||||
8. Return a minimal success page and CLI message without displaying credentials.
|
||||
|
||||
Treat the CLI as a public client. A secret distributed inside source, a package, a binary, or an environment-independent configuration file cannot authenticate installed copies of the CLI.
|
||||
|
||||
The following manager shows the Authlib-owned part of a loopback flow. A separate callback receiver should bind `127.0.0.1`, accept one request, enforce a timeout and maximum request size, then pass the complete callback URL to `finish()`:
|
||||
|
||||
```python
|
||||
import secrets
|
||||
from dataclasses import dataclass
|
||||
from urllib.parse import parse_qs, urlsplit
|
||||
|
||||
from authlib.integrations.httpx_client import AsyncOAuth2Client
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class OAuthConfig:
|
||||
client_id: str
|
||||
authorization_endpoint: str
|
||||
token_endpoint: str
|
||||
redirect_uri: str
|
||||
scopes: tuple[str, ...]
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class PendingAuthorization:
|
||||
url: str
|
||||
state: str
|
||||
code_verifier: str
|
||||
|
||||
|
||||
class OAuthManager:
|
||||
def __init__(self, config: OAuthConfig, store: TokenStore) -> None:
|
||||
self._config = config
|
||||
self._store = store
|
||||
self._client = AsyncOAuth2Client(
|
||||
client_id=config.client_id,
|
||||
redirect_uri=config.redirect_uri,
|
||||
scope=" ".join(config.scopes),
|
||||
code_challenge_method="S256",
|
||||
token_endpoint_auth_method="none",
|
||||
)
|
||||
|
||||
def begin(self) -> PendingAuthorization:
|
||||
verifier = secrets.token_urlsafe(64)
|
||||
url, state = self._client.create_authorization_url(
|
||||
self._config.authorization_endpoint,
|
||||
code_verifier=verifier,
|
||||
)
|
||||
return PendingAuthorization(url=url, state=state, code_verifier=verifier)
|
||||
|
||||
async def finish(
|
||||
self, callback_url: str, pending: PendingAuthorization
|
||||
) -> OAuthToken:
|
||||
callback = urlsplit(callback_url)
|
||||
expected = urlsplit(self._config.redirect_uri)
|
||||
callback_target = (callback.scheme, callback.hostname, callback.port, callback.path)
|
||||
expected_target = (expected.scheme, expected.hostname, expected.port, expected.path)
|
||||
if callback_target != expected_target:
|
||||
raise AuthenticationError("OAuth callback used an unexpected redirect URI")
|
||||
|
||||
query = parse_qs(callback.query)
|
||||
if query.get("state") != [pending.state]:
|
||||
raise AuthenticationError("OAuth callback state did not match")
|
||||
if "error" in query:
|
||||
raise AuthenticationError("Authorization server rejected login")
|
||||
code = query.get("code", [None])[0]
|
||||
if code is None:
|
||||
raise AuthenticationError("OAuth callback did not contain a code")
|
||||
|
||||
result = await self._client.fetch_token(
|
||||
self._config.token_endpoint,
|
||||
code=code,
|
||||
code_verifier=pending.code_verifier,
|
||||
)
|
||||
token = cast("OAuthToken", dict(result))
|
||||
await self._store.save(token)
|
||||
return token
|
||||
|
||||
async def aclose(self) -> None:
|
||||
await self._client.aclose()
|
||||
```
|
||||
|
||||
Do not persist `PendingAuthorization`: `state` and `code_verifier` are short-lived, single-attempt values. Define `AuthenticationError` in the application's stable error taxonomy and keep callback query values out of its message.
|
||||
|
||||
If a browser or loopback listener is impractical and the provider exposes it, use the standardized [Device Authorization Grant](https://www.rfc-editor.org/rfc/rfc8628). Respect the server-provided polling interval, `slow_down`, expiration, and cancellation behavior. Do not invent a device flow against a provider that does not advertise or document one.
|
||||
|
||||
## Authorization Server Metadata
|
||||
|
||||
Prefer [OAuth 2.0 Authorization Server Metadata](https://www.rfc-editor.org/rfc/rfc8414) or OpenID Connect discovery when the provider supports it. Validate that discovered metadata belongs to the configured issuer and require HTTPS for non-loopback endpoints.
|
||||
|
||||
Use explicit endpoints when discovery is unavailable or when a controlled deployment intentionally pins them. Do not mix endpoints discovered from one issuer with configuration from another.
|
||||
|
||||
## Token Lifecycle
|
||||
|
||||
Centralize expiry and refresh decisions in `TokenManager`:
|
||||
|
||||
```text
|
||||
load token
|
||||
├── missing -> authentication required
|
||||
├── valid beyond refresh leeway -> return access token
|
||||
└── expired or near expiry
|
||||
└── acquire refresh lock
|
||||
├── reload token
|
||||
├── return it if another task refreshed it
|
||||
└── refresh, atomically persist the full response, and return it
|
||||
```
|
||||
|
||||
Use a small expiry leeway, commonly 60 seconds, to avoid starting a request with a token that expires in transit. For a single-process async CLI, an `asyncio.Lock` is sufficient for in-process refresh coordination. If multiple processes can share one token store, add storage-level coordination or optimistic versioning; an in-process lock cannot prevent cross-process races.
|
||||
|
||||
Preserve a refresh token when the server omits it from a refresh response, but replace it whenever rotation returns a new one. Save the newly returned token as one atomic state update so an older writer cannot restore a superseded refresh token.
|
||||
|
||||
Classify missing, expired-without-refresh, rejected-refresh, and revoked credentials as authentication failures with a clear path to log in again. Do not turn refresh failures into anonymous API calls.
|
||||
|
||||
A small refresher adapter and token manager keep Authlib details out of storage and API resources:
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
import time
|
||||
from collections.abc import Callable
|
||||
|
||||
|
||||
class AuthenticationError(RuntimeError):
|
||||
pass
|
||||
|
||||
|
||||
class AuthlibTokenRefresher:
|
||||
def __init__(self, config: OAuthConfig) -> None:
|
||||
self._config = config
|
||||
|
||||
async def refresh(self, token: OAuthToken) -> OAuthToken:
|
||||
refresh_token = token.get("refresh_token")
|
||||
if refresh_token is None:
|
||||
raise AuthenticationError("Login is required")
|
||||
async with AsyncOAuth2Client(
|
||||
client_id=self._config.client_id,
|
||||
token=dict(token),
|
||||
token_endpoint_auth_method="none",
|
||||
) as client:
|
||||
result = await client.refresh_token(
|
||||
self._config.token_endpoint,
|
||||
refresh_token=refresh_token,
|
||||
)
|
||||
refreshed = cast("OAuthToken", dict(result))
|
||||
refreshed.setdefault("refresh_token", refresh_token)
|
||||
return refreshed
|
||||
|
||||
|
||||
class TokenManager:
|
||||
def __init__(
|
||||
self,
|
||||
store: TokenStore,
|
||||
refresher: AuthlibTokenRefresher,
|
||||
*,
|
||||
refresh_leeway: float = 60.0,
|
||||
clock: Callable[[], float] = time.time,
|
||||
) -> None:
|
||||
self._store = store
|
||||
self._refresher = refresher
|
||||
self._refresh_leeway = refresh_leeway
|
||||
self._clock = clock
|
||||
self._lock = asyncio.Lock()
|
||||
|
||||
def _is_usable(self, token: OAuthToken) -> bool:
|
||||
expires_at = token.get("expires_at")
|
||||
return expires_at is None or expires_at > self._clock() + self._refresh_leeway
|
||||
|
||||
async def get_valid_access_token(self, *, force_refresh: bool = False) -> str:
|
||||
token = await self._store.load()
|
||||
if token is None:
|
||||
raise AuthenticationError("Login is required")
|
||||
if not force_refresh and self._is_usable(token):
|
||||
return token["access_token"]
|
||||
|
||||
async with self._lock:
|
||||
token = await self._store.load()
|
||||
if token is None:
|
||||
raise AuthenticationError("Login is required")
|
||||
if not force_refresh and self._is_usable(token):
|
||||
return token["access_token"]
|
||||
refreshed = await self._refresher.refresh(token)
|
||||
await self._store.save(refreshed)
|
||||
return refreshed["access_token"]
|
||||
```
|
||||
|
||||
This lock covers one process. Replace or augment it with storage-level compare-and-swap or an inter-process lock when several processes share the same credential entry.
|
||||
|
||||
## Authenticated HTTP Transport
|
||||
|
||||
The transport should:
|
||||
|
||||
1. Obtain a valid access token before sending a protected request.
|
||||
2. Inject the authorization header without exposing the token to API resource code.
|
||||
3. Apply the project's normal timeout, TLS, proxy, retry, and error-mapping policy.
|
||||
4. Optionally react to one `401` by forcing one synchronized refresh and replaying the request once.
|
||||
5. Raise an authentication error if the replay is still unauthorized.
|
||||
|
||||
Do not refresh blindly on every `401`; unauthorized responses can indicate revocation, malformed credentials, the wrong audience, or another authentication failure. Never create an unbounded refresh or request loop. Replay only requests whose body can be safely regenerated, and do not treat `403` as an expiry signal.
|
||||
|
||||
[HTTPX2 custom authentication](https://pydantic.dev/docs/httpx2/advanced/authentication/#custom-authentication-schemes) is a compact way to apply the token manager to every API request. This example retries one bodyless, read-only request after a synchronized refresh and leaves all other `401` responses untouched:
|
||||
|
||||
```python
|
||||
import httpx2
|
||||
|
||||
|
||||
class OAuthAuth(httpx2.Auth):
|
||||
requires_response_body = True
|
||||
|
||||
def __init__(self, tokens: TokenManager) -> None:
|
||||
self._tokens = tokens
|
||||
|
||||
def sync_auth_flow(self, request: httpx2.Request):
|
||||
raise RuntimeError("OAuthAuth requires httpx2.AsyncClient")
|
||||
yield request
|
||||
|
||||
async def async_auth_flow(self, request: httpx2.Request):
|
||||
access_token = await self._tokens.get_valid_access_token()
|
||||
request.headers["Authorization"] = f"Bearer {access_token}"
|
||||
response = yield request
|
||||
|
||||
if response.status_code != 401 or request.method not in {"GET", "HEAD", "OPTIONS"}:
|
||||
return
|
||||
access_token = await self._tokens.get_valid_access_token(force_refresh=True)
|
||||
request.headers["Authorization"] = f"Bearer {access_token}"
|
||||
yield request
|
||||
|
||||
|
||||
class ApiClient:
|
||||
def __init__(self, base_url: str, tokens: TokenManager) -> None:
|
||||
self._http = httpx2.AsyncClient(
|
||||
base_url=base_url,
|
||||
auth=OAuthAuth(tokens),
|
||||
timeout=httpx2.Timeout(20.0, connect=5.0),
|
||||
)
|
||||
|
||||
async def get_project(self, project_id: str) -> dict[str, object]:
|
||||
response = await self._http.get(f"/projects/{project_id}")
|
||||
response.raise_for_status()
|
||||
value = response.json()
|
||||
if not isinstance(value, dict):
|
||||
raise ValueError("Expected an object response")
|
||||
return value
|
||||
|
||||
async def aclose(self) -> None:
|
||||
await self._http.aclose()
|
||||
```
|
||||
|
||||
For streaming requests, uploads, or state-changing methods, omit automatic replay unless the API supplies an idempotency mechanism and the request body can be rebuilt. Map the final HTTPX2 response or exception into application errors before it reaches a CLI command.
|
||||
|
||||
## Scopes And Token Restrictions
|
||||
|
||||
- Request only scopes needed by the CLI's supported operations.
|
||||
- Keep scopes explicit in configuration and stable in tests.
|
||||
- Request offline access or equivalent provider-specific scope only when refresh tokens are needed.
|
||||
- Use audience or resource restrictions when supported.
|
||||
- Detect when stored authorization lacks scopes required by a command and direct the user through deliberate reauthorization rather than quietly broadening every login.
|
||||
|
||||
## CLI Surface
|
||||
|
||||
Expose a small authentication surface consistent with the existing command framework:
|
||||
|
||||
```text
|
||||
mycli login
|
||||
mycli logout
|
||||
mycli auth status
|
||||
```
|
||||
|
||||
`login` starts interactive authorization and reports only progress and outcome. `logout` deletes local token state and uses the provider's revocation endpoint when supported; explain if remote revocation fails after local deletion. `auth status` may show account identity, granted scopes, issuer, and expiry, but never a token or authorization code.
|
||||
|
||||
A manual `auth refresh` command is optional and primarily diagnostic. Normal API commands should not require users to manage refresh timing.
|
||||
|
||||
## Suggested Package Shape
|
||||
|
||||
Adapt names to the existing project rather than forcing this exact tree:
|
||||
|
||||
```text
|
||||
src/mycli/
|
||||
├── cli.py
|
||||
├── errors.py
|
||||
├── api/
|
||||
│ ├── client.py
|
||||
│ ├── transport.py
|
||||
│ └── resources/
|
||||
└── auth/
|
||||
├── config.py
|
||||
├── manager.py
|
||||
├── token.py
|
||||
└── store.py
|
||||
```
|
||||
|
||||
Keep token models independent from provider client objects so storage, tests, and API code do not inherit Authlib's internal representation as a public application contract.
|
||||
|
||||
## Branching Guidance
|
||||
|
||||
- If the provider supports loopback redirects: use Authorization Code with PKCE and an ephemeral `127.0.0.1` listener.
|
||||
- If the execution environment cannot open a browser or accept a loopback callback: use Device Authorization Grant only when the provider supports it.
|
||||
- If the API is called by unattended automation rather than a person: use the provider's machine-to-machine grant and credential mechanism; do not reuse an interactive user's refresh token as service identity.
|
||||
- If the provider supports discovery: derive endpoints from validated issuer metadata; otherwise pin explicit HTTPS endpoints.
|
||||
- If requests are concurrent in one process: serialize refresh with a lock and re-read state after acquisition.
|
||||
- If token state is shared across processes: use inter-process coordination and atomic persistence.
|
||||
- If an existing CLI already has HTTP and configuration abstractions: integrate at those boundaries instead of replacing the command framework or resource layer.
|
||||
|
||||
## Tests And Verification
|
||||
|
||||
Test protocol behavior without depending on a live identity provider:
|
||||
|
||||
- Login creates fresh state and verifier values and uses `S256`.
|
||||
- Callback handling accepts the expected state and rejects missing, mismatched, duplicate, timed-out, and OAuth-error callbacks.
|
||||
- The listener binds only to loopback and always shuts down.
|
||||
- Token exchange uses the same redirect URI and verifier as authorization.
|
||||
- Valid tokens bypass refresh; near-expiry tokens refresh once.
|
||||
- Concurrent requests cause one refresh and all callers observe the persisted replacement token.
|
||||
- Refresh-token rotation cannot be overwritten by stale state.
|
||||
- A `401` causes at most one eligible replay; a second `401` fails.
|
||||
- Status and error output remain useful without revealing token values.
|
||||
- Logout clears local state and handles optional remote revocation explicitly.
|
||||
|
||||
Use deterministic clocks, fake token stores, and [`httpx2.MockTransport`](https://pydantic.dev/docs/httpx2/advanced/transports/#mock-transports) for unit tests. Add a provider integration test only when the project has suitable isolated credentials and CI secret handling.
|
||||
|
||||
## Completion Checks
|
||||
|
||||
1. The CLI is registered and implemented as a public client without an embedded secret.
|
||||
2. Interactive login uses Authorization Code with PKCE `S256`, fresh state, exact redirect validation, and a bounded loopback listener.
|
||||
3. Device authorization is conditional on provider support and follows server polling instructions.
|
||||
4. Token storage is replaceable, protected, atomic, and absent from logs and normal output.
|
||||
5. One component owns expiry, synchronized refresh, and refresh-token rotation.
|
||||
6. API resources remain independent of OAuth protocol and storage details.
|
||||
7. Scopes and audience are minimal and explicit.
|
||||
8. Authentication retries are bounded and replay only eligible requests.
|
||||
9. Login, logout, status, refresh, concurrency, callback rejection, and redaction paths have focused verification.
|
||||
10. Provider-specific behavior and installed dependency versions are checked against current primary documentation.
|
||||
+9
-28
@@ -1,23 +1,6 @@
|
||||
---
|
||||
name: copilot-customization
|
||||
description: 'Plan, create, review, and debug GitHub Copilot and VS Code agent customizations, including instructions, prompt files, skills, custom agents, hooks, MCP servers, and repo-specific personal-mcp skill integration.'
|
||||
x-personal-mcp:
|
||||
id: copilot-customization
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- copilot
|
||||
- vscode
|
||||
- customization
|
||||
- instructions
|
||||
- prompts
|
||||
- agent-skills
|
||||
- custom-agents
|
||||
- hooks
|
||||
- mcp
|
||||
- personal-mcp
|
||||
- skills
|
||||
capabilities:
|
||||
- resource://skills/copilot-customization/document
|
||||
---
|
||||
|
||||
# Copilot Customization
|
||||
@@ -78,31 +61,29 @@ Use either:
|
||||
Choose one of these patterns:
|
||||
|
||||
1. Direct URI strategy:
|
||||
- Reference known resources directly, such as:
|
||||
- `resource://catalog/skills_index`
|
||||
- `resource://catalog/skills/{skill_id}`
|
||||
- `resource://skills/<skill-id>/document`
|
||||
- `resource://skills/<skill-id>/references/<ref-id>`
|
||||
- Read `skill://<skill-name>/SKILL.md` when the required skill is known.
|
||||
- Read `skill://<skill-name>/_manifest` only when supporting material may be useful.
|
||||
- Read selected supporting files at `skill://<skill-name>/<supporting-path>`.
|
||||
2. Discovery-first strategy:
|
||||
- Start at catalog discovery (`resource://catalog/skills_index`), select the best skill match, then load the skill document and only the minimal references needed.
|
||||
- List resources, compare native main-resource names and descriptions, then load the best matching `SKILL.md`.
|
||||
|
||||
### Authoring guidance for shims
|
||||
|
||||
1. Keep shim content short and procedural; avoid copying large guidance blocks from Personal MCP.
|
||||
2. State trigger conditions clearly (for example: "when creating a new skill" or "when editing docs contracts").
|
||||
3. Specify whether to use direct URIs or discovery for that repo's common workflows.
|
||||
4. Prefer loading only the most relevant skill document first; expand to references only when needed.
|
||||
3. Specify whether to use a direct native URI or resource listing for that repo's common workflows.
|
||||
4. Prefer loading only the most relevant main file first; inspect its manifest only when needed.
|
||||
5. For stable repeated workflows, use explicit URIs. For broader or ambiguous requests, use discovery-first.
|
||||
|
||||
### Minimal shim examples
|
||||
|
||||
Instruction-style shim intent:
|
||||
|
||||
1. "For markdown edits (`applyTo: '**/*.md'`), load `resource://skills/zensical-docs/document` and apply Zensical-native documentation conventions unless they conflict with expected MkDocs compatibility."
|
||||
1. "For markdown edits (`applyTo: '**/*.md'`), load `skill://zensical-docs/SKILL.md` and apply Zensical-native documentation conventions unless they conflict with expected MkDocs compatibility."
|
||||
|
||||
Prompt-style shim intent:
|
||||
|
||||
1. "For docs authoring tasks, consult `resource://skills/zensical-docs/document`, summarize the relevant authoring constraints, then propose the smallest markdown change for this repository."
|
||||
1. "For docs authoring tasks, consult `skill://zensical-docs/SKILL.md`, summarize the relevant authoring constraints, then propose the smallest markdown change for this repository."
|
||||
|
||||
### Validation for shim implementation
|
||||
|
||||
@@ -130,7 +111,7 @@ Before finishing:
|
||||
3. Confirm names match directory names where VS Code requires it.
|
||||
4. Confirm descriptions include the phrases users are likely to ask for.
|
||||
5. Confirm extra skill resources are linked from `SKILL.md`.
|
||||
6. Confirm repo skill metadata exposes the correct `resource://skills/<skill-id>/document` capability.
|
||||
6. Confirm native discovery exposes `skill://<skill-name>/SKILL.md`, `_manifest`, and supporting-file reads.
|
||||
7. State any remaining ambiguity or user choice, such as personal vs workspace scope.
|
||||
|
||||
## Output Contract
|
||||
-11
@@ -1,17 +1,6 @@
|
||||
---
|
||||
name: fastapi-uv-docker
|
||||
description: 'Audit and migrate an existing Python project to best practices for a cloud-native ASGI FastAPI app managed with uv and run with uvicorn in Docker. Use when: conforming a project to production standards, setting up src layout, configuring pyproject.toml, writing multi-stage Dockerfiles, wiring lifespan and settings, adding health endpoints, enforcing non-root container user, migrating from requirements.txt to uv.'
|
||||
x-personal-mcp:
|
||||
id: fastapi-uv-docker
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- fastapi
|
||||
- uv
|
||||
- uvicorn
|
||||
- docker
|
||||
- architecture
|
||||
capabilities:
|
||||
- resource://skills/fastapi-uv-docker/document
|
||||
---
|
||||
|
||||
# FastAPI Project Best Practices
|
||||
@@ -1,17 +1,6 @@
|
||||
---
|
||||
name: mcp-details
|
||||
description: "Reference hub for MCP and FastMCP source documentation links. Use when you need authoritative protocol, SDK, transport, and deployment docs without loading broad implementation guidance."
|
||||
x-personal-mcp:
|
||||
id: mcp-details
|
||||
version: 1.0.0
|
||||
tags:
|
||||
- mcp
|
||||
- model-context-protocol
|
||||
- fastmcp
|
||||
- references
|
||||
- source-docs
|
||||
capabilities:
|
||||
- resource://skills/mcp-details/document
|
||||
---
|
||||
|
||||
# MCP Details
|
||||
+2
@@ -7,6 +7,8 @@ Use this page for MCP client setup, operational tools, and integration reference
|
||||
!!! info "VS Code MCP docs"
|
||||
- [VS Code MCP servers overview](https://code.visualstudio.com/docs/agent-customization/mcp-servers)
|
||||
- [VS Code MCP configuration reference](https://code.visualstudio.com/docs/agents/reference/mcp-configuration)
|
||||
- [VS Code MCP developer guide](https://code.visualstudio.com/docs/agents/guides/mcp-developer-guide)
|
||||
- [VS Code MCP Apps support](https://code.visualstudio.com/blogs/2026/01/26/mcp-apps-support)
|
||||
- [VS Code Copilot customization overview](https://code.visualstudio.com/docs/copilot/customization/overview)
|
||||
|
||||
## Debugging and Inspection
|
||||
+13
-2
@@ -13,8 +13,19 @@ Use this page for implementation-oriented links across MCP SDKs and FastMCP.
|
||||
|
||||
!!! info "FastMCP sources"
|
||||
- [FastMCP project documentation](https://gofastmcp.com/)
|
||||
- [FastMCP GitHub repository](https://github.com/jlowin/fastmcp)
|
||||
- [FastMCP examples directory](https://github.com/jlowin/fastmcp/tree/main/examples)
|
||||
- [FastMCP server identity and behavior](https://gofastmcp.com/servers/server)
|
||||
- [FastMCP providers overview](https://gofastmcp.com/servers/providers/overview)
|
||||
- [FastMCP custom providers](https://gofastmcp.com/servers/providers/custom)
|
||||
- [FastMCP skills provider](https://gofastmcp.com/servers/providers/skills)
|
||||
- [FastMCP tools and annotations](https://gofastmcp.com/servers/tools)
|
||||
- [FastMCP resources and templates](https://gofastmcp.com/servers/resources)
|
||||
- [FastMCP prompts](https://gofastmcp.com/servers/prompts)
|
||||
- [FastMCP filesystem provider](https://gofastmcp.com/servers/providers/filesystem)
|
||||
- [FastMCP argument completion](https://gofastmcp.com/servers/completions)
|
||||
- [FastMCP component icons](https://gofastmcp.com/servers/icons)
|
||||
- [FastMCP Apps](https://gofastmcp.com/apps/overview)
|
||||
- [FastMCP GitHub repository](https://github.com/PrefectHQ/fastmcp)
|
||||
- [FastMCP examples directory](https://github.com/PrefectHQ/fastmcp/tree/main/examples)
|
||||
- [FastMCP PyPI package](https://pypi.org/project/fastmcp/)
|
||||
|
||||
## Server Implementation Patterns
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
name: nicegui
|
||||
description: 'Build, review, debug, configure, deploy, and package NiceGUI applications. Use for FastAPI or Uvicorn integration, ui.run settings, native mode, Docker or executable deployment, app factories and lifespan, thin pages and reusable component factories, bindable dataclass handles, ui.refreshable methods, ui.* components, Quasar props/events/slots, Tailwind layout, colors, bindings, editable ui.table cells, uploads/forms/live updates, or version-specific source research.'
|
||||
---
|
||||
|
||||
# NiceGUI Application Guide
|
||||
|
||||
Use this skill to choose the smallest supporting reference for a NiceGUI task. The pages cover different ownership boundaries; do not load the whole reference set.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Inspect the target project's pinned NiceGUI version, entry point, and existing page/component patterns.
|
||||
2. Match the request to one row in the routing table and load that primary reference.
|
||||
3. Load the optional companion only when the task crosses the boundary named in the last column.
|
||||
4. Prefer NiceGUI's typed constructor, binding, or helper API; descend to Quasar props, events, slots, or methods only when the wrapper does not expose the required behavior.
|
||||
5. Validate the changed behavior with a focused test. For visual work, also check the supported mobile, landscape desktop, and portrait desktop viewports.
|
||||
|
||||
## Task Routing
|
||||
|
||||
| Task or symptom | Load first | Add only when |
|
||||
| --- | --- | --- |
|
||||
| Choose package boundaries, dependency direction, thin page composition, reusable component factories, returned dataclass component handles, page registration, health routes, or optional subsystem placement | [application architecture](./references/architecture.md) | Add [binding dataclasses](./references/binding-dataclasses.md) for the component handle's binding graph or [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) for concrete ASGI ownership. |
|
||||
| Decide between `ui.run()` and `ui.run_with()`, compose a parent FastAPI app, define lifespan ordering, build an app factory, configure typed settings, expose a project script, or handle reload/workers | [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) | Add [configuration and deployment](./references/configuration-and-deployment.md) for concrete `ui.run` options, hosting, native mode, or packaging. |
|
||||
| Configure `ui.run`, consume `app.urls`, select NiceGUI environment variables, run behind Docker or a reverse proxy, enable HTTPS, build a native app, package with PyInstaller or Nuitka, or evaluate NiceGUI On Air | [configuration and deployment](./references/configuration-and-deployment.md) | Add [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) when a parent ASGI app, app factory, lifespan, reload, or workers own part of startup. |
|
||||
| Choose a `ui.*` constructor, binding, Quasar prop, event, slot, or frontend method; diagnose model events, event payloads, scoped-slot props, detached popups, `ui.select`, or `ui.icon` | [component mechanics](./references/component-mechanics.md) | Add [source documentation](./references/source-documentation.md) when the installed wrapper or bundled Quasar version must be verified. |
|
||||
| Build page shells, rows, columns, grids, widths, overflow, responsive reflow, typography, font loading, static assets, or deliberate scaling | [page structure, typography, and scaling](./references/styling-and-customization.md) | Add [component mechanics](./references/component-mechanics.md) when layout depends on a Quasar prop, slot, popup, or generated component structure. |
|
||||
| Configure `app.colors()`, `ui.colors()`, semantic or fixed Quasar colors, custom color names, component color values, CSS color variables, or `ui.dark_mode()` | [NiceGUI and Quasar color theming](./references/colors-and-quasar-theming.md) | Add [page structure, typography, and scaling](./references/styling-and-customization.md) only when the task also changes physical layout or CSS loading. |
|
||||
| Model typed page or component state with `binding.bindable_dataclass`, return a bound component handle, understand propagation and transform direction, bind nested values, avoid active-link polling, or design projection/persistence rollback | [binding dataclasses](./references/binding-dataclasses.md) | Add [application architecture](./references/architecture.md) for the render-factory and thin-page boundary or [component mechanics](./references/component-mechanics.md) for browser-originated proposals. |
|
||||
| Customize `ui.table` or QTable columns, formatting, classes, props, responsive density, toolbar controls, visible columns, empty states, named slots, or frontend methods | [table customization](./references/table-customization.md) | Add [editable tables](./references/tables.md) only when cells also accept server-authoritative edits. |
|
||||
| Make `ui.table` cells editable with stable row keys, dataframe projections, row-scoped dataclasses, validation, touched rows, selection-preserving refresh, or `QPopupEdit` | [editable tables](./references/tables.md) | Follow its links to binding or component mechanics only when changing the underlying projection or event bridge. |
|
||||
| Implement uploads, form submission, SSE versus WebSockets, background jobs, duplicate-submit guards, or `@ui.refreshable` and `@ui.refreshable_method` component regions | [interaction patterns](./references/interaction-patterns.md) | Add [application architecture](./references/architecture.md) for the reusable component contract or [binding dataclasses](./references/binding-dataclasses.md) when state propagation itself is the problem. |
|
||||
| Build or explain URL-backed tabs, persistent tab panels, `ui.sub_pages` route adapters, browser-history synchronization, or parameterized routes that share one tab | [URL-backed tabs with sub pages](./references/tabbed-subpages.md) | Add [binding dataclasses](./references/binding-dataclasses.md) only when the route-backed state grows beyond the single field shown in the example. |
|
||||
| Investigate upload errors, async UI races, stale assets, navigation/state drift, or perform a compact production-readiness review | [troubleshooting and quality gates](./references/troubleshooting-and-quality-gates.md) | Follow the symptom to one detailed reference above. |
|
||||
| Verify a framework claim against primary NiceGUI, FastAPI, Uvicorn, Tailwind, Quasar, SQLAlchemy, Pydantic, or LangGraph documentation | [source documentation](./references/source-documentation.md) | Use a task page first when implementation guidance, not source lookup, is needed. |
|
||||
|
||||
## Boundary Rules
|
||||
|
||||
- Use [application architecture](./references/architecture.md) for module ownership, not for page geometry or low-level component behavior.
|
||||
- Use [FastAPI and Uvicorn startup](./references/fastapi-uvicorn-startup.md) to decide which process owns startup; use [configuration and deployment](./references/configuration-and-deployment.md) after that decision for runtime, native, hosting, and packaging settings.
|
||||
- Keep page functions thin: compose page shells and returned component handles there; keep each component's element tree, bindings, callbacks, and bounded refreshes in its render factory or component object.
|
||||
- Use [page structure, typography, and scaling](./references/styling-and-customization.md) for physical layout. Use [component mechanics](./references/component-mechanics.md) for the behavior crossing NiceGUI, Quasar, Vue, and browser boundaries.
|
||||
- Start read-only table presentation and QTable control work in [table customization](./references/table-customization.md); keep editable state and validation in [editable tables](./references/tables.md).
|
||||
- Use [binding dataclasses](./references/binding-dataclasses.md) for the binding graph and Python model projections. Use [interaction patterns](./references/interaction-patterns.md) for user workflows such as upload, submit, refresh, streaming, and background work.
|
||||
- Start editable-table work in [editable tables](./references/tables.md). It already identifies the exact binding and event sections needed by that pattern.
|
||||
- Treat [source documentation](./references/source-documentation.md) as a source index, not as an implementation workflow.
|
||||
|
||||
## Runnable Examples
|
||||
|
||||
Load an example only when its exact mechanic matches the task:
|
||||
|
||||
- [binding transforms](./examples/data_binding.py): `bindable_dataclass`, `ui.date`, and typed `forward`/`backward` conversion.
|
||||
- [select events](./examples/select_events.py): `on_change`, generic Quasar events, `update:model-value`, browser-to-Python payload forwarding, and programmatic value changes.
|
||||
- [table customization](./examples/table_customization.py): raw-value sorting with cosmetic prefix, suffix, and datetime formatting; dynamic classes; QTable props; toolbar and cell slots; filtering; visible columns; and empty states.
|
||||
- [editable table](./examples/editable_table.py): dataframe-to-row state, named QTable cell slots, controlled editors, dialog-based whole-row save/cancel edits, Python validation, touched rows, and canonical row refresh.
|
||||
- [tabbed sub-pages](./examples/tab_spa.py): a persistent shell with URL-backed tabs, tab panels, browser-history navigation, and retained state for a parameterized report route. See the [reference explanation](./references/tabbed-subpages.md) for the ownership model and behavioral boundaries.
|
||||
|
||||
## Defaults That Span References
|
||||
|
||||
- Keep composition, transport, services, pages, and components directionally separated.
|
||||
- Prefer reusable render functions that return typed component handles; use bindable dataclass fields for the state intentionally exposed to composition code.
|
||||
- Keep business logic out of UI components and event handlers.
|
||||
- Avoid blocking I/O and CPU-heavy work in the UI event loop.
|
||||
- Prefer event-driven updates and explicit refreshes to unrelated polling.
|
||||
- Keep browser-originated values as proposals; validate and normalize them in Python before mutating authoritative state.
|
||||
- Prefer NiceGUI context managers and `ui.*` elements over raw Vue templates. Keep application logic and authoritative state in Python; use minimal browser expressions only for scoped-slot values or client-only behavior, following [Python-owned slot composition](./references/component-mechanics.md#prefer-python-owned-composition).
|
||||
- For each presentation requirement, check the component's typed Python arguments and helpers before using `.props(...)` or `.classes(...)`. Create an application class and add CSS only when no Python API, documented component prop or slot, or existing utility class can express the requirement.
|
||||
- Use NiceGUI context managers for element structure and Tailwind for generic layout, spacing, responsive behavior, and typography. Keep Quasar classes for semantic palette roles or component-specific geometry, and use Quasar props for component behavior and density; see [combining Tailwind with Quasar utilities](./references/styling-and-customization.md#combine-tailwind-with-quasar-utilities-deliberately).
|
||||
- Provide loading, success, and failure states for user-triggered work.
|
||||
- Verify component-specific behavior against the installed NiceGUI version and its bundled Quasar version.
|
||||
|
||||
## Completion Check
|
||||
|
||||
Before finishing, distinguish target-repository facts from reference recommendations, cite the supporting page used for framework-specific claims, state unresolved assumptions, and report the focused behavior and viewport checks performed.
|
||||
@@ -0,0 +1,30 @@
|
||||
from dataclasses import field
|
||||
from datetime import date
|
||||
|
||||
from nicegui import binding
|
||||
from nicegui import ui
|
||||
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class ReportFilters:
|
||||
start_on: date = field(default_factory=date.today)
|
||||
page_size: int = 25
|
||||
|
||||
|
||||
filters = ReportFilters()
|
||||
|
||||
ui.date().bind_value(
|
||||
filters,
|
||||
"start_on",
|
||||
forward=date.fromisoformat, # control str -> model date
|
||||
backward=date.isoformat, # model date -> control str
|
||||
)
|
||||
|
||||
ui.label().bind_text_from(
|
||||
filters,
|
||||
"start_on",
|
||||
backward=lambda value: f"Starting {value:%d %B %Y}",
|
||||
)
|
||||
|
||||
if __name__ in {"__main__", "__mp_main__"}:
|
||||
ui.run(port=8888, reload=True)
|
||||
@@ -0,0 +1,338 @@
|
||||
#!/usr/bin/env -S uv run --script
|
||||
# /// script
|
||||
# dependencies = [
|
||||
# "nicegui==3.16.0",
|
||||
# "pandas",
|
||||
# "pydantic>=2",
|
||||
# ]
|
||||
# ///
|
||||
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
from dataclasses import field
|
||||
|
||||
import pandas as pd
|
||||
from nicegui import binding
|
||||
from nicegui import events
|
||||
from nicegui import ui
|
||||
from pydantic import BaseModel
|
||||
from pydantic import ValidationError
|
||||
from pydantic import field_validator
|
||||
|
||||
STATUS_OPTIONS = ["draft", "active", "archived"]
|
||||
EDITABLE_FIELDS = ("name", "quantity", "status")
|
||||
|
||||
type TableValue = str | int
|
||||
type TableRow = dict[str, TableValue]
|
||||
|
||||
|
||||
class RowEditDraft(BaseModel):
|
||||
name: str
|
||||
quantity: int
|
||||
status: str
|
||||
|
||||
@field_validator("name")
|
||||
@classmethod
|
||||
def validate_name(cls, value: str) -> str:
|
||||
if not (name := value.strip()):
|
||||
raise ValueError("Name is required")
|
||||
return name
|
||||
|
||||
@field_validator("quantity", mode="before")
|
||||
@classmethod
|
||||
def validate_quantity(cls, value: object) -> int:
|
||||
if isinstance(value, bool) or value is None:
|
||||
raise TypeError("Quantity must be an integer")
|
||||
if not isinstance(value, (int, float, str)):
|
||||
raise TypeError("Quantity must be an integer")
|
||||
if isinstance(value, float) and not value.is_integer():
|
||||
raise ValueError("Quantity must be an integer")
|
||||
try:
|
||||
quantity = int(value)
|
||||
except (TypeError, ValueError, OverflowError) as error:
|
||||
raise ValueError("Quantity must be an integer") from error
|
||||
if not 0 <= quantity <= 1_000:
|
||||
raise ValueError("Quantity must be between 0 and 1000")
|
||||
return quantity
|
||||
|
||||
@field_validator("status")
|
||||
@classmethod
|
||||
def validate_status(cls, value: str) -> str:
|
||||
if value not in STATUS_OPTIONS:
|
||||
raise ValueError("Unknown status")
|
||||
return value
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class RowEditorDialog:
|
||||
open_for_row_id: Callable[[int], None]
|
||||
|
||||
|
||||
def _validation_message(error: ValidationError) -> str:
|
||||
return str(error.errors()[0]["msg"])
|
||||
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class EditableRow:
|
||||
id: int
|
||||
name: str
|
||||
quantity: int
|
||||
status: str
|
||||
table_row: TableRow = field(init=False, repr=False)
|
||||
touched: bool = False
|
||||
|
||||
def __post_init__(self) -> None:
|
||||
self.table_row = {
|
||||
"id": self.id,
|
||||
"name": self.name,
|
||||
"quantity": self.quantity,
|
||||
"status": self.status,
|
||||
}
|
||||
for field_name in EDITABLE_FIELDS:
|
||||
binding.bind_to(
|
||||
self,
|
||||
field_name,
|
||||
self.table_row,
|
||||
field_name,
|
||||
other_strict=True,
|
||||
)
|
||||
|
||||
def to_draft(self) -> RowEditDraft:
|
||||
return RowEditDraft(name=self.name, quantity=self.quantity, status=self.status)
|
||||
|
||||
def validate_update(self, updates: dict[str, object]) -> RowEditDraft:
|
||||
base_values = self.to_draft().model_dump()
|
||||
return RowEditDraft.model_validate({**base_values, **updates})
|
||||
|
||||
def apply_draft(self, draft: RowEditDraft) -> None:
|
||||
self.name = draft.name
|
||||
self.quantity = draft.quantity
|
||||
self.status = draft.status
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class EditableTableState:
|
||||
rows_by_id: dict[int, EditableRow]
|
||||
|
||||
def row(self, row_id: int) -> EditableRow | None:
|
||||
return self.rows_by_id.get(row_id)
|
||||
|
||||
def table_rows(self) -> list[TableRow]:
|
||||
return [row.table_row for row in self.rows_by_id.values()]
|
||||
|
||||
def touched_rows(self) -> list[EditableRow]:
|
||||
return [row for row in self.rows_by_id.values() if row.touched]
|
||||
|
||||
|
||||
def dataframe_to_state(dataframe: pd.DataFrame) -> EditableTableState:
|
||||
required_columns = {"id", *EDITABLE_FIELDS}
|
||||
missing_columns = required_columns.difference(dataframe.columns)
|
||||
if missing_columns:
|
||||
raise ValueError(f"Missing columns: {sorted(missing_columns)}")
|
||||
if not dataframe["id"].is_unique:
|
||||
raise ValueError("The id column must contain unique row keys")
|
||||
|
||||
rows_by_id: dict[int, EditableRow] = {}
|
||||
for record in dataframe.to_dict(orient="records"):
|
||||
row = EditableRow(
|
||||
id=int(record["id"]),
|
||||
name=str(record["name"]),
|
||||
quantity=int(record["quantity"]),
|
||||
status=str(record["status"]),
|
||||
)
|
||||
if row.status not in STATUS_OPTIONS:
|
||||
raise ValueError(f"Unknown status {row.status!r}")
|
||||
if row.id in rows_by_id:
|
||||
raise ValueError("Row keys must remain unique after normalization")
|
||||
rows_by_id[row.id] = row
|
||||
|
||||
return EditableTableState(rows_by_id)
|
||||
|
||||
|
||||
def render_row_editor_dialog(
|
||||
state: EditableTableState,
|
||||
refresh_table: Callable[[], None],
|
||||
) -> RowEditorDialog:
|
||||
selected_row_id: int | None = None
|
||||
|
||||
with ui.dialog() as edit_dialog, ui.card().classes("w-96"):
|
||||
dialog_heading = ui.label("Edit row")
|
||||
draft_name = ui.input("Name")
|
||||
draft_quantity = ui.number("Quantity", min=0, max=1_000, precision=0)
|
||||
draft_status = ui.select(STATUS_OPTIONS, label="Status")
|
||||
with ui.row().classes("w-full justify-end"):
|
||||
ui.button("Cancel", on_click=edit_dialog.close).props("flat")
|
||||
|
||||
def save_dialog_edit() -> None:
|
||||
nonlocal selected_row_id
|
||||
try:
|
||||
if selected_row_id is None:
|
||||
raise ValueError("Select a row before saving")
|
||||
|
||||
row_state = state.row(selected_row_id)
|
||||
if row_state is None:
|
||||
raise ValueError("This row no longer exists")
|
||||
|
||||
draft = row_state.validate_update(
|
||||
{
|
||||
"name": draft_name.value,
|
||||
"quantity": draft_quantity.value,
|
||||
"status": draft_status.value,
|
||||
},
|
||||
)
|
||||
row_state.apply_draft(draft)
|
||||
row_state.touched = True
|
||||
edit_dialog.close()
|
||||
except ValidationError as error:
|
||||
ui.notify(_validation_message(error), type="negative")
|
||||
except ValueError as error:
|
||||
ui.notify(str(error), type="negative")
|
||||
finally:
|
||||
refresh_table()
|
||||
|
||||
ui.button("Save", icon="save", on_click=save_dialog_edit)
|
||||
|
||||
def open_for_row_id(row_id: int) -> None:
|
||||
nonlocal selected_row_id
|
||||
row_state = state.row(row_id)
|
||||
if row_state is None:
|
||||
ui.notify("This row no longer exists", type="negative")
|
||||
return
|
||||
|
||||
selected_row_id = row_id
|
||||
draft = row_state.to_draft()
|
||||
dialog_heading.set_text(f"Edit row {row_id}")
|
||||
draft_name.set_value(draft.name)
|
||||
draft_quantity.set_value(draft.quantity)
|
||||
draft_status.set_value(draft.status)
|
||||
edit_dialog.open()
|
||||
|
||||
return RowEditorDialog(open_for_row_id=open_for_row_id)
|
||||
|
||||
|
||||
def render_table(dataframe: pd.DataFrame) -> EditableTableState:
|
||||
state = dataframe_to_state(dataframe)
|
||||
columns = [
|
||||
{"name": "name", "label": "Name", "field": "name", "align": "left"},
|
||||
{"name": "quantity", "label": "Quantity", "field": "quantity", "align": "right"},
|
||||
{"name": "status", "label": "Status", "field": "status", "align": "left"},
|
||||
{"name": "actions", "label": "Actions", "field": "id", "align": "center"},
|
||||
]
|
||||
table = ui.table(
|
||||
columns=columns,
|
||||
rows=state.table_rows(),
|
||||
row_key="id",
|
||||
selection="multiple",
|
||||
pagination=10,
|
||||
).classes("w-120")
|
||||
|
||||
def refresh_table() -> None:
|
||||
table.update_rows(state.table_rows(), clear_selection=False)
|
||||
|
||||
def apply_inline_edit(event: events.GenericEventArguments) -> None:
|
||||
try:
|
||||
raw_row_id, raw_field, raw_value = event.args
|
||||
row_id = int(raw_row_id)
|
||||
field_name = str(raw_field)
|
||||
if field_name not in EDITABLE_FIELDS:
|
||||
raise ValueError(f"Field {field_name!r} is not editable")
|
||||
|
||||
row_state = state.row(row_id)
|
||||
if row_state is None:
|
||||
raise ValueError("This row no longer exists")
|
||||
|
||||
draft = row_state.validate_update({field_name: raw_value})
|
||||
row_state.apply_draft(draft)
|
||||
row_state.touched = True
|
||||
except ValidationError as error:
|
||||
ui.notify(_validation_message(error), type="negative")
|
||||
except (TypeError, ValueError) as error:
|
||||
ui.notify(str(error), type="negative")
|
||||
finally:
|
||||
refresh_table()
|
||||
|
||||
def show_changes() -> None:
|
||||
changed_rows = state.touched_rows()
|
||||
if not changed_rows:
|
||||
ui.notify("No rows changed")
|
||||
return
|
||||
for row in changed_rows:
|
||||
ui.notify(f"Changed row: {row.id}: {row.name}, quantity {row.quantity}, status {row.status}")
|
||||
|
||||
row_editor = render_row_editor_dialog(state, refresh_table)
|
||||
|
||||
_add_slots(
|
||||
table,
|
||||
apply_inline_edit,
|
||||
row_editor.open_for_row_id,
|
||||
)
|
||||
|
||||
with ui.row().classes("w-120 justify-end"):
|
||||
ui.button("Show changes", icon="edit_note", on_click=show_changes)
|
||||
|
||||
return state
|
||||
|
||||
|
||||
def open_dialog_for_row(open_editor: Callable[[int], None], event: events.GenericEventArguments) -> None:
|
||||
try:
|
||||
row_id = int(event.args)
|
||||
open_editor(row_id)
|
||||
except (TypeError, ValueError):
|
||||
ui.notify("Invalid row key", type="negative")
|
||||
|
||||
|
||||
def _add_slots(
|
||||
table: ui.table,
|
||||
apply_inline_edit: Callable[[events.GenericEventArguments], None],
|
||||
open_editor: Callable[[int], None],
|
||||
):
|
||||
with table.add_slot("body-cell-name"), table.cell("name"):
|
||||
name_input = ui.input().props(remove="value")
|
||||
name_input.props(':value="props.value" dense borderless debounce=400').on(
|
||||
"update:value",
|
||||
handler=apply_inline_edit,
|
||||
js_handler="(value) => emit(props.row.id, props.col.name, value)",
|
||||
)
|
||||
|
||||
with table.add_slot("body-cell-quantity"), table.cell("quantity"):
|
||||
ui.number(min=0, max=1_000).props(':model-value="props.value" dense borderless debounce=400').on(
|
||||
"update:model-value",
|
||||
handler=apply_inline_edit,
|
||||
js_handler="(value) => emit(props.row.id, props.col.name, value)",
|
||||
)
|
||||
|
||||
with table.add_slot("body-cell-status"), table.cell("status"):
|
||||
ui.select(STATUS_OPTIONS).props(':model-value="props.value" dense borderless options-dense').on(
|
||||
"update:model-value",
|
||||
handler=apply_inline_edit,
|
||||
js_handler="(option) => emit(props.row.id, props.col.name, option.label)",
|
||||
)
|
||||
|
||||
with table.add_slot("body-cell-actions"), table.cell("actions"):
|
||||
edit_button = ui.button(icon="edit")
|
||||
edit_button.props('flat round dense color=primary aria-label="Edit row"')
|
||||
edit_button.tooltip("Edit this row").on(
|
||||
"click",
|
||||
handler=lambda event: open_dialog_for_row(open_editor, event),
|
||||
js_handler="() => emit(props.row.id)",
|
||||
)
|
||||
|
||||
|
||||
if __name__ in {"__main__", "__mp_main__"}:
|
||||
items = pd.DataFrame(
|
||||
[
|
||||
{"id": 101, "name": "Desk", "quantity": 4, "status": "active"},
|
||||
{"id": 102, "name": "Lamp", "quantity": 12, "status": "draft"},
|
||||
{"id": 103, "name": "Chair", "quantity": 8, "status": "active"},
|
||||
{"id": 104, "name": "Shelf", "quantity": 3, "status": "draft"},
|
||||
{"id": 105, "name": "Monitor", "quantity": 15, "status": "active"},
|
||||
{"id": 106, "name": "Keyboard", "quantity": 20, "status": "active"},
|
||||
{"id": 107, "name": "Mouse", "quantity": 24, "status": "active"},
|
||||
{"id": 108, "name": "Dock", "quantity": 6, "status": "archived"},
|
||||
{"id": 109, "name": "Cable", "quantity": 40, "status": "draft"},
|
||||
{"id": 110, "name": "Stand", "quantity": 10, "status": "active"},
|
||||
]
|
||||
)
|
||||
table_state = render_table(items)
|
||||
|
||||
ui.run(port=8888, reload=True)
|
||||
@@ -0,0 +1,64 @@
|
||||
#!/usr/bin/env -S uv run --script
|
||||
# /// script
|
||||
# dependencies = [
|
||||
# "nicegui==3.16.0",
|
||||
# ]
|
||||
# ///
|
||||
|
||||
from datetime import UTC
|
||||
from datetime import datetime
|
||||
|
||||
from nicegui import events
|
||||
from nicegui import ui
|
||||
|
||||
OPTIONS = {
|
||||
"python": "Python",
|
||||
"typescript": "TypeScript",
|
||||
"rust": "Rust",
|
||||
}
|
||||
|
||||
|
||||
with ui.card().classes("w-140 max-w-full"):
|
||||
ui.label("Select event mechanics").classes("text-xl font-semibold")
|
||||
event_log = ui.log(max_lines=12).classes("w-full h-64")
|
||||
|
||||
def record(event_name: str, payload: object) -> None:
|
||||
timestamp = datetime.now(UTC).astimezone().strftime("%H:%M:%S")
|
||||
event_log.push(f"{timestamp} {event_name}: {payload!r}")
|
||||
|
||||
def handle_change(event: events.ValueChangeEventArguments) -> None:
|
||||
record("on_change event.value", event.value)
|
||||
|
||||
def handle_model_update(event: events.GenericEventArguments) -> None:
|
||||
record("js_handler -> handler event.args", event.args)
|
||||
|
||||
language = (
|
||||
ui.select(
|
||||
options=OPTIONS,
|
||||
value="python",
|
||||
label="Language",
|
||||
on_change=handle_change,
|
||||
with_input=True,
|
||||
clearable=True,
|
||||
)
|
||||
.props("outlined options-dense")
|
||||
.classes("w-full text-h6")
|
||||
)
|
||||
|
||||
language.on("popup-show", lambda: record("popup-show", None), args=[])
|
||||
language.on("popup-hide", lambda: record("popup-hide", None), args=[])
|
||||
|
||||
# This only fires when the value is changed from the browser side (not from the button)
|
||||
language.on(
|
||||
"update:model-value",
|
||||
handler=handle_model_update,
|
||||
js_handler="(...args) => emit(...args)",
|
||||
)
|
||||
|
||||
with ui.row().classes("w-full justify-end"):
|
||||
ui.button("Set Rust", on_click=lambda: language.set_value("rust"))
|
||||
ui.button("Clear log", on_click=event_log.clear).props("flat")
|
||||
|
||||
|
||||
if __name__ in {"__main__", "__mp_main__"}:
|
||||
ui.run(port=8888, reload=True)
|
||||
+210
@@ -0,0 +1,210 @@
|
||||
#!/usr/bin/env -S uv run --script
|
||||
# /// script
|
||||
# dependencies = [
|
||||
# "nicegui==3.16.0",
|
||||
# ]
|
||||
# ///
|
||||
|
||||
"""Demonstrate URL-backed tabs with persistent parameterized-route state."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from urllib.parse import urlsplit
|
||||
|
||||
from nicegui import binding
|
||||
from nicegui import events
|
||||
from nicegui import ui
|
||||
from nicegui.elements.tabs import Tab
|
||||
from nicegui.elements.tabs import TabPanel
|
||||
|
||||
type PageBuilder = Callable[..., None]
|
||||
|
||||
DEFAULT_REPORT_PATH = "/reports/a"
|
||||
REPORTS_TAB = "reports"
|
||||
TAB_ROUTES = frozenset({"/", "/projects", "/settings"})
|
||||
|
||||
|
||||
def page_heading(title: str, description: str) -> None:
|
||||
"""Render a shared heading for sub-page content."""
|
||||
with ui.column().classes("w-full gap-1"):
|
||||
ui.label(title).classes("text-3xl font-semibold text-stone-900")
|
||||
ui.label(description).classes("text-base text-stone-600")
|
||||
|
||||
|
||||
def overview_page() -> None:
|
||||
"""Render the overview sub-page."""
|
||||
with ui.column().classes("w-full max-w-6xl mx-auto gap-6 px-4 py-8"):
|
||||
page_heading("Overview", "A quick read on the workspace today.")
|
||||
|
||||
metrics = (
|
||||
("Active projects", "8", "folder_open", "primary"),
|
||||
("Tasks completed", "24", "task_alt", "positive"),
|
||||
("Needs attention", "3", "error_outline", "warning"),
|
||||
)
|
||||
with ui.grid().classes("w-full grid-cols-1 gap-4 md:grid-cols-3"):
|
||||
for label, value, icon, color in metrics:
|
||||
with ui.card().classes("w-full p-5 gap-3"):
|
||||
with ui.row().classes("w-full items-center justify-between"):
|
||||
ui.label(label).classes("text-sm font-medium text-stone-600")
|
||||
ui.icon(icon, color=color).classes("text-2xl")
|
||||
ui.label(value).classes("text-3xl font-semibold text-stone-900")
|
||||
|
||||
|
||||
def projects_page() -> None:
|
||||
"""Render the projects sub-page."""
|
||||
with ui.column().classes("w-full max-w-6xl mx-auto gap-6 px-4 py-8"):
|
||||
page_heading("Projects", "Each route builds its own content inside the shared shell.")
|
||||
|
||||
with ui.list().props("bordered separator").classes("w-full bg-white rounded"):
|
||||
for name, status, color in (
|
||||
("Client portal", "On track", "positive"),
|
||||
("Mobile refresh", "In review", "primary"),
|
||||
("Data migration", "Blocked", "negative"),
|
||||
):
|
||||
with ui.item():
|
||||
with ui.item_section().props("avatar"):
|
||||
ui.icon("folder", color=color)
|
||||
with ui.item_section():
|
||||
ui.item_label(name)
|
||||
ui.item_label(status).props("caption")
|
||||
with ui.item_section().props("side"):
|
||||
ui.badge(status, color=color)
|
||||
|
||||
|
||||
def report_page(state: NavigationState) -> None:
|
||||
"""Render report content bound to the active route parameter."""
|
||||
with ui.column().classes("w-full max-w-6xl mx-auto gap-6 px-4 py-8"):
|
||||
with ui.column().classes("w-full gap-1"):
|
||||
ui.label().bind_text_from(
|
||||
state,
|
||||
"active_report_path",
|
||||
backward=lambda path: f"Report {report_id_from_path(path).upper()}",
|
||||
).classes("text-3xl font-semibold text-stone-900")
|
||||
ui.label("The report ID is injected from the URL path.").classes("text-base text-stone-600")
|
||||
|
||||
with ui.card().classes("w-full max-w-2xl p-5 gap-4"):
|
||||
ui.label("Parameterized route").classes("text-xl font-semibold text-stone-900")
|
||||
ui.label().bind_text_from(
|
||||
state,
|
||||
"active_report_path",
|
||||
backward=lambda path: f"Loaded {path}",
|
||||
).classes("text-stone-600")
|
||||
with ui.row().classes("gap-2"):
|
||||
ui.button("Report A", on_click=lambda: ui.navigate.to("/reports/a")).props("outline")
|
||||
ui.button("Report B", on_click=lambda: ui.navigate.to("/reports/b")).props("outline")
|
||||
|
||||
|
||||
def settings_page() -> None:
|
||||
"""Render the settings sub-page."""
|
||||
with ui.column().classes("w-full max-w-6xl mx-auto gap-6 px-4 py-8"):
|
||||
page_heading("Settings", "Controls here are recreated when this sub-page is opened.")
|
||||
|
||||
with ui.card().classes("w-full max-w-2xl p-5 gap-4"):
|
||||
ui.label("Notifications").classes("text-xl font-semibold text-stone-900")
|
||||
ui.switch("Weekly summary", value=True)
|
||||
ui.switch("Project status changes", value=True)
|
||||
ui.switch("Product announcements", value=False)
|
||||
|
||||
|
||||
def normalize_route(path: str) -> str:
|
||||
"""Extract and normalize the path portion of a route."""
|
||||
return urlsplit(path).path.rstrip("/") or "/"
|
||||
|
||||
|
||||
def tab_name_for_route(route: str) -> str:
|
||||
"""Return the tab name associated with a concrete route."""
|
||||
if route.startswith("/reports/"):
|
||||
return REPORTS_TAB
|
||||
return route if route in TAB_ROUTES else "/"
|
||||
|
||||
|
||||
@binding.bindable_dataclass
|
||||
class NavigationState:
|
||||
"""Store client-local navigation state for parameterized tabs."""
|
||||
|
||||
active_report_path: str = DEFAULT_REPORT_PATH
|
||||
|
||||
|
||||
type TabHandler = events.ValueChangeEventArguments[str | Tab | TabPanel | None]
|
||||
|
||||
|
||||
def report_id_from_path(path: str) -> str:
|
||||
"""Extract the report ID from a normalized report route."""
|
||||
return path.rsplit("/", maxsplit=1)[-1]
|
||||
|
||||
|
||||
def create_tabs(state: NavigationState, initial_route: str) -> ui.tabs:
|
||||
"""Create route-aware tabs and retain the last selected report."""
|
||||
|
||||
def navigate(event: TabHandler) -> None:
|
||||
"""Navigate to the route represented by the selected tab."""
|
||||
match event.value:
|
||||
case str(tabname):
|
||||
destination = state.active_report_path if tabname == REPORTS_TAB else tabname
|
||||
ui.navigate.to(destination)
|
||||
case _:
|
||||
return
|
||||
|
||||
with ui.column().classes("mx-auto"), ui.tabs() as tabs:
|
||||
ui.tab("/", label="Overview", icon="space_dashboard")
|
||||
ui.tab("/projects", label="Projects", icon="folder_open")
|
||||
ui.tab(REPORTS_TAB, label="Reports", icon="summarize")
|
||||
ui.tab("/settings", label="Settings", icon="settings")
|
||||
|
||||
tabs.set_value(tab_name_for_route(initial_route))
|
||||
tabs.on_value_change(navigate)
|
||||
|
||||
return tabs
|
||||
|
||||
|
||||
def render_tab_panels(tabs: ui.tabs, state: NavigationState, active_tab: str) -> None:
|
||||
"""Render all tabbed page content inside a tab panels container."""
|
||||
with ui.tab_panels(tabs, value=active_tab, animated=True).classes("w-full"):
|
||||
with ui.tab_panel("/"):
|
||||
overview_page()
|
||||
with ui.tab_panel("/projects"):
|
||||
projects_page()
|
||||
with ui.tab_panel(REPORTS_TAB):
|
||||
report_page(state)
|
||||
with ui.tab_panel("/settings"):
|
||||
settings_page()
|
||||
|
||||
|
||||
def root() -> None:
|
||||
"""Build the persistent application shell and sub-page container."""
|
||||
initial_route = normalize_route(ui.context.client.sub_pages_router.current_path)
|
||||
state = NavigationState()
|
||||
if tab_name_for_route(initial_route) == REPORTS_TAB:
|
||||
state.active_report_path = initial_route
|
||||
|
||||
with ui.header(elevated=True).classes("py-0 items-center"):
|
||||
tabs = create_tabs(state, initial_route)
|
||||
ui.button(icon="settings").classes("text-white").props("round flat").tooltip("Settings")
|
||||
|
||||
render_tab_panels(tabs, state, tab_name_for_route(initial_route))
|
||||
|
||||
def route_overview() -> None:
|
||||
tabs.set_value("/")
|
||||
|
||||
def route_projects() -> None:
|
||||
tabs.set_value("/projects")
|
||||
|
||||
def route_reports(report_id: str) -> None:
|
||||
state.active_report_path = f"/reports/{report_id}"
|
||||
tabs.set_value(REPORTS_TAB)
|
||||
|
||||
def route_settings() -> None:
|
||||
tabs.set_value("/settings")
|
||||
|
||||
routes: dict[str, PageBuilder] = {
|
||||
"/": route_overview,
|
||||
"/projects": route_projects,
|
||||
"/reports/{report_id}": route_reports,
|
||||
"/settings": route_settings,
|
||||
}
|
||||
ui.sub_pages(routes).classes("hidden")
|
||||
|
||||
|
||||
if __name__ in {"__main__", "__mp_main__"}:
|
||||
ui.run(root, title="Northstar", port=8888, reload=True)
|
||||
@@ -0,0 +1,253 @@
|
||||
#!/usr/bin/env -S uv run --script
|
||||
# /// script
|
||||
# dependencies = [
|
||||
# "nicegui==3.16.0",
|
||||
# ]
|
||||
# ///
|
||||
|
||||
from nicegui import events
|
||||
from nicegui import ui
|
||||
|
||||
type TableValue = str | int | float
|
||||
type TableRow = dict[str, TableValue]
|
||||
|
||||
STATUS_COLORS = {
|
||||
"Ready": "positive",
|
||||
"Low": "warning",
|
||||
"Backorder": "negative",
|
||||
}
|
||||
|
||||
COLUMNS = [
|
||||
{
|
||||
"name": "actions",
|
||||
"label": "Actions",
|
||||
"required": True,
|
||||
"align": "center",
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"label": "Product",
|
||||
"field": "name",
|
||||
"required": True,
|
||||
"sortable": True,
|
||||
"align": "left",
|
||||
"headerClasses": "bg-grey-2 text-grey-9 font-bold",
|
||||
"classes": "font-medium",
|
||||
"headerStyle": "width: 40%; min-width: 12rem",
|
||||
"style": "width: 40%; min-width: 12rem",
|
||||
},
|
||||
{
|
||||
"name": "category",
|
||||
"label": "Category",
|
||||
"field": "category",
|
||||
"sortable": True,
|
||||
"align": "left",
|
||||
"headerStyle": "width: 9rem",
|
||||
"style": "width: 9rem",
|
||||
},
|
||||
{
|
||||
"name": "stock",
|
||||
"label": "In stock",
|
||||
"field": "stock",
|
||||
"sortable": True,
|
||||
"align": "right",
|
||||
"headerStyle": "width: 7rem",
|
||||
"style": "width: 7rem",
|
||||
":classes": "row => row.stock < 10 ? 'text-negative font-bold' : ''",
|
||||
":format": "value => value == null ? '' : `${value} units`",
|
||||
},
|
||||
{
|
||||
"name": "price",
|
||||
"label": "Unit price",
|
||||
"field": "price",
|
||||
"sortable": True,
|
||||
"align": "right",
|
||||
"headerStyle": "width: 8rem",
|
||||
"style": "width: 8rem",
|
||||
":format": "value => value == null ? '' : `$${value.toFixed(2)}`",
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"label": "Status",
|
||||
"field": "status",
|
||||
"sortable": True,
|
||||
"align": "center",
|
||||
"headerStyle": "width: 8rem",
|
||||
"style": "width: 8rem",
|
||||
"colorByValue": STATUS_COLORS,
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"label": "Updated",
|
||||
"field": "updated_at",
|
||||
"sortable": True,
|
||||
"align": "left",
|
||||
"headerStyle": "width: 13rem",
|
||||
"style": "width: 13rem",
|
||||
":sort": "(left, right) => Date.parse(left) - Date.parse(right)",
|
||||
":format": """(() => {
|
||||
const formatter = new Intl.DateTimeFormat('en-US', {
|
||||
dateStyle: 'medium',
|
||||
timeStyle: 'short',
|
||||
timeZone: 'UTC',
|
||||
});
|
||||
return value => {
|
||||
if (!value) return '';
|
||||
const timestamp = Date.parse(value);
|
||||
return Number.isNaN(timestamp) ? 'Invalid date' : formatter.format(timestamp);
|
||||
};
|
||||
})()""",
|
||||
},
|
||||
]
|
||||
|
||||
ROWS: list[TableRow] = [
|
||||
{
|
||||
"id": 101,
|
||||
"name": "Desk lamp",
|
||||
"category": "Lighting",
|
||||
"stock": 7,
|
||||
"price": 42.5,
|
||||
"status": "Low",
|
||||
"updated_at": "2026-08-31T16:20:00Z",
|
||||
},
|
||||
{
|
||||
"id": 102,
|
||||
"name": "Task chair",
|
||||
"category": "Seating",
|
||||
"stock": 18,
|
||||
"price": 289.0,
|
||||
"status": "Ready",
|
||||
"updated_at": "2026-09-01T08:45:00Z",
|
||||
},
|
||||
{
|
||||
"id": 103,
|
||||
"name": "Monitor arm",
|
||||
"category": "Hardware",
|
||||
"stock": 0,
|
||||
"price": 119.95,
|
||||
"status": "Backorder",
|
||||
"updated_at": "2026-08-29T11:05:00Z",
|
||||
},
|
||||
{
|
||||
"id": 104,
|
||||
"name": "Cable tray",
|
||||
"category": "Hardware",
|
||||
"stock": 34,
|
||||
"price": 31.25,
|
||||
"status": "Ready",
|
||||
"updated_at": "2026-09-01T14:30:00Z",
|
||||
},
|
||||
{
|
||||
"id": 105,
|
||||
"name": "Side table",
|
||||
"category": "Furniture",
|
||||
"stock": 9,
|
||||
"price": 164.5,
|
||||
"status": "Low",
|
||||
"updated_at": "2026-08-30T19:15:00Z",
|
||||
},
|
||||
{
|
||||
"id": 106,
|
||||
"name": "Floor light",
|
||||
"category": "Lighting",
|
||||
"stock": 15,
|
||||
"price": 98.0,
|
||||
"status": "Ready",
|
||||
"updated_at": "2026-09-01T10:10:00Z",
|
||||
},
|
||||
]
|
||||
|
||||
|
||||
def render_table() -> ui.table:
|
||||
table = ui.table(
|
||||
columns=COLUMNS,
|
||||
column_defaults={"headerClasses": "text-grey-8"},
|
||||
rows=ROWS,
|
||||
row_key="id",
|
||||
pagination={
|
||||
"sortBy": "stock",
|
||||
"descending": True,
|
||||
"rowsPerPage": 5,
|
||||
},
|
||||
).classes("w-full max-w-5xl")
|
||||
|
||||
(
|
||||
table.props(
|
||||
# Surface and cell layout.
|
||||
"flat bordered separator=horizontal wrap-cells"
|
||||
)
|
||||
.props(
|
||||
# Local sorting and page-size choices; zero means "all rows".
|
||||
'binary-state-sort :rows-per-page-options="[5, 10, 0]"'
|
||||
)
|
||||
.props(
|
||||
# Compact cells only below Quasar's medium breakpoint.
|
||||
':dense="Quasar.Screen.lt.md"'
|
||||
)
|
||||
.props(
|
||||
# Distinguish an empty dataset from a filter with no matches.
|
||||
'no-data-label="No inventory items" no-results-label="No matching inventory items"'
|
||||
)
|
||||
)
|
||||
|
||||
with table.add_slot("top-left"), ui.row(align_items="center").classes("gap-2"):
|
||||
ui.icon("inventory_2", size="sm", color="primary")
|
||||
ui.label("Inventory").classes("text-xl font-medium")
|
||||
ui.badge(str(len(ROWS)), color="grey-3", text_color="grey-9")
|
||||
|
||||
with table.add_slot("top-right"):
|
||||
ui.input(placeholder="Search inventory").props("dense outlined clearable debounce=250").bind_value_to(
|
||||
table,
|
||||
"filter",
|
||||
)
|
||||
|
||||
with table.add_slot("body-cell-status"), table.cell("status"):
|
||||
ui.badge(outline=True).props(':label="props.value" :color="props.col.colorByValue[props.value] ?? \'grey\'"')
|
||||
|
||||
def open_product(event: events.GenericEventArguments) -> None:
|
||||
product = next((row for row in table.rows if row[table.row_key] == event.args), None)
|
||||
if product is None:
|
||||
ui.notify("Product no longer exists", type="negative")
|
||||
return
|
||||
ui.notify(f"Opening {product['name']}")
|
||||
|
||||
with (
|
||||
table.add_slot("body-cell-actions"),
|
||||
table.cell("actions"),
|
||||
ui.button(icon="open_in_new")
|
||||
.props("round flat size='sm'")
|
||||
.on(
|
||||
"click.stop",
|
||||
handler=open_product,
|
||||
js_handler="() => emit(props.key)",
|
||||
),
|
||||
):
|
||||
ui.tooltip("Open product")
|
||||
|
||||
with table.add_slot("no-data"), ui.row(align_items="center").classes("w-full justify-center gap-2 p-6 text-grey-7"):
|
||||
ui.icon("inventory_2", size="2em").props(":name=\"props.filter ? 'filter_alt_off' : 'inventory_2'\"")
|
||||
ui.element("span").props(':textContent="props.message"')
|
||||
|
||||
optional_columns = [column for column in table.columns if not column.get("required")]
|
||||
|
||||
def set_visible_columns(names: list[str]) -> None:
|
||||
table.props["visible-columns"] = names
|
||||
table.update()
|
||||
|
||||
ui.select(
|
||||
{column["name"]: column["label"] for column in optional_columns},
|
||||
value=[column["name"] for column in optional_columns],
|
||||
label="Visible columns",
|
||||
multiple=True,
|
||||
clearable=True,
|
||||
on_change=lambda event: set_visible_columns(event.value),
|
||||
).props("outlined dense options-dense").classes("w-64")
|
||||
|
||||
return table
|
||||
|
||||
|
||||
if __name__ in {"__main__", "__mp_main__"}:
|
||||
with ui.column(align_items="center").classes("w-full gap-4 p-4"):
|
||||
render_table()
|
||||
|
||||
ui.run(port=8888, reload=True)
|
||||
@@ -0,0 +1,236 @@
|
||||
# NiceGUI Application Architecture
|
||||
|
||||
Load this reference for application composition, package boundaries, and optional subsystem decisions.
|
||||
|
||||
## Baseline Package Boundaries
|
||||
|
||||
- `main.py`: process entry point and app factory exposure.
|
||||
- `bootstrap.py`: app composition, router wiring, page registration, and lifespan orchestration.
|
||||
- `config.py`: typed settings and environment parsing.
|
||||
- `logging.py`: centralized logging setup.
|
||||
- `api/`: HTTP transport that delegates to services.
|
||||
- `services/`: business and use-case logic.
|
||||
- `ui/pages/`: route-level NiceGUI pages.
|
||||
- `ui/components/`: shared presentation building blocks.
|
||||
|
||||
Recommended base shape:
|
||||
|
||||
```text
|
||||
.
|
||||
├─ pyproject.toml
|
||||
├─ .env.example
|
||||
├─ src/
|
||||
│ └─ app/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ main.py
|
||||
│ ├─ config.py
|
||||
│ ├─ logging.py
|
||||
│ ├─ api/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ health.py
|
||||
│ ├─ services/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ example_service.py
|
||||
│ └─ ui/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ components/
|
||||
│ │ ├─ __init__.py
|
||||
│ │ └─ nav.py
|
||||
│ └─ pages/
|
||||
│ ├─ __init__.py
|
||||
│ ├─ home.py
|
||||
│ ├─ dashboard.py
|
||||
│ └─ about.py
|
||||
└─ tests/
|
||||
├─ test_health.py
|
||||
└─ test_pages_registration.py
|
||||
```
|
||||
|
||||
## Required Baseline Behavior
|
||||
|
||||
- FastAPI is the base ASGI app.
|
||||
- `create_app()` composes routes, resources, and NiceGUI.
|
||||
- Lifespan owns startup and shutdown resources.
|
||||
- NiceGUI pages are modular and explicitly registered.
|
||||
- FastAPI exposes a health route such as `/healthz`.
|
||||
- Imports do not trigger runtime global side effects.
|
||||
|
||||
For the ownership relationship between a caller-created FastAPI app, `nicegui.app`, `ui.run_with()`, Uvicorn, and a packaged startup command, load [FastAPI and Uvicorn startup](./fastapi-uvicorn-startup.md).
|
||||
|
||||
## Dependency Direction
|
||||
|
||||
Prefer:
|
||||
|
||||
- `main/bootstrap` -> `config/logging` + `api` + `ui/pages` + `services`
|
||||
- `api` -> `services`
|
||||
- `ui/pages` -> `ui/components` + `services`
|
||||
- `services` -> helpers, clients, and `db/` when enabled
|
||||
|
||||
Avoid imports from services back into API or UI modules.
|
||||
|
||||
## Page And Component Ownership
|
||||
|
||||
Page modules should be a thin route-level composition layer. A page resolves route inputs and page-scoped dependencies, establishes the page shell, composes reusable components, and wires only the interactions that cross component boundaries. It should not contain a component's internal element tree, field bindings, refresh logic, domain rules, persistence, or long-running synchronous work.
|
||||
|
||||
Extract a presentation pattern to `ui/components/` when it appears on two or more pages or owns a meaningful state or interaction boundary. Reusable components should accept initial data, use-case functions, and event callbacks explicitly instead of importing page state or business services implicitly.
|
||||
|
||||
For page composition, responsive layout, Quasar props, and CSS customization, load [styling and customization](./styling-and-customization.md).
|
||||
|
||||
## Reusable Component Contract
|
||||
|
||||
In this architecture, a "component" is an application-level composition pattern, not necessarily a custom Vue component or a subclass of NiceGUI `Element`. Its usual shape is:
|
||||
|
||||
1. A typed dataclass represents the component's public handle and local UI state.
|
||||
2. A render or factory function creates one component instance, builds its element subtree, and binds elements to that instance.
|
||||
3. The function returns the instance so its caller can read or change intentional state, invoke public actions, or coordinate it with another component.
|
||||
4. Internal elements, event handlers, validation feedback, and refreshable regions remain private to the component unless an imperative element handle is intentionally part of its API.
|
||||
|
||||
Use [`binding.bindable_dataclass`](./binding-dataclasses.md) for fields that drive or receive element properties. Plain `@dataclass` is sufficient when the returned object only groups element handles or callbacks and does not need immediate field propagation. Use `bindable_fields` when the dataclass also stores injected dependencies or other fields that should not participate in NiceGUI's binding graph.
|
||||
|
||||
```python
|
||||
from collections.abc import Awaitable, Callable
|
||||
from dataclasses import field
|
||||
|
||||
from nicegui import binding, ui
|
||||
|
||||
|
||||
Search = Callable[[str], Awaitable[list[str]]]
|
||||
|
||||
|
||||
@binding.bindable_dataclass(bindable_fields={"query", "busy", "items"})
|
||||
class SearchPanel:
|
||||
search: Search = field(repr=False)
|
||||
query: str = ""
|
||||
busy: bool = False
|
||||
items: list[str] = field(default_factory=list)
|
||||
|
||||
@ui.refreshable_method
|
||||
def render_results(self) -> None:
|
||||
if not self.items:
|
||||
ui.label("No results")
|
||||
for item in self.items:
|
||||
ui.label(item)
|
||||
|
||||
async def submit(self) -> None:
|
||||
if self.busy:
|
||||
return
|
||||
self.busy = True
|
||||
try:
|
||||
self.items = await self.search(self.query)
|
||||
await self.render_results.refresh()
|
||||
finally:
|
||||
self.busy = False
|
||||
|
||||
|
||||
def render_search_panel(search: Search) -> SearchPanel:
|
||||
panel = SearchPanel(search=search)
|
||||
with ui.column().classes("w-full gap-3"):
|
||||
ui.input("Search").bind_value(panel, "query")
|
||||
ui.button("Search", on_click=panel.submit).bind_enabled_from(
|
||||
panel,
|
||||
"busy",
|
||||
backward=lambda busy: not busy,
|
||||
)
|
||||
ui.label().bind_text_from(
|
||||
panel,
|
||||
"items",
|
||||
backward=lambda items: f"{len(items)} results",
|
||||
)
|
||||
panel.render_results()
|
||||
return panel
|
||||
```
|
||||
|
||||
The returned dataclass is the component API. Its bindable fields synchronize stable element properties, while `render_results()` owns a bounded region whose child structure changes with `items`. The injected `search` callable preserves dependency direction: the component can invoke a use case without locating a service globally.
|
||||
|
||||
[`@ui.refreshable_method`](https://nicegui.io/documentation/refreshable) is the instance-oriented refresh surface for this pattern. NiceGUI records refresh targets by method instance, allowing each page-created component object to refresh independently. Detailed target, argument, async, and lifecycle behavior is documented under [refreshable component regions](./interaction-patterns.md#refreshable-component-regions).
|
||||
|
||||
### Thin Page Example
|
||||
|
||||
```python
|
||||
from nicegui import ui
|
||||
|
||||
from app.services.catalog import search_catalog
|
||||
from app.ui.components.search_panel import render_search_panel
|
||||
|
||||
|
||||
@ui.page("/catalog")
|
||||
def catalog_page() -> None:
|
||||
with ui.column().classes("mx-auto w-full max-w-5xl gap-6"):
|
||||
ui.label("Catalog").classes("text-2xl font-semibold")
|
||||
render_search_panel(search_catalog)
|
||||
```
|
||||
|
||||
The page owns the route and composition. The component owns its controls, binding graph, feedback state, and structural refresh. The service owns search rules and data access. If two component handles must coordinate, keep the page wiring declarative, such as subscribing one component's public event to another component's public refresh action; move orchestration with domain meaning into a service.
|
||||
|
||||
### Component Lifetime
|
||||
|
||||
Create component state during each page build unless sharing is deliberate. A module-global component dataclass can leak UI state across clients, and a module-global `@ui.refreshable` function can refresh every recorded target. Do not retain returned handles beyond their owning client without an explicit cleanup and stale-client policy.
|
||||
|
||||
Bindings to elements are removed with NiceGUI's element lifecycle. Refreshing a region deletes and recreates the elements inside that region, so external code should retain the component handle rather than private child element references. Component-owned subscriptions, timers, and background tasks must follow the client deletion rules in [interaction mechanics](./interaction-patterns.md#page-and-client-lifetime).
|
||||
|
||||
## Optional Persistence
|
||||
|
||||
Use only when the product requires durable data.
|
||||
|
||||
```text
|
||||
src/app/db/
|
||||
├─ __init__.py
|
||||
├─ base.py
|
||||
├─ session.py
|
||||
├─ models/
|
||||
└─ repositories/
|
||||
```
|
||||
|
||||
- Create one engine and sessionmaker per process.
|
||||
- Provide request- or operation-scoped sessions with `yield`.
|
||||
- Keep transaction boundaries explicit in service or repository flows.
|
||||
- Never share sessions across concurrent tasks.
|
||||
- Use Alembic as the schema migration source of truth.
|
||||
|
||||
## Optional LangGraph AI
|
||||
|
||||
Use only for multi-step orchestration, resumable work, streaming, or human approval.
|
||||
|
||||
```text
|
||||
src/app/ai/
|
||||
├─ state.py
|
||||
├─ nodes/
|
||||
├─ graphs/
|
||||
├─ runtime.py
|
||||
└─ contracts.py
|
||||
```
|
||||
|
||||
- Keep graph internals outside API and UI modules.
|
||||
- Invoke graphs through a service such as `services/ai_service.py`.
|
||||
- Use stable thread or session IDs for resumable flows.
|
||||
- Keep interrupt payloads JSON-serializable.
|
||||
|
||||
## Optional Mounted Docs
|
||||
|
||||
Use only when generated docs must be served by the application.
|
||||
|
||||
Suggested settings:
|
||||
|
||||
- `docs_enabled`
|
||||
- `docs_mount_path`
|
||||
- `docs_site_dir`
|
||||
- `docs_require_build`
|
||||
|
||||
Mount docs in the composition layer, normalize the mount path, avoid route conflicts, and define behavior for missing build artifacts.
|
||||
|
||||
## Async And Responsiveness
|
||||
|
||||
- Use `async def` where a handler or service path performs I/O.
|
||||
- Prefer non-blocking clients and libraries.
|
||||
- Offload CPU-heavy work to worker or background execution.
|
||||
- Define progress, cancellation, timeout, completion, and error states for long actions.
|
||||
- Stream or chunk results when workflows are long-running or multi-step.
|
||||
|
||||
## Testing Minimums
|
||||
|
||||
- Test the FastAPI health route.
|
||||
- Test page registration wiring.
|
||||
- If persistence is enabled, test session lifecycle and rollback behavior.
|
||||
- If AI is enabled, test happy paths and interrupt/resume behavior.
|
||||
- If docs are enabled, test the mounted index route.
|
||||
- For long actions, test loading, completion, and error states.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user