From ac5267e54e56bb12a43ef5afdc74440d08464b48 Mon Sep 17 00:00:00 2001 From: Khelan Modi Date: Wed, 20 May 2026 19:35:35 +0100 Subject: [PATCH] docs: comment out unpublished plugin install paths The per-agent plugin/marketplace install commands (Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot CLI) reference registries the plugin has not yet been published to. Wrap them in HTML comments and add a note pointing users to the working skills-only one-liner (npx skills add Azure/documentdb-agent-kit) until each registry entry lands. - README.md: comment out per-agent install sections and per-agent rows in the Updating table; add a coming-soon callout. - AGENTS.md: trim the cross-tool compatibility table to the working skills-only row; move per-agent rows into a commented block. No manifest files are touched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- AGENTS.md | 7 ++++++- README.md | 14 +++++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 25deb74..f76c450 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -63,12 +63,17 @@ This kit is distributed as an installable plugin/extension for every major codin | Agent | Install command | Update command | Manifest | |---|---|---|---| +| Skills only (any agent) | `npx skills add Azure/documentdb-agent-kit` | re-run `npx skills add Azure/documentdb-agent-kit` (preferred) or `npx skills update` | walks `skills/` directly (no MCP server) | + +> ⚠️ Per-agent plugin install paths are not yet published — see the commented-out rows below for the planned commands. + + All paths share the same `skills/` tree. Claude / Cursor / Codex / Copilot also share the root [`mcp.json`](mcp.json); Gemini inlines the same MCP config in its own manifest. diff --git a/README.md b/README.md index c13df70..2f42685 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@ Skills follow the [Agent Skills](https://agentskills.io/) format and the kit shi The plugin bundles the [DocumentDB MCP server](https://github.com/microsoft/documentdb-mcp) (`documentdb-mcp-server` on npm — Node.js 20+) together with all skills under `skills/`. +> ⚠️ **Plugin install paths are not yet published.** The per-agent plugin/marketplace commands below are commented out until the plugin lands in each agent's registry. In the meantime, use the [skills-only one-liner](#universal-one-liner--skills-only-no-mcp-server) to install the skill catalog. + + ### Universal one-liner — skills only (no MCP server) @@ -60,6 +64,13 @@ This drops the rule docs into your agent's skill directory but **does not** inst New skills, rule fixes, and MCP-server updates are released on `main`. Installs do **not** auto-update — each install path has its own refresh command. Run these when you want to pull in new features or fixes: +| Install path | Update command | +|---|---| +| Skills only (skills.sh CLI) | re-run `npx skills add Azure/documentdb-agent-kit` | + + + > **Skills CLI note:** `npx skills update` exists but is unreliable for GitHub-sourced skills on the current `skills` CLI release. **Re-running `npx skills add Azure/documentdb-agent-kit` is the recommended refresh path** — it re-fetches the latest `main` and overlays the updated rule files. Add `--all` if you originally installed with `--all`.