instance-analyze

What problem does it solve?

Analyzing a Canvas instance before plugin development helps identify available teams, roles, questionnaires, note types, appointment types, and installed plugins, enabling informed design decisions and faster delivery.

Core Features & Use Cases

• Instance discovery: Identify configured Canvas instances and the resources they expose for plugin work.
• Configuration extraction: Gather roles, teams, questionnaires, note types, appointment types, and installed plugins, to map integration points.
• Reporting & recommendations: Produce a structured markdown report with actionable development guidance and conflict checks for new plugins.

Quick Start

1. Confirm the target Canvas instance you want to analyze, e.g., "plugin-testing".
2. Ensure credentials exist in ~/.canvas/credentials.ini under the [{instance}] section with client_id, client_secret, and root_password.
3. Run the scraper to fetch configuration: uv run python ${CLAUDE_PLUGIN_ROOT}/scripts/scrape_canvas_instance.py <instance_name> <root_password>
4. Review and save the report as instance-config-<hostname>.md in your working directory.
5. If you have a workspace plugin-spec at {workspace_dir}/.cpa-workflow-artifacts/plugin-spec.md, tailor findings to the spec.