Skip to content

docs: add plugin.json reference, cross-tool compatibility, and troubleshooting for agent plugins#9650

Merged
ntrogh merged 1 commit intomainfrom
users/digitarald/plugin-docs-improvements
Apr 15, 2026
Merged

docs: add plugin.json reference, cross-tool compatibility, and troubleshooting for agent plugins#9650
ntrogh merged 1 commit intomainfrom
users/digitarald/plugin-docs-improvements

Conversation

@digitarald
Copy link
Copy Markdown
Contributor

Addresses several documentation gaps surfaced by community feedback around authoring and troubleshooting agent plugins across VS Code, Copilot CLI, and Claude Code.

Changes

agent-plugins.md

  • Plugin metadata (plugin.json) — New section documenting the required name field (kebab-case, lowercase letters/numbers/hyphens only, max 64 chars), optional fields (version, description, author, component paths), and an example plugin.json. Links to the full CLI plugin reference.
  • Cross-tool compatibility — New section explaining that VS Code, Copilot CLI, and Claude Code share the plugin format, the plugin.json detection order, and key differences (hook file location, CLAUDE_PLUGIN_ROOT token, skill naming).
  • Troubleshooting — New section covering: plugin not appearing, skills not loading (namespace prefix gotcha), version not updating, and cache conflicts on install with platform-specific paths.

agent-skills.md

  • Tightened name field docs — Explicitly lists allowed characters and prohibits slashes, colons, dots, and namespace prefixes. Notes that invalid names cause silent load failures.
  • Namespace prefix warning — Added alert explaining that plugins auto-prefix skill commands (/my-plugin:test-runner), so manual namespace prefixes are unnecessary and will break loading.

@digitarald digitarald requested review from connor4312 and ntrogh April 15, 2026 01:25
@digitarald digitarald marked this pull request as ready for review April 15, 2026 01:27
Copy link
Copy Markdown
Collaborator

@ntrogh ntrogh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @digitarald

@ntrogh ntrogh merged commit cadcc94 into main Apr 15, 2026
4 checks passed
@ntrogh ntrogh deleted the users/digitarald/plugin-docs-improvements branch April 15, 2026 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants