Skip to content

VALIDATION.md

Latest commit

 

History

History
35 lines (23 loc) · 1.53 KB

VALIDATION.md

File metadata and controls

35 lines (23 loc) · 1.53 KB

Plugin structure validation

This plugin follows Cursor plugin building docs.

Checklist

  • .cursor-plugin/plugin.json with required fields: name, displayName, author, description, keywords, license, version
  • name is lowercase kebab-case: agentstack
  • skills/ directory with SKILL.md files (per skill); each skill may optionally include reference.md or examples.md (one level deep, see SKILLS_AUTHORING_GUIDE in main repo)
  • rules/ directory with .mdc rule files
  • MCP configuration reference (see mcp.json or README)
  • README.md, CHANGELOG.md, LICENSE at repo root

Automated validation

From the plugin root:

node scripts/validate-plugin.mjs

Checks: required files and dirs, plugin.json (kebab-case name, semver version), mcp.json (valid JSON, mcpServers.agentstack, placeholder API key), skills with SKILL.md and frontmatter, rules with .mdc files. Exit 0 = success.

Optional MCP endpoint smoke test (PowerShell):

.\scripts\test-mcp-endpoint.ps1
# Or with API key: .\scripts\test-mcp-endpoint.ps1 -ApiKey "your-key"

See VERIFICATION_CHECKLIST.md for full verification and testing steps.

Optional (template)

If using the official cursor/plugin-template, run node scripts/validate-template.mjs from the template repo. This repo is standalone and does not depend on the template.