api-service-contracts Skill
Generate API and service communication contracts with sequence diagram Published by microsoft in github-copilot-modernization.
What is api-service-contracts Skill?
Generate API and service communication contracts with sequence diagram Published by microsoft in github-copilot-modernization. This profile combines repository metadata with install, compatibility, and usage signals so developers can quickly decide whether it fits their agent workflow before opening the source repository.
Automated repository signals based on public metadata such as recency, license, installation evidence, and adoption. These are not a security audit or endorsement.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Database workflows
- Data analysis
- Writing
- Database workflows use cases
- Data analysis use cases
Technical details
- Install or run with Copy skill directory
When to use api-service-contracts Skill
- Use it for database workflows.
- Use it for data analysis.
- Use it for writing.
Built with
Editorial notes
Source
- Creator: microsoft
- Repository: microsoft/github-copilot-modernization
- Skill file: plugins/github-copilot-modernization/skills/api-service-contracts/SKILL.md
What it does
Generate API and service communication contracts with sequence diagram
Skill instructions
API & Service Communication Contracts Analyze the project to document all services, API endpoints, communication patterns (sync/async), DTOs, and retry/circuit-breaker policies. Generate a Mermaid sequence diagram showing the primary request flow across services. Save to .github/modernize/assessment/engines/facts/api-service-contracts.md. Input Parameters - workspace-path (optional): Path to the project to analyze (defaults to current directory) Scope Boundaries — Avoid Redundancy with Other Skills This skill is part of a set of four complementary assessment skills. To avoid content duplication across their output documents, observe these scope rules: - Introduction: Write a 1-2 sentence intro focused on the API surface (number of endpoints, communication style). Do NOT restate the application's technology stack, database options, or architecture type — those are covered by other skills. - Entity fields and persistence details are owned by the data-architecture skill. In the DTOs & Con
Explore related resources
Frequently asked questions
What is api-service-contracts?
api-service-contracts is a open-source AI agent skill with Copy skill directory. Generate API and service communication contracts with sequence diagram
Who is api-service-contracts best for?
api-service-contracts is best for reusing agent instructions, scripts, and references, database workflows, data analysis workflows, writing workflows.
How do I install api-service-contracts?
Install or run api-service-contracts using Copy skill directory. Check api-service-contracts for the latest setup command.
Is api-service-contracts actively maintained?
api-service-contracts may need a closer maintenance check before production use.
Auto-fetched from GitHub.
