instance-analyze

Analyze Canvas instance configuration and generate a markdown report.

2|1|Updated Nov 27, 2025
One-click install
npx skills add https://github.com/canvas-medical/coding-agents --skill instance-analyze
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: instance-analyze
Source: https://github.com/canvas-medical/coding-agents/tree/main/canvas-plugin-assistant/skills/instance-analyze
Command: npx skills add https://github.com/canvas-medical/coding-agents --skill instance-analyze

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about instance-analyze

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I analyze a Canvas instance configuration before plugin development?▼

To analyze a Canvas instance, run the browser-automation scraper with your instance name and root password to fetch configuration data, then generate a markdown report describing available teams, roles, questionnaires, and installed plugins.

What Canvas instance resources do I need to discover for plugin scoping?▼

Canvas instance discovery identifies configured teams, roles, questionnaires, note types, appointment types, and installed plugins, enabling you to map integration points and make informed plugin design decisions.

What credentials do I need to extract Canvas instance configuration?▼

Extracting Canvas instance configuration requires credentials stored in ~/.canvas/credentials.ini under the instance section, containing client_id, client_secret, and root_password to authenticate the scraper.

How do I generate a configuration report for a Canvas instance?▼

Generate a configuration report by running the scraper script, which outputs a structured markdown file named instance-config-<hostname>.md containing actionable development guidance and conflict checks for new plugins.

Can I tailor Canvas instance analysis findings to a specific plugin spec?▼

Yes, if a workspace plugin-spec exists at {workspace_dir}/.cpa-workflow-artifacts/plugin-spec.md, the analysis findings can be tailored to align with that specific plugin specification.

What is the best way to check for plugin conflicts across multiple Canvas instances?▼

The best way to check for plugin conflicts is to use the instance analyzer to discover installed plugins across multiple instances, producing a markdown report with conflict checks and actionable development guidance.