copilot-studio-agent-documenter

Generate Markdown documentation for Copilot Studio agents from Dataverse solutions.

842|287|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/pnp/copilot-prompts --skill copilot-studio-agent-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: copilot-studio-agent-documenter
Source: https://github.com/pnp/copilot-prompts/tree/main/samples/skills/copilot-studio-documenter
Command: npx skills add https://github.com/pnp/copilot-prompts --skill copilot-studio-agent-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

Automates comprehensive documentation generation for Copilot Studio agents from exported Dataverse solutions.

Core Features & Use Cases

  • Analyzes agent structure, topics, GPT instructions, connector actions, and Dataverse mappings to create detailed Markdown documentation with diagrams.
  • Produces a concise component inventory and diagrams for quick reference.
  • Outputs documentation to Docs/ folder for per-agent Markdown files, ready for publication.

Quick Start

Copy the SKILL.md into .github/skills/copilot-studio-documenter/ in your repository and trigger Copilot Studio to generate Docs/ for Agents.

Frequently Asked Questions about copilot-studio-agent-documenter

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

FAQPage Schema
How do I generate documentation for Copilot Studio agents from Dataverse solutions?

Generate Copilot Studio agent documentation by using a Skill that reads exported Dataverse Solution.xml and bot component files to produce Markdown docs with diagrams and inventories. It analyzes agent structure, topics, GPT instructions, and Dataverse mappings automatically.

What is included in Markdown documentation for Copilot Studio agents?

Markdown documentation for Copilot Studio agents includes agent structure analysis, topics, GPT instructions, connector actions, and Dataverse mappings. It also contains visual diagrams and a concise component inventory for quick reference.

Can I document Copilot Studio topics and GPT instructions automatically?

Yes, you can document Copilot Studio topics and GPT instructions automatically by applying this Skill to exported Dataverse solutions. It parses bot component data and configuration files to extract and document these elements in Markdown format.

How do I export Copilot Studio agent solutions to create documentation?

Export your Copilot Studio agent solution from Dataverse, then copy the Skill into your repository's .github/skills/ directory. Trigger Copilot Studio to analyze the exported Solution.xml and output per-agent Markdown files to the Docs/ folder.

Does this documentation tool work with Dataverse mappings and connector actions?

Yes, this documentation tool works with Dataverse mappings and connector actions by analyzing them from exported solution files. It reads bot component data and configuration files to map connectors and Dataverse relationships into structured Markdown documentation.

What are the limitations of auto-documenting Copilot Studio agents?

Auto-documenting Copilot Studio agents requires exported Dataverse solution files to function. It outputs Markdown files with diagrams and inventories, but depends on the completeness of the exported Solution.xml and bot component data provided.