api-service-contracts Skill
Generate API and service communication contracts with sequence diagram Published by microsoft in github-copilot-modernization.
Decision snapshot
Is this a fit?
Writing, Includes SKILL.md, Reusable instructions
Compatibility not yet detected.
Permission behavior not yet detected.
Copy skill directory
3 months ago · MIT license
No specific cautions were detected. Review the source and requested permissions before installing.
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. See how SkillIndex evaluates profiles.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Writing
- Writing use cases
Declared skill metadata
- Source file: plugins/github-copilot-modernization/skills/api-service-contracts/SKILL.md
These fields retain source and confidence evidence from the indexed SKILL.md.
Compatibility and setup
- Install or run with Copy skill directory
When to use api-service-contracts Skill
- 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) ⚠ Mermaid Safety Constraints — read BEFORE you write the mermaid block Mermaid sequenceDiagram is unforgiving in a few specific ways: one bad alias or one missing end crashes the whole diagram with Syntax error in text, not just the offending line. Stay strictly inside this subset for the sequence diagram in Step 7: 1. Chart kind. sequenceDiagram only. Never sequence-diagram, never sequence. 2. Participants. Always declare with the alias form participant <AlphaNumId as "Display Label". The id must match [A-Za-z][A-Za-z0-9]. Never omit the id —
Verified compatibility and discovery
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, 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.
Project health auto-fetched from the source repository.
Maintain this resource?
Review this source-backed profile, send a correction with evidence, or link to it from your documentation. Claims verify your relationship to the project; profile facts still require source evidence and editorial review.
