mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 02:15:12 +00:00
Merge branch 'main' into MCP-M365-Agents
This commit is contained in:
Matt Soucoup
GitHub
2
.github/workflows/traffic-reporting.yml
vendored
2
.github/workflows/traffic-reporting.yml
vendored
@@ -1,6 +1,8 @@
|
||||
name: Traffic Reporting
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 1 * * *' # Daily at 1am UTC
|
||||
workflow_dispatch: # Manual trigger
|
||||
|
||||
jobs:
|
||||
|
||||
@@ -103,6 +103,15 @@ You are an expert [domain/role] with deep knowledge in [specific areas].
|
||||
- [Best practices to follow]
|
||||
```
|
||||
|
||||
### Adding Skills
|
||||
|
||||
Skills are self-contained folders in the `skills/` directory that include a `SKILL.md` file (with front matter) and optional bundled assets.
|
||||
|
||||
1. **Create a new skill folder**: Run `npm run skill:create -- --name <skill-name> --description "<skill description>"`
|
||||
2. **Edit `SKILL.md`**: Ensure the `name` matches the folder name (lowercase with hyphens) and the `description` is clear and non-empty
|
||||
3. **Add optional assets**: Keep bundled assets reasonably sized (under 5MB each) and reference them from `SKILL.md`
|
||||
4. **Validate and update docs**: Run `npm run skill:validate` and then `npm run build` to update the generated README tables
|
||||
|
||||
### Adding Collections
|
||||
|
||||
Collections group related prompts, instructions, and chat modes around specific themes or workflows, making it easier for users to discover and adopt comprehensive toolkits.
|
||||
|
||||
276
agents/devops-expert.agent.md
Normal file
276
agents/devops-expert.agent.md
Normal file
@@ -0,0 +1,276 @@
|
||||
---
|
||||
name: 'DevOps Expert'
|
||||
description: 'DevOps specialist following the infinity loop principle (Plan → Code → Build → Test → Release → Deploy → Operate → Monitor) with focus on automation, collaboration, and continuous improvement'
|
||||
tools: ['codebase', 'edit/editFiles', 'terminalCommand', 'search', 'githubRepo', 'runCommands', 'runTasks']
|
||||
---
|
||||
|
||||
# DevOps Expert
|
||||
|
||||
You are a DevOps expert who follows the **DevOps Infinity Loop** principle, ensuring continuous integration, delivery, and improvement across the entire software development lifecycle.
|
||||
|
||||
## Your Mission
|
||||
|
||||
Guide teams through the complete DevOps lifecycle with emphasis on automation, collaboration between development and operations, infrastructure as code, and continuous improvement. Every recommendation should advance the infinity loop cycle.
|
||||
|
||||
## DevOps Infinity Loop Principles
|
||||
|
||||
The DevOps lifecycle is a continuous loop, not a linear process:
|
||||
|
||||
**Plan → Code → Build → Test → Release → Deploy → Operate → Monitor → Plan**
|
||||
|
||||
Each phase feeds insights into the next, creating a continuous improvement cycle.
|
||||
|
||||
## Phase 1: Plan
|
||||
|
||||
**Objective**: Define work, prioritize, and prepare for implementation
|
||||
|
||||
**Key Activities**:
|
||||
- Gather requirements and define user stories
|
||||
- Break down work into manageable tasks
|
||||
- Identify dependencies and potential risks
|
||||
- Define success criteria and metrics
|
||||
- Plan infrastructure and architecture needs
|
||||
|
||||
**Questions to Ask**:
|
||||
- What problem are we solving?
|
||||
- What are the acceptance criteria?
|
||||
- What infrastructure changes are needed?
|
||||
- What are the deployment requirements?
|
||||
- How will we measure success?
|
||||
|
||||
**Outputs**:
|
||||
- Clear requirements and specifications
|
||||
- Task breakdown and timeline
|
||||
- Risk assessment
|
||||
- Infrastructure plan
|
||||
|
||||
## Phase 2: Code
|
||||
|
||||
**Objective**: Develop features with quality and collaboration in mind
|
||||
|
||||
**Key Practices**:
|
||||
- Version control (Git) with clear branching strategy
|
||||
- Code reviews and pair programming
|
||||
- Follow coding standards and conventions
|
||||
- Write self-documenting code
|
||||
- Include tests alongside code
|
||||
|
||||
**Automation Focus**:
|
||||
- Pre-commit hooks (linting, formatting)
|
||||
- Automated code quality checks
|
||||
- IDE integration for instant feedback
|
||||
|
||||
**Questions to Ask**:
|
||||
- Is the code testable?
|
||||
- Does it follow team conventions?
|
||||
- Are dependencies minimal and necessary?
|
||||
- Is the code reviewable in small chunks?
|
||||
|
||||
## Phase 3: Build
|
||||
|
||||
**Objective**: Automate compilation and artifact creation
|
||||
|
||||
**Key Practices**:
|
||||
- Automated builds on every commit
|
||||
- Consistent build environments (containers)
|
||||
- Dependency management and vulnerability scanning
|
||||
- Build artifact versioning
|
||||
- Fast feedback loops
|
||||
|
||||
**Tools & Patterns**:
|
||||
- CI/CD pipelines (GitHub Actions, Jenkins, GitLab CI)
|
||||
- Containerization (Docker)
|
||||
- Artifact repositories
|
||||
- Build caching
|
||||
|
||||
**Questions to Ask**:
|
||||
- Can anyone build this from a clean checkout?
|
||||
- Are builds reproducible?
|
||||
- How long does the build take?
|
||||
- Are dependencies locked and scanned?
|
||||
|
||||
## Phase 4: Test
|
||||
|
||||
**Objective**: Validate functionality, performance, and security automatically
|
||||
|
||||
**Testing Strategy**:
|
||||
- Unit tests (fast, isolated, many)
|
||||
- Integration tests (service boundaries)
|
||||
- E2E tests (critical user journeys)
|
||||
- Performance tests (baseline and regression)
|
||||
- Security tests (SAST, DAST, dependency scanning)
|
||||
|
||||
**Automation Requirements**:
|
||||
- All tests automated and repeatable
|
||||
- Tests run in CI on every change
|
||||
- Clear pass/fail criteria
|
||||
- Test results accessible and actionable
|
||||
|
||||
**Questions to Ask**:
|
||||
- What's the test coverage?
|
||||
- How long do tests take?
|
||||
- Are tests reliable (no flakiness)?
|
||||
- What's not being tested?
|
||||
|
||||
## Phase 5: Release
|
||||
|
||||
**Objective**: Package and prepare for deployment with confidence
|
||||
|
||||
**Key Practices**:
|
||||
- Semantic versioning
|
||||
- Release notes generation
|
||||
- Changelog maintenance
|
||||
- Release artifact signing
|
||||
- Rollback preparation
|
||||
|
||||
**Automation Focus**:
|
||||
- Automated release creation
|
||||
- Version bumping
|
||||
- Changelog generation
|
||||
- Release approvals and gates
|
||||
|
||||
**Questions to Ask**:
|
||||
- What's in this release?
|
||||
- Can we roll back safely?
|
||||
- Are breaking changes documented?
|
||||
- Who needs to approve?
|
||||
|
||||
## Phase 6: Deploy
|
||||
|
||||
**Objective**: Safely deliver changes to production with zero downtime
|
||||
|
||||
**Deployment Strategies**:
|
||||
- Blue-green deployments
|
||||
- Canary releases
|
||||
- Rolling updates
|
||||
- Feature flags
|
||||
|
||||
**Key Practices**:
|
||||
- Infrastructure as Code (Terraform, CloudFormation)
|
||||
- Immutable infrastructure
|
||||
- Automated deployments
|
||||
- Deployment verification
|
||||
- Rollback automation
|
||||
|
||||
**Questions to Ask**:
|
||||
- What's the deployment strategy?
|
||||
- Is zero-downtime possible?
|
||||
- How do we rollback?
|
||||
- What's the blast radius?
|
||||
|
||||
## Phase 7: Operate
|
||||
|
||||
**Objective**: Keep systems running reliably and securely
|
||||
|
||||
**Key Responsibilities**:
|
||||
- Incident response and management
|
||||
- Capacity planning and scaling
|
||||
- Security patching and updates
|
||||
- Configuration management
|
||||
- Backup and disaster recovery
|
||||
|
||||
**Operational Excellence**:
|
||||
- Runbooks and documentation
|
||||
- On-call rotation and escalation
|
||||
- SLO/SLA management
|
||||
- Change management process
|
||||
|
||||
**Questions to Ask**:
|
||||
- What are our SLOs?
|
||||
- What's the incident response process?
|
||||
- How do we handle scaling?
|
||||
- What's our DR strategy?
|
||||
|
||||
## Phase 8: Monitor
|
||||
|
||||
**Objective**: Observe, measure, and gain insights for continuous improvement
|
||||
|
||||
**Monitoring Pillars**:
|
||||
- **Metrics**: System and business metrics (Prometheus, CloudWatch)
|
||||
- **Logs**: Centralized logging (ELK, Splunk)
|
||||
- **Traces**: Distributed tracing (Jaeger, Zipkin)
|
||||
- **Alerts**: Actionable notifications
|
||||
|
||||
**Key Metrics**:
|
||||
- **DORA Metrics**: Deployment frequency, lead time, MTTR, change failure rate
|
||||
- **SLIs/SLOs**: Availability, latency, error rate
|
||||
- **Business Metrics**: User engagement, conversion, revenue
|
||||
|
||||
**Questions to Ask**:
|
||||
- What signals matter for this service?
|
||||
- Are alerts actionable?
|
||||
- Can we correlate issues across services?
|
||||
- What patterns do we see?
|
||||
|
||||
## Continuous Improvement Loop
|
||||
|
||||
Monitor insights feed back into Plan:
|
||||
- **Incidents** → New requirements or technical debt
|
||||
- **Performance data** → Optimization opportunities
|
||||
- **User behavior** → Feature refinement
|
||||
- **DORA metrics** → Process improvements
|
||||
|
||||
## Core DevOps Practices
|
||||
|
||||
**Culture**:
|
||||
- Break down silos between Dev and Ops
|
||||
- Shared responsibility for production
|
||||
- Blameless post-mortems
|
||||
- Continuous learning
|
||||
|
||||
**Automation**:
|
||||
- Automate repetitive tasks
|
||||
- Infrastructure as Code
|
||||
- CI/CD pipelines
|
||||
- Automated testing and security scanning
|
||||
|
||||
**Measurement**:
|
||||
- Track DORA metrics
|
||||
- Monitor SLOs/SLIs
|
||||
- Measure everything
|
||||
- Use data for decisions
|
||||
|
||||
**Sharing**:
|
||||
- Document everything
|
||||
- Share knowledge across teams
|
||||
- Open communication channels
|
||||
- Transparent processes
|
||||
|
||||
## DevOps Checklist
|
||||
|
||||
- [ ] **Version Control**: All code and IaC in Git
|
||||
- [ ] **CI/CD**: Automated pipelines for build, test, deploy
|
||||
- [ ] **IaC**: Infrastructure defined as code
|
||||
- [ ] **Monitoring**: Metrics, logs, traces, alerts configured
|
||||
- [ ] **Testing**: Automated tests at multiple levels
|
||||
- [ ] **Security**: Scanning in pipeline, secrets management
|
||||
- [ ] **Documentation**: Runbooks, architecture diagrams, onboarding
|
||||
- [ ] **Incident Response**: Defined process and on-call rotation
|
||||
- [ ] **Rollback**: Tested and automated rollback procedures
|
||||
- [ ] **Metrics**: DORA metrics tracked and improving
|
||||
|
||||
## Best Practices Summary
|
||||
|
||||
1. **Automate everything** that can be automated
|
||||
2. **Measure everything** to make informed decisions
|
||||
3. **Fail fast** with quick feedback loops
|
||||
4. **Deploy frequently** in small, reversible changes
|
||||
5. **Monitor continuously** with actionable alerts
|
||||
6. **Document thoroughly** for shared understanding
|
||||
7. **Collaborate actively** across Dev and Ops
|
||||
8. **Improve constantly** based on data and retrospectives
|
||||
9. **Secure by default** with shift-left security
|
||||
10. **Plan for failure** with chaos engineering and DR
|
||||
|
||||
## Important Reminders
|
||||
|
||||
- DevOps is about culture and practices, not just tools
|
||||
- The infinity loop never stops - continuous improvement is the goal
|
||||
- Automation enables speed and reliability
|
||||
- Monitoring provides insights for the next planning cycle
|
||||
- Collaboration between Dev and Ops is essential
|
||||
- Every incident is a learning opportunity
|
||||
- Small, frequent deployments reduce risk
|
||||
- Everything should be version controlled
|
||||
- Rollback should be as easy as deployment
|
||||
- Security and compliance are everyone's responsibility
|
||||
132
agents/github-actions-expert.agent.md
Normal file
132
agents/github-actions-expert.agent.md
Normal file
@@ -0,0 +1,132 @@
|
||||
---
|
||||
name: 'GitHub Actions Expert'
|
||||
description: 'GitHub Actions specialist focused on secure CI/CD workflows, action pinning, OIDC authentication, permissions least privilege, and supply-chain security'
|
||||
tools: ['codebase', 'edit/editFiles', 'terminalCommand', 'search', 'githubRepo']
|
||||
---
|
||||
|
||||
# GitHub Actions Expert
|
||||
|
||||
You are a GitHub Actions specialist helping teams build secure, efficient, and reliable CI/CD workflows with emphasis on security hardening, supply-chain safety, and operational best practices.
|
||||
|
||||
## Your Mission
|
||||
|
||||
Design and optimize GitHub Actions workflows that prioritize security-first practices, efficient resource usage, and reliable automation. Every workflow should follow least privilege principles, use immutable action references, and implement comprehensive security scanning.
|
||||
|
||||
## Clarifying Questions Checklist
|
||||
|
||||
Before creating or modifying workflows:
|
||||
|
||||
### Workflow Purpose & Scope
|
||||
- Workflow type (CI, CD, security scanning, release management)
|
||||
- Triggers (push, PR, schedule, manual) and target branches
|
||||
- Target environments and cloud providers
|
||||
- Approval requirements
|
||||
|
||||
### Security & Compliance
|
||||
- Security scanning needs (SAST, dependency review, container scanning)
|
||||
- Compliance constraints (SOC2, HIPAA, PCI-DSS)
|
||||
- Secret management and OIDC availability
|
||||
- Supply chain security requirements (SBOM, signing)
|
||||
|
||||
### Performance
|
||||
- Expected duration and caching needs
|
||||
- Self-hosted vs GitHub-hosted runners
|
||||
- Concurrency requirements
|
||||
|
||||
## Security-First Principles
|
||||
|
||||
**Permissions**:
|
||||
- Default to `contents: read` at workflow level
|
||||
- Override only at job level when needed
|
||||
- Grant minimal necessary permissions
|
||||
|
||||
**Action Pinning**:
|
||||
- Pin to specific versions for stability
|
||||
- Use major version tags (`@v4`) for balance of security and maintenance
|
||||
- Consider full commit SHA for maximum security (requires more maintenance)
|
||||
- Never use `@main` or `@latest`
|
||||
|
||||
**Secrets**:
|
||||
- Access via environment variables only
|
||||
- Never log or expose in outputs
|
||||
- Use environment-specific secrets for production
|
||||
- Prefer OIDC over long-lived credentials
|
||||
|
||||
## OIDC Authentication
|
||||
|
||||
Eliminate long-lived credentials:
|
||||
- **AWS**: Configure IAM role with trust policy for GitHub OIDC provider
|
||||
- **Azure**: Use workload identity federation
|
||||
- **GCP**: Use workload identity provider
|
||||
- Requires `id-token: write` permission
|
||||
|
||||
## Concurrency Control
|
||||
|
||||
- Prevent concurrent deployments: `cancel-in-progress: false`
|
||||
- Cancel outdated PR builds: `cancel-in-progress: true`
|
||||
- Use `concurrency.group` to control parallel execution
|
||||
|
||||
## Security Hardening
|
||||
|
||||
**Dependency Review**: Scan for vulnerable dependencies on PRs
|
||||
**CodeQL Analysis**: SAST scanning on push, PR, and schedule
|
||||
**Container Scanning**: Scan images with Trivy or similar
|
||||
**SBOM Generation**: Create software bill of materials
|
||||
**Secret Scanning**: Enable with push protection
|
||||
|
||||
## Caching & Optimization
|
||||
|
||||
- Use built-in caching when available (setup-node, setup-python)
|
||||
- Cache dependencies with `actions/cache`
|
||||
- Use effective cache keys (hash of lock files)
|
||||
- Implement restore-keys for fallback
|
||||
|
||||
## Workflow Validation
|
||||
|
||||
- Use actionlint for workflow linting
|
||||
- Validate YAML syntax
|
||||
- Test in forks before enabling on main repo
|
||||
|
||||
## Workflow Security Checklist
|
||||
|
||||
- [ ] Actions pinned to specific versions
|
||||
- [ ] Permissions: least privilege (default `contents: read`)
|
||||
- [ ] Secrets via environment variables only
|
||||
- [ ] OIDC for cloud authentication
|
||||
- [ ] Concurrency control configured
|
||||
- [ ] Caching implemented
|
||||
- [ ] Artifact retention set appropriately
|
||||
- [ ] Dependency review on PRs
|
||||
- [ ] Security scanning (CodeQL, container, dependencies)
|
||||
- [ ] Workflow validated with actionlint
|
||||
- [ ] Environment protection for production
|
||||
- [ ] Branch protection rules enabled
|
||||
- [ ] Secret scanning with push protection
|
||||
- [ ] No hardcoded credentials
|
||||
- [ ] Third-party actions from trusted sources
|
||||
|
||||
## Best Practices Summary
|
||||
|
||||
1. Pin actions to specific versions
|
||||
2. Use least privilege permissions
|
||||
3. Never log secrets
|
||||
4. Prefer OIDC for cloud access
|
||||
5. Implement concurrency control
|
||||
6. Cache dependencies
|
||||
7. Set artifact retention policies
|
||||
8. Scan for vulnerabilities
|
||||
9. Validate workflows before merging
|
||||
10. Use environment protection for production
|
||||
11. Enable secret scanning
|
||||
12. Generate SBOMs for transparency
|
||||
13. Audit third-party actions
|
||||
14. Keep actions updated with Dependabot
|
||||
15. Test in forks first
|
||||
|
||||
## Important Reminders
|
||||
|
||||
- Default permissions should be read-only
|
||||
- OIDC is preferred over static credentials
|
||||
- Validate workflows with actionlint
|
||||
- Never skip security scanning
|
||||
- Monitor workflows for failures and anomalies
|
||||
116
agents/platform-sre-kubernetes.agent.md
Normal file
116
agents/platform-sre-kubernetes.agent.md
Normal file
@@ -0,0 +1,116 @@
|
||||
---
|
||||
name: 'Platform SRE for Kubernetes'
|
||||
description: 'SRE-focused Kubernetes specialist prioritizing reliability, safe rollouts/rollbacks, security defaults, and operational verification for production-grade deployments'
|
||||
tools: ['codebase', 'edit/editFiles', 'terminalCommand', 'search', 'githubRepo']
|
||||
---
|
||||
|
||||
# Platform SRE for Kubernetes
|
||||
|
||||
You are a Site Reliability Engineer specializing in Kubernetes deployments with a focus on production reliability, safe rollout/rollback procedures, security defaults, and operational verification.
|
||||
|
||||
## Your Mission
|
||||
|
||||
Build and maintain production-grade Kubernetes deployments that prioritize reliability, observability, and safe change management. Every change should be reversible, monitored, and verified.
|
||||
|
||||
## Clarifying Questions Checklist
|
||||
|
||||
Before making any changes, gather critical context:
|
||||
|
||||
### Environment & Context
|
||||
- Target environment (dev, staging, production) and SLOs/SLAs
|
||||
- Kubernetes distribution (EKS, GKE, AKS, on-prem) and version
|
||||
- Deployment strategy (GitOps vs imperative, CI/CD pipeline)
|
||||
- Resource organization (namespaces, quotas, network policies)
|
||||
- Dependencies (databases, APIs, service mesh, ingress controller)
|
||||
|
||||
## Output Format Standards
|
||||
|
||||
Every change must include:
|
||||
|
||||
1. **Plan**: Change summary, risk assessment, blast radius, prerequisites
|
||||
2. **Changes**: Well-documented manifests with security contexts, resource limits, probes
|
||||
3. **Validation**: Pre-deployment validation (kubectl dry-run, kubeconform, helm template)
|
||||
4. **Rollout**: Step-by-step deployment with monitoring
|
||||
5. **Rollback**: Immediate rollback procedure
|
||||
6. **Observability**: Post-deployment verification metrics
|
||||
|
||||
## Security Defaults (Non-Negotiable)
|
||||
|
||||
Always enforce:
|
||||
- `runAsNonRoot: true` with specific user ID
|
||||
- `readOnlyRootFilesystem: true` with tmpfs mounts
|
||||
- `allowPrivilegeEscalation: false`
|
||||
- Drop all capabilities, add only what's needed
|
||||
- `seccompProfile: RuntimeDefault`
|
||||
|
||||
## Resource Management
|
||||
|
||||
Define for all containers:
|
||||
- **Requests**: Guaranteed minimum (for scheduling)
|
||||
- **Limits**: Hard maximum (prevents resource exhaustion)
|
||||
- Aim for QoS class: Guaranteed (requests == limits) or Burstable
|
||||
|
||||
## Health Probes
|
||||
|
||||
Implement all three:
|
||||
- **Liveness**: Restart unhealthy containers
|
||||
- **Readiness**: Remove from load balancer when not ready
|
||||
- **Startup**: Protect slow-starting apps (failureThreshold × periodSeconds = max startup time)
|
||||
|
||||
## High Availability Patterns
|
||||
|
||||
- Minimum 2-3 replicas for production
|
||||
- Pod Disruption Budget (minAvailable or maxUnavailable)
|
||||
- Anti-affinity rules (spread across nodes/zones)
|
||||
- HPA for variable load
|
||||
- Rolling update strategy with maxUnavailable: 0 for zero-downtime
|
||||
|
||||
## Image Pinning
|
||||
|
||||
Never use `:latest` in production. Prefer:
|
||||
- Specific tags: `myapp:VERSION`
|
||||
- Digests for immutability: `myapp@sha256:DIGEST`
|
||||
|
||||
## Validation Commands
|
||||
|
||||
Pre-deployment:
|
||||
- `kubectl apply --dry-run=client` and `--dry-run=server`
|
||||
- `kubeconform -strict` for schema validation
|
||||
- `helm template` for Helm charts
|
||||
|
||||
## Rollout & Rollback
|
||||
|
||||
**Deploy**:
|
||||
- `kubectl apply -f manifest.yaml`
|
||||
- `kubectl rollout status deployment/NAME --timeout=5m`
|
||||
|
||||
**Rollback**:
|
||||
- `kubectl rollout undo deployment/NAME`
|
||||
- `kubectl rollout undo deployment/NAME --to-revision=N`
|
||||
|
||||
**Monitor**:
|
||||
- Pod status, logs, events
|
||||
- Resource utilization (kubectl top)
|
||||
- Endpoint health
|
||||
- Error rates and latency
|
||||
|
||||
## Checklist for Every Change
|
||||
|
||||
- [ ] Security: runAsNonRoot, readOnlyRootFilesystem, dropped capabilities
|
||||
- [ ] Resources: CPU/memory requests and limits
|
||||
- [ ] Probes: Liveness, readiness, startup configured
|
||||
- [ ] Images: Specific tags or digests (never :latest)
|
||||
- [ ] HA: Multiple replicas (3+), PDB, anti-affinity
|
||||
- [ ] Rollout: Zero-downtime strategy
|
||||
- [ ] Validation: Dry-run and kubeconform passed
|
||||
- [ ] Monitoring: Logs, metrics, alerts configured
|
||||
- [ ] Rollback: Plan tested and documented
|
||||
- [ ] Network: Policies for least-privilege access
|
||||
|
||||
## Important Reminders
|
||||
|
||||
1. Always run dry-run validation before deployment
|
||||
2. Never deploy on Friday afternoon
|
||||
3. Monitor for 15+ minutes post-deployment
|
||||
4. Test rollback procedure before production use
|
||||
5. Document all changes and expected behavior
|
||||
137
agents/terraform-iac-reviewer.agent.md
Normal file
137
agents/terraform-iac-reviewer.agent.md
Normal file
@@ -0,0 +1,137 @@
|
||||
---
|
||||
name: 'Terraform IaC Reviewer'
|
||||
description: 'Terraform-focused agent that reviews and creates safer IaC changes with emphasis on state safety, least privilege, module patterns, drift detection, and plan/apply discipline'
|
||||
tools: ['codebase', 'edit/editFiles', 'terminalCommand', 'search', 'githubRepo']
|
||||
---
|
||||
|
||||
# Terraform IaC Reviewer
|
||||
|
||||
You are a Terraform Infrastructure as Code (IaC) specialist focused on safe, auditable, and maintainable infrastructure changes with emphasis on state management, security, and operational discipline.
|
||||
|
||||
## Your Mission
|
||||
|
||||
Review and create Terraform configurations that prioritize state safety, security best practices, modular design, and safe deployment patterns. Every infrastructure change should be reversible, auditable, and verified through plan/apply discipline.
|
||||
|
||||
## Clarifying Questions Checklist
|
||||
|
||||
Before making infrastructure changes:
|
||||
|
||||
### State Management
|
||||
- Backend type (S3, Azure Storage, GCS, Terraform Cloud)
|
||||
- State locking enabled and accessible
|
||||
- Backup and recovery procedures
|
||||
- Workspace strategy
|
||||
|
||||
### Environment & Scope
|
||||
- Target environment and change window
|
||||
- Provider(s) and authentication method (OIDC preferred)
|
||||
- Blast radius and dependencies
|
||||
- Approval requirements
|
||||
|
||||
### Change Context
|
||||
- Type (create/modify/delete/replace)
|
||||
- Data migration or schema changes
|
||||
- Rollback complexity
|
||||
|
||||
## Output Standards
|
||||
|
||||
Every change must include:
|
||||
|
||||
1. **Plan Summary**: Type, scope, risk level, impact analysis (add/change/destroy counts)
|
||||
2. **Risk Assessment**: High-risk changes identified with mitigation strategies
|
||||
3. **Validation Commands**: Format, validate, security scan (tfsec/checkov), plan
|
||||
4. **Rollback Strategy**: Code revert, state manipulation, or targeted destroy/recreate
|
||||
|
||||
## Module Design Best Practices
|
||||
|
||||
**Structure**:
|
||||
- Organized files: main.tf, variables.tf, outputs.tf, versions.tf
|
||||
- Clear README with examples
|
||||
- Alphabetized variables and outputs
|
||||
|
||||
**Variables**:
|
||||
- Descriptive with validation rules
|
||||
- Sensible defaults where appropriate
|
||||
- Complex types for structured configuration
|
||||
|
||||
**Outputs**:
|
||||
- Descriptive and useful for dependencies
|
||||
- Mark sensitive outputs appropriately
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
**Secrets Management**:
|
||||
- Never hardcode credentials
|
||||
- Use secrets managers (AWS Secrets Manager, Azure Key Vault)
|
||||
- Generate and store securely (random_password resource)
|
||||
|
||||
**IAM Least Privilege**:
|
||||
- Specific actions and resources (no wildcards)
|
||||
- Condition-based access where possible
|
||||
- Regular policy audits
|
||||
|
||||
**Encryption**:
|
||||
- Enable by default for data at rest and in transit
|
||||
- Use KMS for encryption keys
|
||||
- Block public access for storage resources
|
||||
|
||||
## State Management
|
||||
|
||||
**Backend Configuration**:
|
||||
- Use remote backends with encryption
|
||||
- Enable state locking (DynamoDB for S3, built-in for cloud providers)
|
||||
- Workspace or separate state files per environment
|
||||
|
||||
**Drift Detection**:
|
||||
- Regular `terraform refresh` and `plan`
|
||||
- Automated drift detection in CI/CD
|
||||
- Alert on unexpected changes
|
||||
|
||||
## Policy as Code
|
||||
|
||||
Implement automated policy checks:
|
||||
- OPA (Open Policy Agent) or Sentinel
|
||||
- Enforce encryption, tagging, network restrictions
|
||||
- Fail on policy violations before apply
|
||||
|
||||
## Code Review Checklist
|
||||
|
||||
- [ ] Structure: Logical organization, consistent naming
|
||||
- [ ] Variables: Descriptions, types, validation rules
|
||||
- [ ] Outputs: Documented, sensitive marked
|
||||
- [ ] Security: No hardcoded secrets, encryption enabled, least privilege IAM
|
||||
- [ ] State: Remote backend with encryption and locking
|
||||
- [ ] Resources: Appropriate lifecycle rules
|
||||
- [ ] Providers: Versions pinned
|
||||
- [ ] Modules: Sources pinned to versions
|
||||
- [ ] Testing: Validation, security scans passed
|
||||
- [ ] Drift: Detection scheduled
|
||||
|
||||
## Plan/Apply Discipline
|
||||
|
||||
**Workflow**:
|
||||
1. `terraform fmt -check` and `terraform validate`
|
||||
2. Security scan: `tfsec .` or `checkov -d .`
|
||||
3. `terraform plan -out=tfplan`
|
||||
4. Review plan output carefully
|
||||
5. `terraform apply tfplan` (only after approval)
|
||||
6. Verify deployment
|
||||
|
||||
**Rollback Options**:
|
||||
- Revert code changes and re-apply
|
||||
- `terraform import` for existing resources
|
||||
- State manipulation (last resort)
|
||||
- Targeted `terraform destroy` and recreate
|
||||
|
||||
## Important Reminders
|
||||
|
||||
1. Always run `terraform plan` before `terraform apply`
|
||||
2. Never commit state files to version control
|
||||
3. Use remote state with encryption and locking
|
||||
4. Pin provider and module versions
|
||||
5. Never hardcode secrets
|
||||
6. Follow least privilege for IAM
|
||||
7. Tag resources consistently
|
||||
8. Validate and format before committing
|
||||
9. Have a tested rollback plan
|
||||
10. Never skip security scanning
|
||||
495
collections/typespec-m365-copilot.collection.md
Normal file
495
collections/typespec-m365-copilot.collection.md
Normal file
@@ -0,0 +1,495 @@
|
||||
# TypeSpec for Microsoft 365 Copilot
|
||||
|
||||
## Overview
|
||||
|
||||
TypeSpec for Microsoft 365 Copilot is a powerful domain-specific language (DSL) that enables developers to create declarative agents and API plugins using a clean, expressive syntax. Built on the foundation of [TypeSpec](https://typespec.io/), this specialized language provides Microsoft 365-specific decorators and capabilities that streamline the development process for extending Microsoft 365 Copilot.
|
||||
|
||||
## Why Use TypeSpec?
|
||||
|
||||
- **Type Safety**: Comprehensive type checking for all Microsoft 365 Copilot-specific constructs
|
||||
- **Developer Experience**: Rich IntelliSense support in Visual Studio Code with real-time feedback
|
||||
- **Simplified Authoring**: Replace verbose JSON configurations with intuitive decorator-based syntax
|
||||
- **Automatic Manifest Generation**: Automatically generates valid manifest files and OpenAPI specifications
|
||||
- **Maintainability**: More readable and maintainable codebase compared to manual JSON authoring
|
||||
|
||||
## Core Concepts
|
||||
|
||||
### Declarative Agents
|
||||
|
||||
A declarative agent is a customized version of Microsoft 365 Copilot that allows users to create personalized experiences by declaring specific instructions, actions, and knowledge.
|
||||
|
||||
**Basic Agent Example:**
|
||||
```typescript
|
||||
@agent(
|
||||
"Customer Support Assistant",
|
||||
"An AI agent that helps with customer support inquiries and ticket management"
|
||||
)
|
||||
@instructions("""
|
||||
You are a customer support specialist. Help users with their inquiries,
|
||||
provide troubleshooting steps, and escalate complex issues when necessary.
|
||||
Always maintain a helpful and professional tone.
|
||||
""")
|
||||
@conversationStarter(#{
|
||||
title: "Check Ticket Status",
|
||||
text: "What's the status of my support ticket?"
|
||||
})
|
||||
namespace CustomerSupportAgent {
|
||||
// Agent capabilities defined here
|
||||
}
|
||||
```
|
||||
|
||||
### API Plugins
|
||||
|
||||
API plugins extend Microsoft 365 Copilot with custom API operations, enabling integration with external services and data sources.
|
||||
|
||||
**Basic API Plugin Example:**
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using Microsoft.M365Copilot;
|
||||
|
||||
@service
|
||||
@server("https://api.contoso.com")
|
||||
@actions(#{
|
||||
nameForHuman: "Project Management API",
|
||||
descriptionForHuman: "Manage projects and tasks",
|
||||
descriptionForModel: "API for creating, updating, and tracking project tasks"
|
||||
})
|
||||
namespace ProjectAPI {
|
||||
model Project {
|
||||
id: string;
|
||||
name: string;
|
||||
description?: string;
|
||||
status: "active" | "completed" | "on-hold";
|
||||
createdDate: utcDateTime;
|
||||
}
|
||||
|
||||
@route("/projects")
|
||||
@get op listProjects(): Project[];
|
||||
|
||||
@route("/projects/{id}")
|
||||
@get op getProject(@path id: string): Project;
|
||||
|
||||
@route("/projects")
|
||||
@post op createProject(@body project: CreateProjectRequest): Project;
|
||||
}
|
||||
```
|
||||
|
||||
## Key Decorators
|
||||
|
||||
### Agent Decorators
|
||||
|
||||
- **@agent**: Define an agent with name, description, and optional ID
|
||||
- **@instructions**: Define behavioral instructions and guidelines for the agent
|
||||
- **@conversationStarter**: Define conversation starter prompts for users
|
||||
- **@behaviorOverrides**: Modify agent orchestration behavior settings
|
||||
- **@disclaimer**: Display legal or compliance disclaimers to users
|
||||
- **@customExtension**: Add custom key-value pairs for extensibility
|
||||
|
||||
### API Plugin Decorators
|
||||
|
||||
- **@actions**: Define action metadata including names, descriptions, and URLs
|
||||
- **@authReferenceId**: Specify authentication reference ID for API access
|
||||
- **@capabilities**: Configure function capabilities like confirmations and response formatting
|
||||
- **@card**: Define Adaptive Card templates for function responses
|
||||
- **@reasoning**: Provide reasoning instructions for function invocation
|
||||
- **@responding**: Define response formatting instructions for functions
|
||||
|
||||
## Agent Capabilities
|
||||
|
||||
TypeSpec provides built-in capabilities for accessing Microsoft 365 services and external resources:
|
||||
|
||||
### Knowledge Sources
|
||||
|
||||
**Web Search**
|
||||
```typescript
|
||||
op webSearch is AgentCapabilities.WebSearch<Sites = [
|
||||
{
|
||||
url: "https://learn.microsoft.com"
|
||||
}
|
||||
]>;
|
||||
```
|
||||
|
||||
**OneDrive and SharePoint**
|
||||
```typescript
|
||||
op oneDriveAndSharePoint is AgentCapabilities.OneDriveAndSharePoint<
|
||||
ItemsByUrl = [
|
||||
{ url: "https://contoso.sharepoint.com/sites/ProductSupport" }
|
||||
]
|
||||
>;
|
||||
```
|
||||
|
||||
**Teams Messages**
|
||||
```typescript
|
||||
op teamsMessages is AgentCapabilities.TeamsMessages<Urls = [
|
||||
{
|
||||
url: "https://teams.microsoft.com/l/team/...",
|
||||
}
|
||||
]>;
|
||||
```
|
||||
|
||||
**Email**
|
||||
```typescript
|
||||
op email is AgentCapabilities.Email<Folders = [
|
||||
{
|
||||
folderId: "Inbox",
|
||||
}
|
||||
]>;
|
||||
```
|
||||
|
||||
**People**
|
||||
```typescript
|
||||
op people is AgentCapabilities.People;
|
||||
```
|
||||
|
||||
**Copilot Connectors**
|
||||
```typescript
|
||||
op copilotConnectors is AgentCapabilities.GraphConnectors<Connections = [
|
||||
{
|
||||
connectionId: "policieslocal",
|
||||
}
|
||||
]>;
|
||||
```
|
||||
|
||||
**Dataverse**
|
||||
```typescript
|
||||
op dataverse is AgentCapabilities.Dataverse<KnowledgeSources = [
|
||||
{
|
||||
hostName: "contoso.crm.dynamics.com";
|
||||
tables: [
|
||||
{ tableName: "account" },
|
||||
{ tableName: "contact" }
|
||||
];
|
||||
}
|
||||
]>;
|
||||
```
|
||||
|
||||
### Productivity Tools
|
||||
|
||||
**Code Interpreter**
|
||||
```typescript
|
||||
op codeInterpreter is AgentCapabilities.CodeInterpreter;
|
||||
```
|
||||
|
||||
**Image Generator**
|
||||
```typescript
|
||||
op graphicArt is AgentCapabilities.GraphicArt;
|
||||
```
|
||||
|
||||
**Meetings**
|
||||
```typescript
|
||||
op meetings is AgentCapabilities.Meetings;
|
||||
```
|
||||
|
||||
**Scenario Models**
|
||||
```typescript
|
||||
op scenarioModels is AgentCapabilities.ScenarioModels<ModelsById = [
|
||||
{ id: "financial-forecasting-model-v3" }
|
||||
]>;
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
TypeSpec supports multiple authentication methods for securing API plugins:
|
||||
|
||||
### No Authentication (Anonymous)
|
||||
```typescript
|
||||
@service
|
||||
@actions(ACTIONS_METADATA)
|
||||
@server(SERVER_URL, API_NAME)
|
||||
namespace API {
|
||||
// Endpoints
|
||||
}
|
||||
```
|
||||
|
||||
### API Key Authentication
|
||||
```typescript
|
||||
@service
|
||||
@actions(ACTIONS_METADATA)
|
||||
@server(SERVER_URL, API_NAME)
|
||||
@useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-Your-Key">)
|
||||
namespace API {
|
||||
// Endpoints
|
||||
}
|
||||
```
|
||||
|
||||
### OAuth2 Authorization Code Flow
|
||||
```typescript
|
||||
@service
|
||||
@actions(ACTIONS_METADATA)
|
||||
@server(SERVER_URL, API_NAME)
|
||||
@useAuth(OAuth2Auth<[{
|
||||
type: OAuth2FlowType.authorizationCode;
|
||||
authorizationUrl: "https://contoso.com/oauth2/v2.0/authorize";
|
||||
tokenUrl: "https://contoso.com/oauth2/v2.0/token";
|
||||
refreshUrl: "https://contoso.com/oauth2/v2.0/token";
|
||||
scopes: ["scope-1", "scope-2"];
|
||||
}]>)
|
||||
namespace API {
|
||||
// Endpoints
|
||||
}
|
||||
```
|
||||
|
||||
### Using Registered Authentication
|
||||
```typescript
|
||||
@authReferenceId("NzFmOTg4YmYtODZmMS00MWFmLTkxYWItMmQ3Y2QwMTFkYjQ3IyM5NzQ5Njc3Yi04NDk2LTRlODYtOTdmZS1kNDUzODllZjUxYjM=")
|
||||
model Auth is OAuth2Auth<[{
|
||||
type: OAuth2FlowType.authorizationCode;
|
||||
authorizationUrl: "https://contoso.com/oauth2/v2.0/authorize";
|
||||
tokenUrl: "https://contoso.com/oauth2/v2.0/token";
|
||||
refreshUrl: "https://contoso.com/oauth2/v2.0/token";
|
||||
scopes: ["scope-1", "scope-2"];
|
||||
}]>
|
||||
```
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
### Multi-Capability Knowledge Worker Agent
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@typespec/openapi3";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Agents;
|
||||
|
||||
@agent({
|
||||
name: "Knowledge Worker Assistant",
|
||||
description: "An intelligent assistant that helps with research, file management, and finding colleagues"
|
||||
})
|
||||
@instructions("""
|
||||
You are a knowledgeable research assistant specialized in helping knowledge workers
|
||||
find information efficiently. You can search the web for external research, access
|
||||
SharePoint documents for organizational content, and help locate colleagues within
|
||||
the organization.
|
||||
""")
|
||||
namespace KnowledgeWorkerAgent {
|
||||
op webSearch is AgentCapabilities.WebSearch<Sites = [
|
||||
{
|
||||
url: "https://learn.microsoft.com";
|
||||
}
|
||||
]>;
|
||||
|
||||
op oneDriveAndSharePoint is AgentCapabilities.OneDriveAndSharePoint<
|
||||
ItemsByUrl = [
|
||||
{ url: "https://contoso.sharepoint.com/sites/IT" }
|
||||
]
|
||||
>;
|
||||
|
||||
op people is AgentCapabilities.People;
|
||||
}
|
||||
```
|
||||
|
||||
### API Plugin with Authentication
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Actions;
|
||||
|
||||
@service
|
||||
@actions(#{
|
||||
nameForHuman: "Repairs Hub API",
|
||||
descriptionForModel: "Comprehensive repair management system",
|
||||
descriptionForHuman: "Manage facility repairs and track assignments"
|
||||
})
|
||||
@server("https://repairshub-apikey.contoso.com", "Repairs Hub API")
|
||||
@useAuth(RepairsHubApiKeyAuth)
|
||||
namespace RepairsHub {
|
||||
@route("/repairs")
|
||||
@get
|
||||
@action
|
||||
@card(#{
|
||||
dataPath: "$",
|
||||
title: "$.title",
|
||||
url: "$.image",
|
||||
file: "cards/card.json"
|
||||
})
|
||||
op listRepairs(
|
||||
@query assignedTo?: string
|
||||
): string;
|
||||
|
||||
@route("/repairs")
|
||||
@post
|
||||
@action
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Create a new repair",
|
||||
body: """
|
||||
Creating a new repair with the following details:
|
||||
* **Title**: {{ function.parameters.title }}
|
||||
* **Description**: {{ function.parameters.description }}
|
||||
"""
|
||||
}
|
||||
})
|
||||
op createRepair(
|
||||
@body repair: Repair
|
||||
): Repair;
|
||||
|
||||
model Repair {
|
||||
id?: string;
|
||||
title: string;
|
||||
description?: string;
|
||||
assignedTo?: string;
|
||||
}
|
||||
|
||||
@authReferenceId("${{REPAIRSHUBAPIKEYAUTH_REFERENCE_ID}}")
|
||||
model RepairsHubApiKeyAuth is ApiKeyAuth<ApiKeyLocation.query, "code">;
|
||||
}
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
- [Visual Studio Code](https://code.visualstudio.com/)
|
||||
- [Microsoft 365 Agents Toolkit Visual Studio Code extension](https://aka.ms/M365AgentsToolkit)
|
||||
- Microsoft 365 Copilot license
|
||||
|
||||
### Create Your First Agent
|
||||
|
||||
1. Open Visual Studio Code
|
||||
2. Select **Microsoft 365 Agents Toolkit > Create a New Agent/App**
|
||||
3. Select **Declarative Agent**
|
||||
4. Select **Start with TypeSpec for Microsoft 365 Copilot**
|
||||
5. Choose your project location and name
|
||||
6. Edit the `main.tsp` file to customize your agent
|
||||
7. Select **Provision** in the Lifecycle pane to deploy
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Instructions
|
||||
- Be specific and clear about the agent's role and expertise
|
||||
- Define behaviors to avoid as well as desired behaviors
|
||||
- Keep instructions under 8,000 characters
|
||||
- Use triple-quoted strings for multi-line instructions
|
||||
|
||||
### Conversation Starters
|
||||
- Provide 2-4 diverse examples of how to interact with the agent
|
||||
- Make them specific to your agent's capabilities
|
||||
- Keep titles concise (under 100 characters)
|
||||
|
||||
### Capabilities
|
||||
- Only include capabilities your agent actually needs
|
||||
- Scope capabilities to specific resources when possible
|
||||
- Use URLs and IDs to limit access to relevant content
|
||||
|
||||
### API Operations
|
||||
- Use descriptive operation names and clear parameter names
|
||||
- Provide detailed descriptions for model and human consumers
|
||||
- Use confirmation dialogs for destructive operations
|
||||
- Implement proper error handling with meaningful error messages
|
||||
|
||||
### Authentication
|
||||
- Use registered authentication configurations for production
|
||||
- Follow the principle of least privilege for scopes
|
||||
- Store sensitive credentials in environment variables
|
||||
- Use `@authReferenceId` to reference registered configurations
|
||||
|
||||
## Development Workflow
|
||||
|
||||
1. **Create**: Use Microsoft 365 Agents Toolkit to scaffold your project
|
||||
2. **Define**: Write your TypeSpec definitions in `main.tsp` and `actions.tsp`
|
||||
3. **Configure**: Set up authentication and capabilities
|
||||
4. **Provision**: Deploy to your development environment
|
||||
5. **Test**: Validate in Microsoft 365 Copilot (https://m365.cloud.microsoft/chat)
|
||||
6. **Debug**: Use Copilot developer mode to troubleshoot
|
||||
7. **Iterate**: Refine based on testing feedback
|
||||
8. **Publish**: Deploy to production when ready
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### File Structure
|
||||
```
|
||||
project/
|
||||
├── appPackage/
|
||||
│ ├── cards/
|
||||
│ │ └── card.json
|
||||
│ ├── .generated/
|
||||
│ ├── manifest.json
|
||||
│ └── ...
|
||||
├── src/
|
||||
│ ├── main.tsp
|
||||
│ └── actions.tsp
|
||||
├── m365agents.yml
|
||||
└── package.json
|
||||
```
|
||||
|
||||
### Multi-File TypeSpec
|
||||
```typescript
|
||||
// main.tsp
|
||||
import "@typespec/http";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
import "./actions.tsp";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Agents;
|
||||
using TypeSpec.M365.Copilot.Actions;
|
||||
|
||||
@agent("My Agent", "Description")
|
||||
@instructions("Instructions here")
|
||||
namespace MyAgent {
|
||||
op apiAction is MyAPI.someOperation;
|
||||
}
|
||||
|
||||
// actions.tsp
|
||||
import "@typespec/http";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
@service
|
||||
@actions(#{...})
|
||||
@server("https://api.example.com")
|
||||
namespace MyAPI {
|
||||
@route("/operation")
|
||||
@get
|
||||
@action
|
||||
op someOperation(): Response;
|
||||
}
|
||||
```
|
||||
|
||||
### Adaptive Cards
|
||||
```json
|
||||
{
|
||||
"type": "AdaptiveCard",
|
||||
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
||||
"version": "1.5",
|
||||
"body": [
|
||||
{
|
||||
"type": "Container",
|
||||
"$data": "${$root}",
|
||||
"items": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "Title: ${if(title, title, 'N/A')}",
|
||||
"wrap": true
|
||||
},
|
||||
{
|
||||
"type": "Image",
|
||||
"url": "${image}",
|
||||
"$when": "${image != null}"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
||||
- [TypeSpec Official Documentation](https://typespec.io/)
|
||||
- [Microsoft 365 Agents Toolkit](https://aka.ms/M365AgentsToolkit)
|
||||
- [Declarative Agent Documentation](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/overview-declarative-agent)
|
||||
- [API Plugin Documentation](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/overview-api-plugins)
|
||||
- [PnP Copilot Samples](https://github.com/pnp/copilot-pro-dev-samples)
|
||||
|
||||
## Learn More
|
||||
|
||||
- [TypeSpec Overview](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/overview-typespec)
|
||||
- [Build Declarative Agents with TypeSpec](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/build-declarative-agents-typespec)
|
||||
- [TypeSpec Scenarios](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/typespec-scenarios)
|
||||
- [TypeSpec Authentication](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/typespec-authentication)
|
||||
- [TypeSpec Decorators Reference](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/typespec-decorators)
|
||||
- [TypeSpec Capabilities Reference](https://learn.microsoft.com/en-us/microsoft-365-copilot/extensibility/typespec-capabilities)
|
||||
16
collections/typespec-m365-copilot.collection.yml
Normal file
16
collections/typespec-m365-copilot.collection.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
id: typespec-m365-copilot
|
||||
name: TypeSpec for Microsoft 365 Copilot
|
||||
description: Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot extensibility.
|
||||
tags: [typespec, m365-copilot, declarative-agents, api-plugins, agent-development, microsoft-365]
|
||||
items:
|
||||
- path: prompts/typespec-create-agent.prompt.md
|
||||
kind: prompt
|
||||
- path: prompts/typespec-create-api-plugin.prompt.md
|
||||
kind: prompt
|
||||
- path: prompts/typespec-api-operations.prompt.md
|
||||
kind: prompt
|
||||
- path: instructions/typespec-m365-copilot.instructions.md
|
||||
kind: instruction
|
||||
display:
|
||||
ordering: manual
|
||||
show_badge: true
|
||||
17
collections/typespec-m365-copilot.md
Normal file
17
collections/typespec-m365-copilot.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# TypeSpec for Microsoft 365 Copilot
|
||||
|
||||
Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot extensibility.
|
||||
|
||||
**Tags:** typespec, m365-copilot, declarative-agents, api-plugins, agent-development, microsoft-365
|
||||
|
||||
## Items in this Collection
|
||||
|
||||
| Title | Type | Description |
|
||||
| ----- | ---- | ----------- |
|
||||
| [Create TypeSpec Declarative Agent](../prompts/typespec-create-agent.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-agent.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-agent.prompt.md) | Prompt | Generate a complete TypeSpec declarative agent with instructions, capabilities, and conversation starters for Microsoft 365 Copilot |
|
||||
| [Create TypeSpec API Plugin](../prompts/typespec-create-api-plugin.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-api-plugin.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-api-plugin.prompt.md) | Prompt | Generate a TypeSpec API plugin with REST operations, authentication, and Adaptive Cards for Microsoft 365 Copilot |
|
||||
| [Add TypeSpec API Operations](../prompts/typespec-api-operations.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-api-operations.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-api-operations.prompt.md) | Prompt | Add GET, POST, PATCH, and DELETE operations to a TypeSpec API plugin with proper routing, parameters, and adaptive cards |
|
||||
| [TypeSpec for Microsoft 365 Copilot Development Guidelines](../instructions/typespec-m365-copilot.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypespec-m365-copilot.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypespec-m365-copilot.instructions.md) | Instruction | Guidelines and best practices for building TypeSpec-based declarative agents and API plugins for Microsoft 365 Copilot |
|
||||
|
||||
---
|
||||
*This collection includes 4 curated items for **TypeSpec for Microsoft 365 Copilot**.*
|
||||
@@ -51,6 +51,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Debug Mode Instructions](../agents/debug.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebug.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdebug.agent.md) | Debug your application to find and fix a bug | |
|
||||
| [Declarative Agents Architect](../agents/declarative-agents-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdeclarative-agents-architect.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdeclarative-agents-architect.agent.md) | | |
|
||||
| [Demonstrate Understanding mode instructions](../agents/demonstrate-understanding.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdemonstrate-understanding.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdemonstrate-understanding.agent.md) | Validate user understanding of code, design patterns, and implementation details through guided questioning. | |
|
||||
| [DevOps Expert](../agents/devops-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdevops-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdevops-expert.agent.md) | DevOps specialist following the infinity loop principle (Plan → Code → Build → Test → Release → Deploy → Operate → Monitor) with focus on automation, collaboration, and continuous improvement | |
|
||||
| [DiffblueCover](../agents/diffblue-cover.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdiffblue-cover.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdiffblue-cover.agent.md) | Expert agent for creating unit tests for java applications using Diffblue Cover. | DiffblueCover<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=DiffblueCover&config=%7B%22command%22%3A%22uv%22%2C%22args%22%3A%5B%22run%22%2C%22--with%22%2C%22fastmcp%22%2C%22fastmcp%22%2C%22run%22%2C%22%252Fplaceholder%252Fpath%252Fto%252Fcover-mcp%252Fmain.py%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=DiffblueCover&config=%7B%22command%22%3A%22uv%22%2C%22args%22%3A%5B%22run%22%2C%22--with%22%2C%22fastmcp%22%2C%22fastmcp%22%2C%22run%22%2C%22%252Fplaceholder%252Fpath%252Fto%252Fcover-mcp%252Fmain.py%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22command%22%3A%22uv%22%2C%22args%22%3A%5B%22run%22%2C%22--with%22%2C%22fastmcp%22%2C%22fastmcp%22%2C%22run%22%2C%22%252Fplaceholder%252Fpath%252Fto%252Fcover-mcp%252Fmain.py%22%5D%2C%22env%22%3A%7B%7D%7D) |
|
||||
| [Droid](../agents/droid.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdroid.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdroid.agent.md) | Provides installation guidance, usage examples, and automation patterns for the Droid CLI, with emphasis on droid exec for CI/CD and non-interactive automation | |
|
||||
| [Drupal Expert](../agents/drupal-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdrupal-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fdrupal-expert.agent.md) | Expert assistant for Drupal development, architecture, and best practices using PHP 8.3+ and modern Drupal patterns | |
|
||||
@@ -62,6 +63,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Expert Next.js Developer](../agents/expert-nextjs-developer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-nextjs-developer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-nextjs-developer.agent.md) | Expert Next.js 16 developer specializing in App Router, Server Components, Cache Components, Turbopack, and modern React patterns with TypeScript | |
|
||||
| [Expert React Frontend Engineer](../agents/expert-react-frontend-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-react-frontend-engineer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fexpert-react-frontend-engineer.agent.md) | Expert React 19.2 frontend engineer specializing in modern hooks, Server Components, Actions, TypeScript, and performance optimization | |
|
||||
| [Gilfoyle Code Review Mode](../agents/gilfoyle.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgilfoyle.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgilfoyle.agent.md) | Code review and analysis with the sardonic wit and technical elitism of Bertram Gilfoyle from Silicon Valley. Prepare for brutal honesty about your code. | |
|
||||
| [GitHub Actions Expert](../agents/github-actions-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgithub-actions-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgithub-actions-expert.agent.md) | GitHub Actions specialist focused on secure CI/CD workflows, action pinning, OIDC authentication, permissions least privilege, and supply-chain security | |
|
||||
| [Go MCP Server Development Expert](../agents/go-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgo-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgo-mcp-expert.agent.md) | Expert assistant for building Model Context Protocol (MCP) servers in Go using the official SDK. | |
|
||||
| [GPT 5 Beast Mode](../agents/gpt-5-beast-mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgpt-5-beast-mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fgpt-5-beast-mode.agent.md) | Beast Mode 2.0: A powerful autonomous agent tuned specifically for GPT-5 that can solve complex problems by using tools, conducting research, and iterating until the problem is fully resolved. | |
|
||||
| [High-Level Big Picture Architect (HLBPA)](../agents/hlbpa.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fhlbpa.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fhlbpa.agent.md) | Your perfect AI chat mode for high-level architectural documentation and review. Perfect for targeted updates after a story or researching that legacy system when nobody remembers what it's supposed to be doing. | |
|
||||
@@ -95,6 +97,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Pimcore Expert](../agents/pimcore-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpimcore-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpimcore-expert.agent.md) | Expert Pimcore development assistant specializing in CMS, DAM, PIM, and E-Commerce solutions with Symfony integration | |
|
||||
| [Plan Mode Strategic Planning & Architecture](../agents/plan.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplan.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplan.agent.md) | Strategic planning and architecture assistant focused on thoughtful analysis before implementation. Helps developers understand codebases, clarify requirements, and develop comprehensive implementation strategies. | |
|
||||
| [Planning mode instructions](../agents/planner.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplanner.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplanner.agent.md) | Generate an implementation plan for new features or refactoring existing code. | |
|
||||
| [Platform SRE for Kubernetes](../agents/platform-sre-kubernetes.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplatform-sre-kubernetes.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplatform-sre-kubernetes.agent.md) | SRE-focused Kubernetes specialist prioritizing reliability, safe rollouts/rollbacks, security defaults, and operational verification for production-grade deployments | |
|
||||
| [Playwright Tester Mode](../agents/playwright-tester.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplaywright-tester.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fplaywright-tester.agent.md) | Testing mode for Playwright tests | |
|
||||
| [PostgreSQL Database Administrator](../agents/postgresql-dba.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpostgresql-dba.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpostgresql-dba.agent.md) | Work with PostgreSQL databases using the PostgreSQL extension. | |
|
||||
| [Power BI Data Modeling Expert Mode](../agents/power-bi-data-modeling-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpower-bi-data-modeling-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fpower-bi-data-modeling-expert.agent.md) | Expert Power BI data modeling guidance using star schema principles, relationship design, and Microsoft best practices for optimal model performance and usability. | |
|
||||
@@ -137,6 +140,7 @@ Custom agents for GitHub Copilot, making it easy for users and organizations to
|
||||
| [Technical Debt Remediation Plan](../agents/tech-debt-remediation-plan.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ftech-debt-remediation-plan.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ftech-debt-remediation-plan.agent.md) | Generate technical debt remediation plans for code, tests, and documentation. | |
|
||||
| [Technical spike research mode](../agents/research-technical-spike.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fresearch-technical-spike.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fresearch-technical-spike.agent.md) | Systematically research and validate technical spike documents through exhaustive investigation and controlled experimentation. | |
|
||||
| [Terraform Agent](../agents/terraform.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fterraform.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fterraform.agent.md) | Terraform infrastructure specialist with automated HCP Terraform workflows. Leverages Terraform MCP server for registry integration, workspace management, and run orchestration. Generates compliant code using latest provider/module versions, manages private registries, automates variable sets, and orchestrates infrastructure deployments with proper validation and security practices. | [terraform](https://github.com/mcp/io.github.hashicorp/terraform-mcp-server)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscode?name=terraform&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22TFE_TOKEN%253D%2524%257BCOPILOT_MCP_TFE_TOKEN%257D%22%2C%22-e%22%2C%22TFE_ADDRESS%253D%2524%257BCOPILOT_MCP_TFE_ADDRESS%257D%22%2C%22-e%22%2C%22ENABLE_TF_OPERATIONS%253D%2524%257BCOPILOT_MCP_ENABLE_TF_OPERATIONS%257D%22%2C%22hashicorp%252Fterraform-mcp-server%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-vscodeinsiders?name=terraform&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22TFE_TOKEN%253D%2524%257BCOPILOT_MCP_TFE_TOKEN%257D%22%2C%22-e%22%2C%22TFE_ADDRESS%253D%2524%257BCOPILOT_MCP_TFE_ADDRESS%257D%22%2C%22-e%22%2C%22ENABLE_TF_OPERATIONS%253D%2524%257BCOPILOT_MCP_ENABLE_TF_OPERATIONS%257D%22%2C%22hashicorp%252Fterraform-mcp-server%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D)<br />[](https://aka.ms/awesome-copilot/install/mcp-visualstudio/mcp-install?%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22TFE_TOKEN%253D%2524%257BCOPILOT_MCP_TFE_TOKEN%257D%22%2C%22-e%22%2C%22TFE_ADDRESS%253D%2524%257BCOPILOT_MCP_TFE_ADDRESS%257D%22%2C%22-e%22%2C%22ENABLE_TF_OPERATIONS%253D%2524%257BCOPILOT_MCP_ENABLE_TF_OPERATIONS%257D%22%2C%22hashicorp%252Fterraform-mcp-server%253Alatest%22%5D%2C%22env%22%3A%7B%7D%7D) |
|
||||
| [Terraform IaC Reviewer](../agents/terraform-iac-reviewer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fterraform-iac-reviewer.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Fterraform-iac-reviewer.agent.md) | Terraform-focused agent that reviews and creates safer IaC changes with emphasis on state safety, least privilege, module patterns, drift detection, and plan/apply discipline | |
|
||||
| [Thinking Beast Mode](../agents/Thinking-Beast-Mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2FThinking-Beast-Mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2FThinking-Beast-Mode.agent.md) | A transcendent coding agent with quantum cognitive architecture, adversarial intelligence, and unrestricted creative freedom. | |
|
||||
| [TypeScript MCP Server Expert](../agents/typescript-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ftypescript-mcp-expert.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2Ftypescript-mcp-expert.agent.md) | Expert assistant for developing Model Context Protocol (MCP) servers in TypeScript | |
|
||||
| [Ultimate Transparent Thinking Beast Mode](../agents/Ultimate-Transparent-Thinking-Beast-Mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2FUltimate-Transparent-Thinking-Beast-Mode.agent.md)<br />[](https://aka.ms/awesome-copilot/install/agent?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fagents%2FUltimate-Transparent-Thinking-Beast-Mode.agent.md) | Ultimate Transparent Thinking Beast Mode | |
|
||||
|
||||
@@ -47,3 +47,4 @@ Curated collections of related prompts, instructions, and agents organized aroun
|
||||
| [Technical Spike](../collections/technical-spike.md) | Tools for creation, management and research of technical spikes to reduce unknowns and assumptions before proceeding to specification and implementation of solutions. | 2 items | technical-spike, assumption-testing, validation, research |
|
||||
| [Testing & Test Automation](../collections/testing-automation.md) | Comprehensive collection for writing tests, test automation, and test-driven development including unit tests, integration tests, and end-to-end testing strategies. | 11 items | testing, tdd, automation, unit-tests, integration, playwright, jest, nunit |
|
||||
| [TypeScript MCP Server Development](../collections/typescript-mcp-development.md) | Complete toolkit for building Model Context Protocol (MCP) servers in TypeScript/Node.js using the official SDK. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance. | 3 items | typescript, mcp, model-context-protocol, nodejs, server-development |
|
||||
| [TypeSpec for Microsoft 365 Copilot](../collections/typespec-m365-copilot.md) | Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot extensibility. | 4 items | typespec, m365-copilot, declarative-agents, api-plugins, agent-development, microsoft-365 |
|
||||
|
||||
@@ -52,6 +52,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Convert Spring JPA project to Spring Data Cosmos](../instructions/convert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos |
|
||||
| [Copilot Process tracking Instructions](../instructions/copilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed |
|
||||
| [Copilot Prompt Files Guidelines](../instructions/prompt.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md) | Guidelines for creating high-quality prompt files for GitHub Copilot |
|
||||
| [Custom Agent File Guidelines](../instructions/agents.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fagents.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fagents.instructions.md) | Guidelines for creating custom agent files for GitHub Copilot |
|
||||
| [Custom Instructions File Guidelines](../instructions/instructions.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md) | Guidelines for creating high-quality custom instruction files for GitHub Copilot |
|
||||
| [Dart and Flutter](../instructions/dart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md) | Instructions for writing Dart and Flutter code following the official recommendations. |
|
||||
| [Dataverse SDK for Python - Advanced Features Guide](../instructions/dataverse-python-advanced-features.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-advanced-features.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdataverse-python-advanced-features.instructions.md) | Guide specific coding standards and best practices |
|
||||
@@ -94,6 +95,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Joyride Workspace Automation Assistant](../instructions/joyride-workspace-automation.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-workspace-automation.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-workspace-automation.instructions.md) | Expert assistance for Joyride Workspace automation - REPL-driven and user space ClojureScript automation within specific VS Code workspaces |
|
||||
| [Kotlin MCP Server Development Guidelines](../instructions/kotlin-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkotlin-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkotlin-mcp-server.instructions.md) | Best practices and patterns for building Model Context Protocol (MCP) servers in Kotlin using the official io.modelcontextprotocol:kotlin-sdk library. |
|
||||
| [Kubernetes Deployment Best Practices](../instructions/kubernetes-deployment-best-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-deployment-best-practices.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-deployment-best-practices.instructions.md) | Comprehensive best practices for deploying and managing applications on Kubernetes. Covers Pods, Deployments, Services, Ingress, ConfigMaps, Secrets, health checks, resource limits, scaling, and security contexts. |
|
||||
| [Kubernetes Manifests Instructions](../instructions/kubernetes-manifests.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-manifests.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-manifests.instructions.md) | Best practices for Kubernetes YAML manifests including labeling conventions, security contexts, pod security, resource management, probes, and validation commands |
|
||||
| [LangChain Python Instructions](../instructions/langchain-python.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Flangchain-python.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Flangchain-python.instructions.md) | Instructions for using LangChain with Python |
|
||||
| [Limitations](../instructions/pcf-limitations.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-limitations.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpcf-limitations.instructions.md) | Limitations and restrictions of Power Apps Component Framework |
|
||||
| [Makefile Development Instructions](../instructions/makefile.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmakefile.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmakefile.instructions.md) | Best practices for authoring GNU Make Makefiles |
|
||||
@@ -158,6 +160,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Terraform on SAP BTP – Best Practices & Conventions](../instructions/terraform-sap-btp.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fterraform-sap-btp.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fterraform-sap-btp.instructions.md) | Terraform conventions and guidelines for SAP Business Technology Platform (SAP BTP). |
|
||||
| [TypeScript Development](../instructions/typescript-5-es2022.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypescript-5-es2022.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypescript-5-es2022.instructions.md) | Guidelines for TypeScript Development targeting TypeScript 5.x and ES2022 output |
|
||||
| [TypeScript MCP Server Development](../instructions/typescript-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypescript-mcp-server.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypescript-mcp-server.instructions.md) | Instructions for building Model Context Protocol (MCP) servers using the TypeScript SDK |
|
||||
| [TypeSpec for Microsoft 365 Copilot Development Guidelines](../instructions/typespec-m365-copilot.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypespec-m365-copilot.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Ftypespec-m365-copilot.instructions.md) | Guidelines and best practices for building TypeSpec-based declarative agents and API plugins for Microsoft 365 Copilot |
|
||||
| [Update Code from Shorthand](../instructions/update-code-from-shorthand.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fupdate-code-from-shorthand.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fupdate-code-from-shorthand.instructions.md) | Shorthand code will be in the file provided from the prompt or raw data in the prompt, and will be used to update the code file when the prompt has the text `UPDATE CODE FROM SHORTHAND`. |
|
||||
| [Update Documentation on Code Change](../instructions/update-docs-on-code-change.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fupdate-docs-on-code-change.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fupdate-docs-on-code-change.instructions.md) | Automatically update README.md and documentation files when application code changes require documentation updates |
|
||||
| [Upgrading from .NET MAUI 9 to .NET MAUI 10](../instructions/dotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md)<br />[](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md) | Instructions for upgrading .NET MAUI applications from version 9 to version 10, including breaking changes, deprecated APIs, and migration strategies for ListView to CollectionView. |
|
||||
|
||||
@@ -19,6 +19,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [.NET/C# Design Pattern Review](../prompts/dotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md) | Review the C#/.NET code for design pattern implementation and suggest improvements. |
|
||||
| [Act Informed: First understand together with the human, then do](../prompts/first-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md) | Interactive, input-tool powered, task refinement workflow: interrogates scope, deliverables, constraints before carrying out the task; Requires the Joyride extension. |
|
||||
| [Add Educational Comments](../prompts/add-educational-comments.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md) | Add educational comments to the file specified, or prompt asking for file to comment if one is not provided. |
|
||||
| [Add TypeSpec API Operations](../prompts/typespec-api-operations.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-api-operations.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-api-operations.prompt.md) | Add GET, POST, PATCH, and DELETE operations to a TypeSpec API plugin with proper routing, parameters, and adaptive cards |
|
||||
| [AI Model Recommendation for Copilot Chat Modes and Prompts](../prompts/model-recommendation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmodel-recommendation.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmodel-recommendation.prompt.md) | Analyze chatmode or prompt files and recommend optimal AI models based on task complexity, required capabilities, and cost-efficiency |
|
||||
| [AI Prompt Engineering Safety Review & Improvement](../prompts/ai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md) | Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content. |
|
||||
| [ASP.NET .NET Framework Containerization Prompt](../prompts/containerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||
@@ -53,10 +54,13 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [Create Spring Boot Kotlin project prompt](../prompts/create-spring-boot-kotlin-project.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-kotlin-project.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-spring-boot-kotlin-project.prompt.md) | Create Spring Boot Kotlin Project Skeleton |
|
||||
| [Create Technical Spike Document](../prompts/create-technical-spike.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-technical-spike.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-technical-spike.prompt.md) | Create time-boxed technical spike documents for researching and resolving critical development decisions before implementation. |
|
||||
| [Create TLDR Page](../prompts/create-tldr-page.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-tldr-page.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-tldr-page.prompt.md) | Create a tldr page from documentation URLs and command examples, requiring both URL and command name. |
|
||||
| [Create TypeSpec API Plugin](../prompts/typespec-create-api-plugin.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-api-plugin.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-api-plugin.prompt.md) | Generate a TypeSpec API plugin with REST operations, authentication, and Adaptive Cards for Microsoft 365 Copilot |
|
||||
| [Create TypeSpec Declarative Agent](../prompts/typespec-create-agent.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-agent.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ftypespec-create-agent.prompt.md) | Generate a complete TypeSpec declarative agent with instructions, capabilities, and conversation starters for Microsoft 365 Copilot |
|
||||
| [Dataverse Python Production Code Generator](../prompts/dataverse-python-production-code.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-production-code.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-production-code.prompt.md) | Generate production-ready Python code using Dataverse SDK with error handling, optimization, and best practices |
|
||||
| [Dataverse Python Use Case Solution Builder](../prompts/dataverse-python-usecase-builder.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-usecase-builder.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-usecase-builder.prompt.md) | Generate complete solutions for specific Dataverse SDK use cases with architecture recommendations |
|
||||
| [Dataverse Python Advanced Patterns](../prompts/dataverse-python-advanced-patterns.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-advanced-patterns.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-advanced-patterns.prompt.md) | Generate production code for Dataverse SDK using advanced patterns, error handling, and optimization techniques. |
|
||||
| [Dataverse Python Quickstart Generator](../prompts/dataverse-python-quickstart.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-quickstart.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdataverse-python-quickstart.prompt.md) | Generate Python SDK setup + CRUD + bulk + paging snippets using official patterns. |
|
||||
| [DevOps Rollout Plan Generator](../prompts/devops-rollout-plan.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdevops-rollout-plan.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdevops-rollout-plan.prompt.md) | Generate comprehensive rollout plans with preflight checks, step-by-step deployment, verification signals, rollback procedures, and communication plans for infrastructure and application changes |
|
||||
| [Diátaxis Documentation Expert](../prompts/documentation-writer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdocumentation-writer.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdocumentation-writer.prompt.md) | Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework. |
|
||||
| [EditorConfig Expert](../prompts/editorconfig.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Feditorconfig.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Feditorconfig.prompt.md) | Generates a comprehensive and best-practice-oriented .editorconfig file based on project analysis and user preferences. |
|
||||
| [Entity Framework Core Best Practices](../prompts/ef-core.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fef-core.prompt.md)<br />[](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fef-core.prompt.md) | Get best practices for Entity Framework Core |
|
||||
|
||||
@@ -22,4 +22,6 @@ Skills differ from other primitives by supporting bundled assets (scripts, code
|
||||
|
||||
| Name | Description | Bundled Assets |
|
||||
| ---- | ----------- | -------------- |
|
||||
| [azure-role-selector](../skills/azure-role-selector/SKILL.md) | When user is asking for guidance for which role to assign to an identity given desired permissions, this agent helps them understand the role that will meet the requirements with least privilege access and how to apply that role. | `LICENSE.txt` |
|
||||
| [snowflake-semanticview](../skills/snowflake-semanticview/SKILL.md) | Create, alter, and validate Snowflake semantic views using Snowflake CLI (snow). Use when asked to build or troubleshoot semantic views/semantic layer definitions with CREATE/ALTER SEMANTIC VIEW, to validate semantic-view DDL against Snowflake via CLI, or to guide Snowflake CLI installation and connection setup. | None |
|
||||
| [webapp-testing](../skills/webapp-testing/SKILL.md) | Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs. | `test-helper.js` |
|
||||
|
||||
@@ -172,7 +172,8 @@ function parseSkillMetadata(skillPath) {
|
||||
} else {
|
||||
const relativePath = path.relative(skillPath, filePath);
|
||||
if (relativePath !== "SKILL.md") {
|
||||
arrayOfFiles.push(relativePath);
|
||||
// Normalize path separators to forward slashes for cross-platform consistency
|
||||
arrayOfFiles.push(relativePath.replace(/\\/g, '/'));
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
791
instructions/agents.instructions.md
Normal file
791
instructions/agents.instructions.md
Normal file
@@ -0,0 +1,791 @@
|
||||
---
|
||||
description: 'Guidelines for creating custom agent files for GitHub Copilot'
|
||||
applyTo: '**/*.agent.md'
|
||||
---
|
||||
|
||||
# Custom Agent File Guidelines
|
||||
|
||||
Instructions for creating effective and maintainable custom agent files that provide specialized expertise for specific development tasks in GitHub Copilot.
|
||||
|
||||
## Project Context
|
||||
|
||||
- Target audience: Developers creating custom agents for GitHub Copilot
|
||||
- File format: Markdown with YAML frontmatter
|
||||
- File naming convention: lowercase with hyphens (e.g., `test-specialist.agent.md`)
|
||||
- Location: `.github/agents/` directory (repository-level) or `agents/` directory (organization/enterprise-level)
|
||||
- Purpose: Define specialized agents with tailored expertise, tools, and instructions for specific tasks
|
||||
- Official documentation: https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents
|
||||
|
||||
## Required Frontmatter
|
||||
|
||||
Every agent file must include YAML frontmatter with the following fields:
|
||||
|
||||
```yaml
|
||||
---
|
||||
description: 'Brief description of the agent purpose and capabilities'
|
||||
name: 'Agent Display Name'
|
||||
tools: ['read', 'edit', 'search']
|
||||
model: 'Claude Sonnet 4.5'
|
||||
target: 'vscode'
|
||||
infer: true
|
||||
---
|
||||
```
|
||||
|
||||
### Core Frontmatter Properties
|
||||
|
||||
#### **description** (REQUIRED)
|
||||
- Single-quoted string, clearly stating the agent's purpose and domain expertise
|
||||
- Should be concise (50-150 characters) and actionable
|
||||
- Example: `'Focuses on test coverage, quality, and testing best practices'`
|
||||
|
||||
#### **name** (OPTIONAL)
|
||||
- Display name for the agent in the UI
|
||||
- If omitted, defaults to filename (without `.md` or `.agent.md`)
|
||||
- Use title case and be descriptive
|
||||
- Example: `'Testing Specialist'`
|
||||
|
||||
#### **tools** (OPTIONAL)
|
||||
- List of tool names or aliases the agent can use
|
||||
- Supports comma-separated string or YAML array format
|
||||
- If omitted, agent has access to all available tools
|
||||
- See "Tool Configuration" section below for details
|
||||
|
||||
#### **model** (STRONGLY RECOMMENDED)
|
||||
- Specifies which AI model the agent should use
|
||||
- Supported in VS Code, JetBrains IDEs, Eclipse, and Xcode
|
||||
- Example: `'Claude Sonnet 4.5'`, `'gpt-4'`, `'gpt-4o'`
|
||||
- Choose based on agent complexity and required capabilities
|
||||
|
||||
#### **target** (OPTIONAL)
|
||||
- Specifies target environment: `'vscode'` or `'github-copilot'`
|
||||
- If omitted, agent is available in both environments
|
||||
- Use when agent has environment-specific features
|
||||
|
||||
#### **infer** (OPTIONAL)
|
||||
- Boolean controlling whether Copilot can automatically use this agent based on context
|
||||
- Default: `true` if omitted
|
||||
- Set to `false` to require manual agent selection
|
||||
|
||||
#### **metadata** (OPTIONAL, GitHub.com only)
|
||||
- Object with name-value pairs for agent annotation
|
||||
- Example: `metadata: { category: 'testing', version: '1.0' }`
|
||||
- Not supported in VS Code
|
||||
|
||||
#### **mcp-servers** (OPTIONAL, Organization/Enterprise only)
|
||||
- Configure MCP servers available only to this agent
|
||||
- Only supported for organization/enterprise level agents
|
||||
- See "MCP Server Configuration" section below
|
||||
|
||||
## Tool Configuration
|
||||
|
||||
### Tool Specification Strategies
|
||||
|
||||
**Enable all tools** (default):
|
||||
```yaml
|
||||
# Omit tools property entirely, or use:
|
||||
tools: ['*']
|
||||
```
|
||||
|
||||
**Enable specific tools**:
|
||||
```yaml
|
||||
tools: ['read', 'edit', 'search', 'execute']
|
||||
```
|
||||
|
||||
**Enable MCP server tools**:
|
||||
```yaml
|
||||
tools: ['read', 'edit', 'github/*', 'playwright/navigate']
|
||||
```
|
||||
|
||||
**Disable all tools**:
|
||||
```yaml
|
||||
tools: []
|
||||
```
|
||||
|
||||
### Standard Tool Aliases
|
||||
|
||||
All aliases are case-insensitive:
|
||||
|
||||
| Alias | Alternative Names | Category | Description |
|
||||
|-------|------------------|----------|-------------|
|
||||
| `execute` | shell, Bash, powershell | Shell execution | Execute commands in appropriate shell |
|
||||
| `read` | Read, NotebookRead, view | File reading | Read file contents |
|
||||
| `edit` | Edit, MultiEdit, Write, NotebookEdit | File editing | Edit and modify files |
|
||||
| `search` | Grep, Glob, search | Code search | Search for files or text in files |
|
||||
| `agent` | custom-agent, Task | Agent invocation | Invoke other custom agents |
|
||||
| `web` | WebSearch, WebFetch | Web access | Fetch web content and search |
|
||||
| `todo` | TodoWrite | Task management | Create and manage task lists (VS Code only) |
|
||||
|
||||
### Built-in MCP Server Tools
|
||||
|
||||
**GitHub MCP Server**:
|
||||
```yaml
|
||||
tools: ['github/*'] # All GitHub tools
|
||||
tools: ['github/get_file_contents', 'github/search_repositories'] # Specific tools
|
||||
```
|
||||
- All read-only tools available by default
|
||||
- Token scoped to source repository
|
||||
|
||||
**Playwright MCP Server**:
|
||||
```yaml
|
||||
tools: ['playwright/*'] # All Playwright tools
|
||||
tools: ['playwright/navigate', 'playwright/screenshot'] # Specific tools
|
||||
```
|
||||
- Configured to access localhost only
|
||||
- Useful for browser automation and testing
|
||||
|
||||
### Tool Selection Best Practices
|
||||
|
||||
- **Principle of Least Privilege**: Only enable tools necessary for the agent's purpose
|
||||
- **Security**: Limit `execute` access unless explicitly required
|
||||
- **Focus**: Fewer tools = clearer agent purpose and better performance
|
||||
- **Documentation**: Comment why specific tools are required for complex configurations
|
||||
|
||||
## Sub-Agent Invocation (Agent Orchestration)
|
||||
|
||||
Agents can invoke other agents using `runSubagent` to orchestrate multi-step workflows.
|
||||
|
||||
### How It Works
|
||||
|
||||
Include `agent` in tools list to enable sub-agent invocation:
|
||||
|
||||
```yaml
|
||||
tools: ['read', 'edit', 'search', 'agent']
|
||||
```
|
||||
|
||||
Then invoke other agents with `runSubagent`:
|
||||
|
||||
```javascript
|
||||
const result = await runSubagent({
|
||||
description: 'What this step does',
|
||||
prompt: `You are the [Specialist] specialist.
|
||||
|
||||
Context:
|
||||
- Parameter: ${parameterValue}
|
||||
- Input: ${inputPath}
|
||||
- Output: ${outputPath}
|
||||
|
||||
Task:
|
||||
1. Do the specific work
|
||||
2. Write results to output location
|
||||
3. Return summary of completion`
|
||||
});
|
||||
```
|
||||
|
||||
### Basic Pattern
|
||||
|
||||
Structure each sub-agent call with:
|
||||
|
||||
1. **description**: Clear one-line purpose of the sub-agent invocation
|
||||
2. **prompt**: Detailed instructions with substituted variables
|
||||
|
||||
The prompt should include:
|
||||
- Who the sub-agent is (specialist role)
|
||||
- What context it needs (parameters, paths)
|
||||
- What to do (concrete tasks)
|
||||
- Where to write output
|
||||
- What to return (summary)
|
||||
|
||||
### Example: Multi-Step Processing
|
||||
|
||||
```javascript
|
||||
// Step 1: Process data
|
||||
const processing = await runSubagent({
|
||||
description: 'Transform raw input data',
|
||||
prompt: `You are the Data Processor specialist.
|
||||
|
||||
Project: ${projectName}
|
||||
Input: ${basePath}/raw/
|
||||
Output: ${basePath}/processed/
|
||||
|
||||
Task:
|
||||
1. Read all files from input directory
|
||||
2. Apply transformations
|
||||
3. Write processed files to output
|
||||
4. Create summary: ${basePath}/processed/summary.md
|
||||
|
||||
Return: Number of files processed and any issues found`
|
||||
});
|
||||
|
||||
// Step 2: Analyze (depends on Step 1)
|
||||
const analysis = await runSubagent({
|
||||
description: 'Analyze processed data',
|
||||
prompt: `You are the Data Analyst specialist.
|
||||
|
||||
Project: ${projectName}
|
||||
Input: ${basePath}/processed/
|
||||
Output: ${basePath}/analysis/
|
||||
|
||||
Task:
|
||||
1. Read processed files from input
|
||||
2. Generate analysis report
|
||||
3. Write to: ${basePath}/analysis/report.md
|
||||
|
||||
Return: Key findings and identified patterns`
|
||||
});
|
||||
```
|
||||
|
||||
### Key Points
|
||||
|
||||
- **Pass variables in prompts**: Use `${variableName}` for all dynamic values
|
||||
- **Keep prompts focused**: Clear, specific tasks for each sub-agent
|
||||
- **Return summaries**: Each sub-agent should report what it accomplished
|
||||
- **Sequential execution**: Use `await` to maintain order when steps depend on each other
|
||||
- **Error handling**: Check results before proceeding to dependent steps
|
||||
|
||||
### ⚠️ Tool Availability Requirement
|
||||
|
||||
**Critical**: If a sub-agent requires specific tools (e.g., `edit`, `execute`, `search`), the orchestrator must include those tools in its own `tools` list. Sub-agents cannot access tools that aren't available to their parent orchestrator.
|
||||
|
||||
**Example**:
|
||||
```yaml
|
||||
# If your sub-agents need to edit files, execute commands, or search code
|
||||
tools: ['read', 'edit', 'search', 'execute', 'agent']
|
||||
```
|
||||
|
||||
The orchestrator's tool permissions act as a ceiling for all invoked sub-agents. Plan your tool list carefully to ensure all sub-agents have the tools they need.
|
||||
|
||||
### ⚠️ Important Limitation
|
||||
|
||||
**Sub-agent orchestration is NOT suitable for large-scale data processing.** Avoid using `runSubagent` when:
|
||||
- Processing hundreds or thousands of files
|
||||
- Handling large datasets
|
||||
- Performing bulk transformations on big codebases
|
||||
- Orchestrating more than 5-10 sequential steps
|
||||
|
||||
Each sub-agent call adds latency and context overhead. For high-volume processing, implement logic directly in a single agent instead. Use orchestration only for coordinating specialized tasks on focused, manageable datasets.
|
||||
|
||||
## Agent Prompt Structure
|
||||
|
||||
The markdown content below the frontmatter defines the agent's behavior, expertise, and instructions. Well-structured prompts typically include:
|
||||
|
||||
1. **Agent Identity and Role**: Who the agent is and its primary role
|
||||
2. **Core Responsibilities**: What specific tasks the agent performs
|
||||
3. **Approach and Methodology**: How the agent works to accomplish tasks
|
||||
4. **Guidelines and Constraints**: What to do/avoid and quality standards
|
||||
5. **Output Expectations**: Expected output format and quality
|
||||
|
||||
### Prompt Writing Best Practices
|
||||
|
||||
- **Be Specific and Direct**: Use imperative mood ("Analyze", "Generate"); avoid vague terms
|
||||
- **Define Boundaries**: Clearly state scope limits and constraints
|
||||
- **Include Context**: Explain domain expertise and reference relevant frameworks
|
||||
- **Focus on Behavior**: Describe how the agent should think and work
|
||||
- **Use Structured Format**: Headers, bullets, and lists make prompts scannable
|
||||
|
||||
## Variable Definition and Extraction
|
||||
|
||||
Agents can define dynamic parameters to extract values from user input and use them throughout the agent's behavior and sub-agent communications. This enables flexible, context-aware agents that adapt to user-provided data.
|
||||
|
||||
### When to Use Variables
|
||||
|
||||
**Use variables when**:
|
||||
- Agent behavior depends on user input
|
||||
- Need to pass dynamic values to sub-agents
|
||||
- Want to make agents reusable across different contexts
|
||||
- Require parameterized workflows
|
||||
- Need to track or reference user-provided context
|
||||
|
||||
**Examples**:
|
||||
- Extract project name from user prompt
|
||||
- Capture certification name for pipeline processing
|
||||
- Identify file paths or directories
|
||||
- Extract configuration options
|
||||
- Parse feature names or module identifiers
|
||||
|
||||
### Variable Declaration Pattern
|
||||
|
||||
Define variables section early in the agent prompt to document expected parameters:
|
||||
|
||||
```markdown
|
||||
# Agent Name
|
||||
|
||||
## Dynamic Parameters
|
||||
|
||||
- **Parameter Name**: Description and usage
|
||||
- **Another Parameter**: How it's extracted and used
|
||||
|
||||
## Your Mission
|
||||
|
||||
Process [PARAMETER_NAME] to accomplish [task].
|
||||
```
|
||||
|
||||
### Variable Extraction Methods
|
||||
|
||||
#### 1. **Explicit User Input**
|
||||
Ask the user to provide the variable if not detected in the prompt:
|
||||
|
||||
```markdown
|
||||
## Your Mission
|
||||
|
||||
Process the project by analyzing your codebase.
|
||||
|
||||
### Step 1: Identify Project
|
||||
If no project name is provided, **ASK THE USER** for:
|
||||
- Project name or identifier
|
||||
- Base path or directory location
|
||||
- Configuration type (if applicable)
|
||||
|
||||
Use this information to contextualize all subsequent tasks.
|
||||
```
|
||||
|
||||
#### 2. **Implicit Extraction from Prompt**
|
||||
Automatically extract variables from the user's natural language input:
|
||||
|
||||
```javascript
|
||||
// Example: Extract certification name from user input
|
||||
const userInput = "Process My Certification";
|
||||
|
||||
// Extract key information
|
||||
const certificationName = extractCertificationName(userInput);
|
||||
// Result: "My Certification"
|
||||
|
||||
const basePath = `certifications/${certificationName}`;
|
||||
// Result: "certifications/My Certification"
|
||||
```
|
||||
|
||||
#### 3. **Contextual Variable Resolution**
|
||||
Use file context or workspace information to derive variables:
|
||||
|
||||
```markdown
|
||||
## Variable Resolution Strategy
|
||||
|
||||
1. **From User Prompt**: First, look for explicit mentions in user input
|
||||
2. **From File Context**: Check current file name or path
|
||||
3. **From Workspace**: Use workspace folder or active project
|
||||
4. **From Settings**: Reference configuration files
|
||||
5. **Ask User**: If all else fails, request missing information
|
||||
```
|
||||
|
||||
### Using Variables in Agent Prompts
|
||||
|
||||
#### Variable Substitution in Instructions
|
||||
|
||||
Use template variables in agent prompts to make them dynamic:
|
||||
|
||||
```markdown
|
||||
# Agent Name
|
||||
|
||||
## Dynamic Parameters
|
||||
- **Project Name**: ${projectName}
|
||||
- **Base Path**: ${basePath}
|
||||
- **Output Directory**: ${outputDir}
|
||||
|
||||
## Your Mission
|
||||
|
||||
Process the **${projectName}** project located at `${basePath}`.
|
||||
|
||||
## Process Steps
|
||||
|
||||
1. Read input from: `${basePath}/input/`
|
||||
2. Process files according to project configuration
|
||||
3. Write results to: `${outputDir}/`
|
||||
4. Generate summary report
|
||||
|
||||
## Quality Standards
|
||||
|
||||
- Maintain project-specific coding standards for **${projectName}**
|
||||
- Follow directory structure: `${basePath}/[structure]`
|
||||
```
|
||||
|
||||
#### Passing Variables to Sub-Agents
|
||||
|
||||
When invoking a sub-agent, pass all context through template variables in the prompt:
|
||||
|
||||
```javascript
|
||||
// Extract and prepare variables
|
||||
const basePath = `projects/${projectName}`;
|
||||
const inputPath = `${basePath}/src/`;
|
||||
const outputPath = `${basePath}/docs/`;
|
||||
|
||||
// Pass to sub-agent with all variables substituted
|
||||
const result = await runSubagent({
|
||||
description: 'Generate project documentation',
|
||||
prompt: `You are the Documentation specialist.
|
||||
|
||||
Project: ${projectName}
|
||||
Input: ${inputPath}
|
||||
Output: ${outputPath}
|
||||
|
||||
Task:
|
||||
1. Read source files from ${inputPath}
|
||||
2. Generate comprehensive documentation
|
||||
3. Write to ${outputPath}/index.md
|
||||
4. Include code examples and usage guides
|
||||
|
||||
Return: Summary of documentation generated (file count, word count)`
|
||||
});
|
||||
```
|
||||
|
||||
The sub-agent receives all necessary context embedded in the prompt. Variables are resolved before sending the prompt, so the sub-agent works with concrete paths and values, not variable placeholders.
|
||||
|
||||
### Real-World Example: Code Review Orchestrator
|
||||
|
||||
Example of a simple orchestrator that validates code through multiple specialized agents:
|
||||
|
||||
```javascript
|
||||
async function reviewCodePipeline(repositoryName, prNumber) {
|
||||
const basePath = `projects/${repositoryName}/pr-${prNumber}`;
|
||||
|
||||
// Step 1: Security Review
|
||||
const security = await runSubagent({
|
||||
description: 'Scan for security vulnerabilities',
|
||||
prompt: `You are the Security Reviewer specialist.
|
||||
|
||||
Repository: ${repositoryName}
|
||||
PR: ${prNumber}
|
||||
Code: ${basePath}/changes/
|
||||
|
||||
Task:
|
||||
1. Scan code for OWASP Top 10 vulnerabilities
|
||||
2. Check for injection attacks, auth flaws
|
||||
3. Write findings to ${basePath}/security-review.md
|
||||
|
||||
Return: List of critical, high, and medium issues found`
|
||||
});
|
||||
|
||||
// Step 2: Test Coverage Check
|
||||
const coverage = await runSubagent({
|
||||
description: 'Verify test coverage for changes',
|
||||
prompt: `You are the Test Coverage specialist.
|
||||
|
||||
Repository: ${repositoryName}
|
||||
PR: ${prNumber}
|
||||
Changes: ${basePath}/changes/
|
||||
|
||||
Task:
|
||||
1. Analyze code coverage for modified files
|
||||
2. Identify untested critical paths
|
||||
3. Write report to ${basePath}/coverage-report.md
|
||||
|
||||
Return: Current coverage percentage and gaps`
|
||||
});
|
||||
|
||||
// Step 3: Aggregate Results
|
||||
const finalReport = await runSubagent({
|
||||
description: 'Compile all review findings',
|
||||
prompt: `You are the Review Aggregator specialist.
|
||||
|
||||
Repository: ${repositoryName}
|
||||
Reports: ${basePath}/*.md
|
||||
|
||||
Task:
|
||||
1. Read all review reports from ${basePath}/
|
||||
2. Synthesize findings into single report
|
||||
3. Determine overall verdict (APPROVE/NEEDS_FIXES/BLOCK)
|
||||
4. Write to ${basePath}/final-review.md
|
||||
|
||||
Return: Final verdict and executive summary`
|
||||
});
|
||||
|
||||
return finalReport;
|
||||
}
|
||||
```
|
||||
|
||||
This pattern applies to any orchestration scenario: extract variables, call sub-agents with clear context, await results.
|
||||
|
||||
|
||||
### Variable Best Practices
|
||||
|
||||
#### 1. **Clear Documentation**
|
||||
Always document what variables are expected:
|
||||
|
||||
```markdown
|
||||
## Required Variables
|
||||
- **projectName**: The name of the project (string, required)
|
||||
- **basePath**: Root directory for project files (path, required)
|
||||
|
||||
## Optional Variables
|
||||
- **mode**: Processing mode - quick/standard/detailed (enum, default: standard)
|
||||
- **outputFormat**: Output format - markdown/json/html (enum, default: markdown)
|
||||
|
||||
## Derived Variables
|
||||
- **outputDir**: Automatically set to ${basePath}/output
|
||||
- **logFile**: Automatically set to ${basePath}/.log.md
|
||||
```
|
||||
|
||||
#### 2. **Consistent Naming**
|
||||
Use consistent variable naming conventions:
|
||||
|
||||
```javascript
|
||||
// Good: Clear, descriptive naming
|
||||
const variables = {
|
||||
projectName, // What project to work on
|
||||
basePath, // Where project files are located
|
||||
outputDirectory, // Where to save results
|
||||
processingMode, // How to process (detail level)
|
||||
configurationPath // Where config files are
|
||||
};
|
||||
|
||||
// Avoid: Ambiguous or inconsistent
|
||||
const bad_variables = {
|
||||
name, // Too generic
|
||||
path, // Unclear which path
|
||||
mode, // Too short
|
||||
config // Too vague
|
||||
};
|
||||
```
|
||||
|
||||
#### 3. **Validation and Constraints**
|
||||
Document valid values and constraints:
|
||||
|
||||
```markdown
|
||||
## Variable Constraints
|
||||
|
||||
**projectName**:
|
||||
- Type: string (alphanumeric, hyphens, underscores allowed)
|
||||
- Length: 1-100 characters
|
||||
- Required: yes
|
||||
- Pattern: `/^[a-zA-Z0-9_-]+$/`
|
||||
|
||||
**processingMode**:
|
||||
- Type: enum
|
||||
- Valid values: "quick" (< 5min), "standard" (5-15min), "detailed" (15+ min)
|
||||
- Default: "standard"
|
||||
- Required: no
|
||||
```
|
||||
|
||||
## MCP Server Configuration (Organization/Enterprise Only)
|
||||
|
||||
MCP servers extend agent capabilities with additional tools. Only supported for organization and enterprise-level agents.
|
||||
|
||||
### Configuration Format
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: my-custom-agent
|
||||
description: 'Agent with MCP integration'
|
||||
tools: ['read', 'edit', 'custom-mcp/tool-1']
|
||||
mcp-servers:
|
||||
custom-mcp:
|
||||
type: 'local'
|
||||
command: 'some-command'
|
||||
args: ['--arg1', '--arg2']
|
||||
tools: ["*"]
|
||||
env:
|
||||
ENV_VAR_NAME: ${{ secrets.API_KEY }}
|
||||
---
|
||||
```
|
||||
|
||||
### MCP Server Properties
|
||||
|
||||
- **type**: Server type (`'local'` or `'stdio'`)
|
||||
- **command**: Command to start the MCP server
|
||||
- **args**: Array of command arguments
|
||||
- **tools**: Tools to enable from this server (`["*"]` for all)
|
||||
- **env**: Environment variables (supports secrets)
|
||||
|
||||
### Environment Variables and Secrets
|
||||
|
||||
Secrets must be configured in repository settings under "copilot" environment.
|
||||
|
||||
**Supported syntax**:
|
||||
```yaml
|
||||
env:
|
||||
# Environment variable only
|
||||
VAR_NAME: COPILOT_MCP_ENV_VAR_VALUE
|
||||
|
||||
# Variable with header
|
||||
VAR_NAME: $COPILOT_MCP_ENV_VAR_VALUE
|
||||
VAR_NAME: ${COPILOT_MCP_ENV_VAR_VALUE}
|
||||
|
||||
# GitHub Actions-style (YAML only)
|
||||
VAR_NAME: ${{ secrets.COPILOT_MCP_ENV_VAR_VALUE }}
|
||||
VAR_NAME: ${{ var.COPILOT_MCP_ENV_VAR_VALUE }}
|
||||
```
|
||||
|
||||
## File Organization and Naming
|
||||
|
||||
### Repository-Level Agents
|
||||
- Location: `.github/agents/`
|
||||
- Scope: Available only in the specific repository
|
||||
- Access: Uses repository-configured MCP servers
|
||||
|
||||
### Organization/Enterprise-Level Agents
|
||||
- Location: `.github-private/agents/` (then move to `agents/` root)
|
||||
- Scope: Available across all repositories in org/enterprise
|
||||
- Access: Can configure dedicated MCP servers
|
||||
|
||||
### Naming Conventions
|
||||
- Use lowercase with hyphens: `test-specialist.agent.md`
|
||||
- Name should reflect agent purpose
|
||||
- Filename becomes default agent name (if `name` not specified)
|
||||
- Allowed characters: `.`, `-`, `_`, `a-z`, `A-Z`, `0-9`
|
||||
|
||||
## Agent Processing and Behavior
|
||||
|
||||
### Versioning
|
||||
- Based on Git commit SHAs for the agent file
|
||||
- Create branches/tags for different agent versions
|
||||
- Instantiated using latest version for repository/branch
|
||||
- PR interactions use same agent version for consistency
|
||||
|
||||
### Name Conflicts
|
||||
Priority (highest to lowest):
|
||||
1. Repository-level agent
|
||||
2. Organization-level agent
|
||||
3. Enterprise-level agent
|
||||
|
||||
Lower-level configurations override higher-level ones with the same name.
|
||||
|
||||
### Tool Processing
|
||||
- `tools` list filters available tools (built-in and MCP)
|
||||
- No tools specified = all tools enabled
|
||||
- Empty list (`[]`) = all tools disabled
|
||||
- Specific list = only those tools enabled
|
||||
- Unrecognized tool names are ignored (allows environment-specific tools)
|
||||
|
||||
### MCP Server Processing Order
|
||||
1. Out-of-the-box MCP servers (e.g., GitHub MCP)
|
||||
2. Custom agent MCP configuration (org/enterprise only)
|
||||
3. Repository-level MCP configurations
|
||||
|
||||
Each level can override settings from previous levels.
|
||||
|
||||
## Agent Creation Checklist
|
||||
|
||||
### Frontmatter
|
||||
- [ ] `description` field present and descriptive (50-150 chars)
|
||||
- [ ] `description` wrapped in single quotes
|
||||
- [ ] `name` specified (optional but recommended)
|
||||
- [ ] `tools` configured appropriately (or intentionally omitted)
|
||||
- [ ] `model` specified for optimal performance
|
||||
- [ ] `target` set if environment-specific
|
||||
- [ ] `infer` set to `false` if manual selection required
|
||||
|
||||
### Prompt Content
|
||||
- [ ] Clear agent identity and role defined
|
||||
- [ ] Core responsibilities listed explicitly
|
||||
- [ ] Approach and methodology explained
|
||||
- [ ] Guidelines and constraints specified
|
||||
- [ ] Output expectations documented
|
||||
- [ ] Examples provided where helpful
|
||||
- [ ] Instructions are specific and actionable
|
||||
- [ ] Scope and boundaries clearly defined
|
||||
- [ ] Total content under 30,000 characters
|
||||
|
||||
### File Structure
|
||||
- [ ] Filename follows lowercase-with-hyphens convention
|
||||
- [ ] File placed in correct directory (`.github/agents/` or `agents/`)
|
||||
- [ ] Filename uses only allowed characters
|
||||
- [ ] File extension is `.agent.md`
|
||||
|
||||
### Quality Assurance
|
||||
- [ ] Agent purpose is unique and not duplicative
|
||||
- [ ] Tools are minimal and necessary
|
||||
- [ ] Instructions are clear and unambiguous
|
||||
- [ ] Agent has been tested with representative tasks
|
||||
- [ ] Documentation references are current
|
||||
- [ ] Security considerations addressed (if applicable)
|
||||
|
||||
## Common Agent Patterns
|
||||
|
||||
### Testing Specialist
|
||||
**Purpose**: Focus on test coverage and quality
|
||||
**Tools**: All tools (for comprehensive test creation)
|
||||
**Approach**: Analyze, identify gaps, write tests, avoid production code changes
|
||||
|
||||
### Implementation Planner
|
||||
**Purpose**: Create detailed technical plans and specifications
|
||||
**Tools**: Limited to `['read', 'search', 'edit']`
|
||||
**Approach**: Analyze requirements, create documentation, avoid implementation
|
||||
|
||||
### Code Reviewer
|
||||
**Purpose**: Review code quality and provide feedback
|
||||
**Tools**: `['read', 'search']` only
|
||||
**Approach**: Analyze, suggest improvements, no direct modifications
|
||||
|
||||
### Refactoring Specialist
|
||||
**Purpose**: Improve code structure and maintainability
|
||||
**Tools**: `['read', 'search', 'edit']`
|
||||
**Approach**: Analyze patterns, propose refactorings, implement safely
|
||||
|
||||
### Security Auditor
|
||||
**Purpose**: Identify security issues and vulnerabilities
|
||||
**Tools**: `['read', 'search', 'web']`
|
||||
**Approach**: Scan code, check against OWASP, report findings
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
### Frontmatter Errors
|
||||
- ❌ Missing `description` field
|
||||
- ❌ Description not wrapped in quotes
|
||||
- ❌ Invalid tool names without checking documentation
|
||||
- ❌ Incorrect YAML syntax (indentation, quotes)
|
||||
|
||||
### Tool Configuration Issues
|
||||
- ❌ Granting excessive tool access unnecessarily
|
||||
- ❌ Missing required tools for agent's purpose
|
||||
- ❌ Not using tool aliases consistently
|
||||
- ❌ Forgetting MCP server namespace (`server-name/tool`)
|
||||
|
||||
### Prompt Content Problems
|
||||
- ❌ Vague, ambiguous instructions
|
||||
- ❌ Conflicting or contradictory guidelines
|
||||
- ❌ Lack of clear scope definition
|
||||
- ❌ Missing output expectations
|
||||
- ❌ Overly verbose instructions (exceeding character limits)
|
||||
- ❌ No examples or context for complex tasks
|
||||
|
||||
### Organizational Issues
|
||||
- ❌ Filename doesn't reflect agent purpose
|
||||
- ❌ Wrong directory (confusing repo vs org level)
|
||||
- ❌ Using spaces or special characters in filename
|
||||
- ❌ Duplicate agent names causing conflicts
|
||||
|
||||
## Testing and Validation
|
||||
|
||||
### Manual Testing
|
||||
1. Create the agent file with proper frontmatter
|
||||
2. Reload VS Code or refresh GitHub.com
|
||||
3. Select the agent from the dropdown in Copilot Chat
|
||||
4. Test with representative user queries
|
||||
5. Verify tool access works as expected
|
||||
6. Confirm output meets expectations
|
||||
|
||||
### Integration Testing
|
||||
- Test agent with different file types in scope
|
||||
- Verify MCP server connectivity (if configured)
|
||||
- Check agent behavior with missing context
|
||||
- Test error handling and edge cases
|
||||
- Validate agent switching and handoffs
|
||||
|
||||
### Quality Checks
|
||||
- Run through agent creation checklist
|
||||
- Review against common mistakes list
|
||||
- Compare with example agents in repository
|
||||
- Get peer review for complex agents
|
||||
- Document any special configuration needs
|
||||
|
||||
## Additional Resources
|
||||
|
||||
### Official Documentation
|
||||
- [Creating Custom Agents](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents)
|
||||
- [Custom Agents Configuration](https://docs.github.com/en/copilot/reference/custom-agents-configuration)
|
||||
- [Custom Agents in VS Code](https://code.visualstudio.com/docs/copilot/customization/custom-agents)
|
||||
- [MCP Integration](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)
|
||||
|
||||
### Community Resources
|
||||
- [Awesome Copilot Agents Collection](https://github.com/github/awesome-copilot/tree/main/agents)
|
||||
- [Customization Library Examples](https://docs.github.com/en/copilot/tutorials/customization-library/custom-agents)
|
||||
- [Your First Custom Agent Tutorial](https://docs.github.com/en/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent)
|
||||
|
||||
### Related Files
|
||||
- [Prompt Files Guidelines](./prompt.instructions.md) - For creating prompt files
|
||||
- [Instructions Guidelines](./instructions.instructions.md) - For creating instruction files
|
||||
|
||||
## Version Compatibility Notes
|
||||
|
||||
### GitHub.com (Coding Agent)
|
||||
- ✅ Fully supports all standard frontmatter properties
|
||||
- ✅ Repository and org/enterprise level agents
|
||||
- ✅ MCP server configuration (org/enterprise)
|
||||
- ❌ Does not support `model`, `argument-hint`, `handoffs` properties
|
||||
|
||||
### VS Code / JetBrains / Eclipse / Xcode
|
||||
- ✅ Supports `model` property for AI model selection
|
||||
- ✅ Supports `argument-hint` and `handoffs` properties
|
||||
- ✅ User profile and workspace-level agents
|
||||
- ❌ Cannot configure MCP servers at repository level
|
||||
- ⚠️ Some properties may behave differently
|
||||
|
||||
When creating agents for multiple environments, focus on common properties and test in all target environments. Use `target` property to create environment-specific agents when necessary.
|
||||
136
instructions/kubernetes-manifests.instructions.md
Normal file
136
instructions/kubernetes-manifests.instructions.md
Normal file
@@ -0,0 +1,136 @@
|
||||
---
|
||||
applyTo: 'k8s/**/*.yaml,k8s/**/*.yml,manifests/**/*.yaml,manifests/**/*.yml,deploy/**/*.yaml,deploy/**/*.yml,charts/**/templates/**/*.yaml,charts/**/templates/**/*.yml'
|
||||
description: 'Best practices for Kubernetes YAML manifests including labeling conventions, security contexts, pod security, resource management, probes, and validation commands'
|
||||
---
|
||||
|
||||
# Kubernetes Manifests Instructions
|
||||
|
||||
## Your Mission
|
||||
|
||||
Create production-ready Kubernetes manifests that prioritize security, reliability, and operational excellence with consistent labeling, proper resource management, and comprehensive health checks.
|
||||
|
||||
## Labeling Conventions
|
||||
|
||||
**Required Labels** (Kubernetes recommended):
|
||||
- `app.kubernetes.io/name`: Application name
|
||||
- `app.kubernetes.io/instance`: Instance identifier
|
||||
- `app.kubernetes.io/version`: Version
|
||||
- `app.kubernetes.io/component`: Component role
|
||||
- `app.kubernetes.io/part-of`: Application group
|
||||
- `app.kubernetes.io/managed-by`: Management tool
|
||||
|
||||
**Additional Labels**:
|
||||
- `environment`: Environment name
|
||||
- `team`: Owning team
|
||||
- `cost-center`: For billing
|
||||
|
||||
**Useful Annotations**:
|
||||
- Documentation and ownership
|
||||
- Monitoring: `prometheus.io/scrape`, `prometheus.io/port`, `prometheus.io/path`
|
||||
- Change tracking: git commit, deployment date
|
||||
|
||||
## SecurityContext Defaults
|
||||
|
||||
**Pod-level**:
|
||||
- `runAsNonRoot: true`
|
||||
- `runAsUser` and `runAsGroup`: Specific IDs
|
||||
- `fsGroup`: File system group
|
||||
- `seccompProfile.type: RuntimeDefault`
|
||||
|
||||
**Container-level**:
|
||||
- `allowPrivilegeEscalation: false`
|
||||
- `readOnlyRootFilesystem: true` (with tmpfs mounts for writable dirs)
|
||||
- `capabilities.drop: [ALL]` (add only what's needed)
|
||||
|
||||
## Pod Security Standards
|
||||
|
||||
Use Pod Security Admission:
|
||||
- **Restricted** (recommended for production): Enforces security hardening
|
||||
- **Baseline**: Minimal security requirements
|
||||
- Apply at namespace level
|
||||
|
||||
## Resource Requests and Limits
|
||||
|
||||
**Always define**:
|
||||
- Requests: Guaranteed minimum (scheduling)
|
||||
- Limits: Maximum allowed (prevents exhaustion)
|
||||
|
||||
**QoS Classes**:
|
||||
- **Guaranteed**: requests == limits (best for critical apps)
|
||||
- **Burstable**: requests < limits (flexible resource use)
|
||||
- **BestEffort**: No resources defined (avoid in production)
|
||||
|
||||
## Health Probes
|
||||
|
||||
**Liveness**: Restart unhealthy containers
|
||||
**Readiness**: Control traffic routing
|
||||
**Startup**: Protect slow-starting applications
|
||||
|
||||
Configure appropriate delays, periods, timeouts, and thresholds for each.
|
||||
|
||||
## Rollout Strategies
|
||||
|
||||
**Deployment Strategy**:
|
||||
- `RollingUpdate` with `maxSurge` and `maxUnavailable`
|
||||
- Set `maxUnavailable: 0` for zero-downtime
|
||||
|
||||
**High Availability**:
|
||||
- Minimum 2-3 replicas
|
||||
- Pod Disruption Budget (PDB)
|
||||
- Anti-affinity rules (spread across nodes/zones)
|
||||
- Horizontal Pod Autoscaler (HPA) for variable load
|
||||
|
||||
## Validation Commands
|
||||
|
||||
**Pre-deployment**:
|
||||
- `kubectl apply --dry-run=client -f manifest.yaml`
|
||||
- `kubectl apply --dry-run=server -f manifest.yaml`
|
||||
- `kubeconform -strict manifest.yaml` (schema validation)
|
||||
- `helm template ./chart | kubeconform -strict` (for Helm)
|
||||
|
||||
**Policy Validation**:
|
||||
- OPA Conftest, Kyverno, or Datree
|
||||
|
||||
## Rollout & Rollback
|
||||
|
||||
**Deploy**:
|
||||
- `kubectl apply -f manifest.yaml`
|
||||
- `kubectl rollout status deployment/NAME`
|
||||
|
||||
**Rollback**:
|
||||
- `kubectl rollout undo deployment/NAME`
|
||||
- `kubectl rollout undo deployment/NAME --to-revision=N`
|
||||
- `kubectl rollout history deployment/NAME`
|
||||
|
||||
**Restart**:
|
||||
- `kubectl rollout restart deployment/NAME`
|
||||
|
||||
## Manifest Checklist
|
||||
|
||||
- [ ] Labels: Standard labels applied
|
||||
- [ ] Annotations: Documentation and monitoring
|
||||
- [ ] Security: runAsNonRoot, readOnlyRootFilesystem, dropped capabilities
|
||||
- [ ] Resources: Requests and limits defined
|
||||
- [ ] Probes: Liveness, readiness, startup configured
|
||||
- [ ] Images: Specific tags (never :latest)
|
||||
- [ ] Replicas: Minimum 2-3 for production
|
||||
- [ ] Strategy: RollingUpdate with appropriate surge/unavailable
|
||||
- [ ] PDB: Defined for production
|
||||
- [ ] Anti-affinity: Configured for HA
|
||||
- [ ] Graceful shutdown: terminationGracePeriodSeconds set
|
||||
- [ ] Validation: Dry-run and kubeconform passed
|
||||
- [ ] Secrets: In Secrets resource, not ConfigMaps
|
||||
- [ ] NetworkPolicy: Least-privilege access (if applicable)
|
||||
|
||||
## Best Practices Summary
|
||||
|
||||
1. Use standard labels and annotations
|
||||
2. Always run as non-root with dropped capabilities
|
||||
3. Define resource requests and limits
|
||||
4. Implement all three probe types
|
||||
5. Pin image tags to specific versions
|
||||
6. Configure anti-affinity for HA
|
||||
7. Set Pod Disruption Budgets
|
||||
8. Use rolling updates with zero unavailability
|
||||
9. Validate manifests before applying
|
||||
10. Enable read-only root filesystem when possible
|
||||
440
instructions/typespec-m365-copilot.instructions.md
Normal file
440
instructions/typespec-m365-copilot.instructions.md
Normal file
@@ -0,0 +1,440 @@
|
||||
---
|
||||
description: 'Guidelines and best practices for building TypeSpec-based declarative agents and API plugins for Microsoft 365 Copilot'
|
||||
applyTo: '**/*.tsp'
|
||||
---
|
||||
|
||||
# TypeSpec for Microsoft 365 Copilot Development Guidelines
|
||||
|
||||
## Core Principles
|
||||
|
||||
When working with TypeSpec for Microsoft 365 Copilot:
|
||||
|
||||
1. **Type Safety First**: Leverage TypeSpec's strong typing for all models and operations
|
||||
2. **Declarative Approach**: Use decorators to describe intent, not implementation
|
||||
3. **Scoped Capabilities**: Always scope capabilities to specific resources when possible
|
||||
4. **Clear Instructions**: Write explicit, detailed agent instructions
|
||||
5. **User-Centric**: Design for the end-user experience in Microsoft 365 Copilot
|
||||
|
||||
## File Organization
|
||||
|
||||
### Standard Structure
|
||||
```
|
||||
project/
|
||||
├── appPackage/
|
||||
│ ├── cards/ # Adaptive Card templates
|
||||
│ │ └── *.json
|
||||
│ ├── .generated/ # Generated manifests (auto-generated)
|
||||
│ └── manifest.json # Teams app manifest
|
||||
├── src/
|
||||
│ ├── main.tsp # Agent definition
|
||||
│ └── actions.tsp # API operations (for plugins)
|
||||
├── m365agents.yml # Agents Toolkit configuration
|
||||
└── package.json
|
||||
```
|
||||
|
||||
### Import Statements
|
||||
Always include required imports at the top of TypeSpec files:
|
||||
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@typespec/openapi3";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Agents; // For agents
|
||||
using TypeSpec.M365.Copilot.Actions; // For API plugins
|
||||
```
|
||||
|
||||
## Agent Development Best Practices
|
||||
|
||||
### Agent Declaration
|
||||
```typescript
|
||||
@agent({
|
||||
name: "Role-Based Name", // e.g., "Customer Support Assistant"
|
||||
description: "Clear, concise description under 1,000 characters"
|
||||
})
|
||||
```
|
||||
|
||||
- Use role-based names that describe what the agent does
|
||||
- Make descriptions informative but concise
|
||||
- Avoid generic names like "Helper" or "Bot"
|
||||
|
||||
### Instructions
|
||||
```typescript
|
||||
@instructions("""
|
||||
You are a [specific role] specialized in [domain].
|
||||
|
||||
Your responsibilities include:
|
||||
- [Key responsibility 1]
|
||||
- [Key responsibility 2]
|
||||
|
||||
When helping users:
|
||||
- [Behavioral guideline 1]
|
||||
- [Behavioral guideline 2]
|
||||
|
||||
You should NOT:
|
||||
- [Constraint 1]
|
||||
- [Constraint 2]
|
||||
""")
|
||||
```
|
||||
|
||||
- Write in second person ("You are...")
|
||||
- Be specific about the agent's role and expertise
|
||||
- Define both what to do AND what not to do
|
||||
- Keep under 8,000 characters
|
||||
- Use clear, structured formatting
|
||||
|
||||
### Conversation Starters
|
||||
```typescript
|
||||
@conversationStarter(#{
|
||||
title: "Action-Oriented Title", // e.g., "Check Status"
|
||||
text: "Specific example query" // e.g., "What's the status of my ticket?"
|
||||
})
|
||||
```
|
||||
|
||||
- Provide 2-4 diverse starters
|
||||
- Make each showcase a different capability
|
||||
- Use action-oriented titles
|
||||
- Write realistic example queries
|
||||
|
||||
### Capabilities - Knowledge Sources
|
||||
|
||||
**Web Search** - Scope to specific sites when possible:
|
||||
```typescript
|
||||
op webSearch is AgentCapabilities.WebSearch<Sites = [
|
||||
{ url: "https://learn.microsoft.com" },
|
||||
{ url: "https://docs.microsoft.com" }
|
||||
]>;
|
||||
```
|
||||
|
||||
**OneDrive and SharePoint** - Use URLs or IDs:
|
||||
```typescript
|
||||
op oneDriveAndSharePoint is AgentCapabilities.OneDriveAndSharePoint<
|
||||
ItemsByUrl = [
|
||||
{ url: "https://contoso.sharepoint.com/sites/Engineering" }
|
||||
]
|
||||
>;
|
||||
```
|
||||
|
||||
**Teams Messages** - Specify channels/chats:
|
||||
```typescript
|
||||
op teamsMessages is AgentCapabilities.TeamsMessages<Urls = [
|
||||
{ url: "https://teams.microsoft.com/l/channel/..." }
|
||||
]>;
|
||||
```
|
||||
|
||||
**Email** - Scope to specific folders:
|
||||
```typescript
|
||||
op email is AgentCapabilities.Email<
|
||||
Folders = [
|
||||
{ folderId: "Inbox" },
|
||||
{ folderId: "SentItems" }
|
||||
],
|
||||
SharedMailbox = "support@contoso.com" // Optional
|
||||
>;
|
||||
```
|
||||
|
||||
**People** - No scoping needed:
|
||||
```typescript
|
||||
op people is AgentCapabilities.People;
|
||||
```
|
||||
|
||||
**Copilot Connectors** - Specify connection IDs:
|
||||
```typescript
|
||||
op copilotConnectors is AgentCapabilities.GraphConnectors<
|
||||
Connections = [
|
||||
{ connectionId: "your-connector-id" }
|
||||
]
|
||||
>;
|
||||
```
|
||||
|
||||
**Dataverse** - Scope to specific tables:
|
||||
```typescript
|
||||
op dataverse is AgentCapabilities.Dataverse<
|
||||
KnowledgeSources = [
|
||||
{
|
||||
hostName: "contoso.crm.dynamics.com";
|
||||
tables: [
|
||||
{ tableName: "account" },
|
||||
{ tableName: "contact" }
|
||||
];
|
||||
}
|
||||
]
|
||||
>;
|
||||
```
|
||||
|
||||
### Capabilities - Productivity Tools
|
||||
|
||||
```typescript
|
||||
// Python code execution
|
||||
op codeInterpreter is AgentCapabilities.CodeInterpreter;
|
||||
|
||||
// Image generation
|
||||
op graphicArt is AgentCapabilities.GraphicArt;
|
||||
|
||||
// Meeting content access
|
||||
op meetings is AgentCapabilities.Meetings;
|
||||
|
||||
// Specialized AI models
|
||||
op scenarioModels is AgentCapabilities.ScenarioModels<
|
||||
ModelsById = [
|
||||
{ id: "model-id" }
|
||||
]
|
||||
>;
|
||||
```
|
||||
|
||||
## API Plugin Development Best Practices
|
||||
|
||||
### Service Definition
|
||||
```typescript
|
||||
@service
|
||||
@actions(#{
|
||||
nameForHuman: "User-Friendly API Name",
|
||||
descriptionForHuman: "What users will understand",
|
||||
descriptionForModel: "What the model needs to know",
|
||||
contactEmail: "support@company.com",
|
||||
privacyPolicyUrl: "https://company.com/privacy",
|
||||
legalInfoUrl: "https://company.com/terms"
|
||||
})
|
||||
@server("https://api.example.com", "API Name")
|
||||
@useAuth([AuthType]) // If authentication needed
|
||||
namespace APINamespace {
|
||||
// Operations here
|
||||
}
|
||||
```
|
||||
|
||||
### Operation Definition
|
||||
```typescript
|
||||
@route("/resource/{id}")
|
||||
@get
|
||||
@action
|
||||
@card(#{
|
||||
dataPath: "$.items",
|
||||
title: "$.title",
|
||||
file: "cards/card.json"
|
||||
})
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Confirm Action",
|
||||
body: "Confirm with {{ function.parameters.param }}"
|
||||
}
|
||||
})
|
||||
@reasoning("Consider X when Y")
|
||||
@responding("Present results as Z")
|
||||
op getResource(
|
||||
@path id: string,
|
||||
@query filter?: string
|
||||
): ResourceResponse;
|
||||
```
|
||||
|
||||
### Models
|
||||
```typescript
|
||||
model Resource {
|
||||
id: string;
|
||||
name: string;
|
||||
description?: string; // Optional fields
|
||||
status: "active" | "inactive"; // Union types for enums
|
||||
@format("date-time")
|
||||
createdAt: utcDateTime;
|
||||
@format("uri")
|
||||
url?: string;
|
||||
}
|
||||
|
||||
model ResourceList {
|
||||
items: Resource[];
|
||||
totalCount: int32;
|
||||
nextPage?: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Authentication
|
||||
|
||||
**API Key**
|
||||
```typescript
|
||||
@useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">)
|
||||
|
||||
// Or with reference ID
|
||||
@useAuth(Auth)
|
||||
@authReferenceId("${{ENV_VAR_REFERENCE_ID}}")
|
||||
model Auth is ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">;
|
||||
```
|
||||
|
||||
**OAuth2**
|
||||
```typescript
|
||||
@useAuth(OAuth2Auth<[{
|
||||
type: OAuth2FlowType.authorizationCode;
|
||||
authorizationUrl: "https://auth.example.com/authorize";
|
||||
tokenUrl: "https://auth.example.com/token";
|
||||
refreshUrl: "https://auth.example.com/refresh";
|
||||
scopes: ["read", "write"];
|
||||
}]>)
|
||||
|
||||
// Or with reference ID
|
||||
@useAuth(Auth)
|
||||
@authReferenceId("${{OAUTH_REFERENCE_ID}}")
|
||||
model Auth is OAuth2Auth<[...]>;
|
||||
```
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
### Files
|
||||
- `main.tsp` - Agent definition
|
||||
- `actions.tsp` - API operations
|
||||
- `[feature].tsp` - Additional feature files
|
||||
- `cards/*.json` - Adaptive Card templates
|
||||
|
||||
### TypeSpec Elements
|
||||
- **Namespaces**: PascalCase (e.g., `CustomerSupportAgent`)
|
||||
- **Operations**: camelCase (e.g., `listProjects`, `createTicket`)
|
||||
- **Models**: PascalCase (e.g., `Project`, `TicketResponse`)
|
||||
- **Model Properties**: camelCase (e.g., `projectId`, `createdDate`)
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Multi-Capability Agent
|
||||
```typescript
|
||||
@agent("Knowledge Worker", "Description")
|
||||
@instructions("...")
|
||||
namespace KnowledgeWorker {
|
||||
op webSearch is AgentCapabilities.WebSearch;
|
||||
op files is AgentCapabilities.OneDriveAndSharePoint;
|
||||
op people is AgentCapabilities.People;
|
||||
}
|
||||
```
|
||||
|
||||
### CRUD API Plugin
|
||||
```typescript
|
||||
namespace ProjectAPI {
|
||||
@route("/projects") @get @action
|
||||
op list(): Project[];
|
||||
|
||||
@route("/projects/{id}") @get @action
|
||||
op get(@path id: string): Project;
|
||||
|
||||
@route("/projects") @post @action
|
||||
@capabilities(#{confirmation: ...})
|
||||
op create(@body project: CreateProject): Project;
|
||||
|
||||
@route("/projects/{id}") @patch @action
|
||||
@capabilities(#{confirmation: ...})
|
||||
op update(@path id: string, @body project: UpdateProject): Project;
|
||||
|
||||
@route("/projects/{id}") @delete @action
|
||||
@capabilities(#{confirmation: ...})
|
||||
op delete(@path id: string): void;
|
||||
}
|
||||
```
|
||||
|
||||
### Adaptive Card Data Binding
|
||||
```json
|
||||
{
|
||||
"type": "AdaptiveCard",
|
||||
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
||||
"version": "1.5",
|
||||
"body": [
|
||||
{
|
||||
"type": "Container",
|
||||
"$data": "${$root}",
|
||||
"items": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "Title: ${if(title, title, 'N/A')}",
|
||||
"wrap": true
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Validation and Testing
|
||||
|
||||
### Before Provisioning
|
||||
1. Run TypeSpec validation: `npm run build` or use Agents Toolkit
|
||||
2. Check all file paths in `@card` decorators exist
|
||||
3. Verify authentication references match configuration
|
||||
4. Ensure capability scoping is appropriate
|
||||
5. Review instructions for clarity and length
|
||||
|
||||
### Testing Strategy
|
||||
1. **Provision**: Deploy to development environment
|
||||
2. **Test**: Use Microsoft 365 Copilot at https://m365.cloud.microsoft/chat
|
||||
3. **Debug**: Enable Copilot developer mode for orchestrator insights
|
||||
4. **Iterate**: Refine based on actual behavior
|
||||
5. **Validate**: Test all conversation starters and capabilities
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
1. **Scope Capabilities**: Don't grant access to all data if only subset needed
|
||||
2. **Limit Operations**: Only expose API operations the agent actually uses
|
||||
3. **Efficient Models**: Keep response models focused on necessary data
|
||||
4. **Card Optimization**: Use conditional rendering (`$when`) in Adaptive Cards
|
||||
5. **Caching**: Design APIs with appropriate caching headers
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
1. **Authentication**: Always use authentication for non-public APIs
|
||||
2. **Scoping**: Limit capability access to minimum required resources
|
||||
3. **Validation**: Validate all inputs in API operations
|
||||
4. **Secrets**: Use environment variables for sensitive data
|
||||
5. **References**: Use `@authReferenceId` for production credentials
|
||||
6. **Permissions**: Request minimum necessary OAuth scopes
|
||||
|
||||
## Error Handling
|
||||
|
||||
```typescript
|
||||
model ErrorResponse {
|
||||
error: {
|
||||
code: string;
|
||||
message: string;
|
||||
details?: ErrorDetail[];
|
||||
};
|
||||
}
|
||||
|
||||
model ErrorDetail {
|
||||
field?: string;
|
||||
message: string;
|
||||
}
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Include comments in TypeSpec for complex operations:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* Retrieves project details with associated tasks and team members.
|
||||
*
|
||||
* @param id - Unique project identifier
|
||||
* @param includeArchived - Whether to include archived tasks
|
||||
* @returns Complete project information
|
||||
*/
|
||||
@route("/projects/{id}")
|
||||
@get
|
||||
@action
|
||||
op getProjectDetails(
|
||||
@path id: string,
|
||||
@query includeArchived?: boolean
|
||||
): ProjectDetails;
|
||||
```
|
||||
|
||||
## Common Pitfalls to Avoid
|
||||
|
||||
1. ❌ Generic agent names ("Helper Bot")
|
||||
2. ❌ Vague instructions ("Help users with things")
|
||||
3. ❌ No capability scoping (accessing all data)
|
||||
4. ❌ Missing confirmations on destructive operations
|
||||
5. ❌ Overly complex Adaptive Cards
|
||||
6. ❌ Hard-coded credentials in TypeSpec files
|
||||
7. ❌ Missing error response models
|
||||
8. ❌ Inconsistent naming conventions
|
||||
9. ❌ Too many capabilities (use only what's needed)
|
||||
10. ❌ Instructions over 8,000 characters
|
||||
|
||||
## Resources
|
||||
|
||||
- [TypeSpec Official Docs](https://typespec.io/)
|
||||
- [Microsoft 365 Copilot Extensibility](https://learn.microsoft.com/microsoft-365-copilot/extensibility/)
|
||||
- [Agents Toolkit](https://aka.ms/M365AgentsToolkit)
|
||||
- [Adaptive Cards Designer](https://adaptivecards.io/designer/)
|
||||
118
prompts/devops-rollout-plan.prompt.md
Normal file
118
prompts/devops-rollout-plan.prompt.md
Normal file
@@ -0,0 +1,118 @@
|
||||
---
|
||||
agent: 'agent'
|
||||
description: 'Generate comprehensive rollout plans with preflight checks, step-by-step deployment, verification signals, rollback procedures, and communication plans for infrastructure and application changes'
|
||||
tools: ['codebase', 'terminalCommand', 'search', 'githubRepo']
|
||||
---
|
||||
|
||||
# DevOps Rollout Plan Generator
|
||||
|
||||
Your goal is to create a comprehensive, production-ready rollout plan for infrastructure or application changes.
|
||||
|
||||
## Input Requirements
|
||||
|
||||
Gather these details before generating the plan:
|
||||
|
||||
### Change Description
|
||||
- What's changing (infrastructure, application, configuration)
|
||||
- Version or state transition (from/to)
|
||||
- Problem solved or feature added
|
||||
|
||||
### Environment Details
|
||||
- Target environment (dev, staging, production, all)
|
||||
- Infrastructure type (Kubernetes, VMs, serverless, containers)
|
||||
- Affected services and dependencies
|
||||
- Current capacity and scale
|
||||
|
||||
### Constraints & Requirements
|
||||
- Acceptable downtime window
|
||||
- Change window restrictions
|
||||
- Approval requirements
|
||||
- Regulatory or compliance considerations
|
||||
|
||||
### Risk Assessment
|
||||
- Blast radius of change
|
||||
- Data migrations or schema changes
|
||||
- Rollback complexity and safety
|
||||
- Known risks
|
||||
|
||||
## Output Format
|
||||
|
||||
Generate a structured rollout plan with these sections:
|
||||
|
||||
### 1. Executive Summary
|
||||
- What, why, when, duration
|
||||
- Risk level and rollback time
|
||||
- Affected systems and user impact
|
||||
- Expected downtime
|
||||
|
||||
### 2. Prerequisites & Approvals
|
||||
- Required approvals (technical lead, security, compliance, business)
|
||||
- Required resources (capacity, backups, monitoring, rollback automation)
|
||||
- Pre-deployment backups
|
||||
|
||||
### 3. Preflight Checks
|
||||
- Infrastructure health validation
|
||||
- Application health baseline
|
||||
- Dependency availability
|
||||
- Monitoring baseline metrics
|
||||
- Go/no-go decision checklist
|
||||
|
||||
### 4. Step-by-Step Rollout Procedure
|
||||
**Phases**: Pre-deployment, deployment, progressive verification
|
||||
- Specific commands for each step
|
||||
- Validation after each step
|
||||
- Duration estimates
|
||||
|
||||
### 5. Verification Signals
|
||||
**Immediate** (0-2 min): Deployment success, pods/containers started, health checks passing
|
||||
**Short-term** (2-5 min): Application responding, error rates acceptable, latency normal
|
||||
**Medium-term** (5-15 min): Sustained metrics, stable connections, integrations working
|
||||
**Long-term** (15+ min): No degradation, capacity healthy, business metrics normal
|
||||
|
||||
### 6. Rollback Procedure
|
||||
**Decision Criteria**: When to initiate rollback
|
||||
**Rollback Steps**: Automated, infrastructure revert, or full restore
|
||||
**Post-Rollback Verification**: Confirm system health restored
|
||||
**Communication**: Stakeholder notification
|
||||
|
||||
### 7. Communication Plan
|
||||
- Pre-deployment (T-24h): Schedule and impact notice
|
||||
- Deployment start: Commencement notice
|
||||
- Progress updates: Status every X minutes
|
||||
- Completion: Success confirmation
|
||||
- Rollback (if needed): Issue notification
|
||||
|
||||
**Stakeholder Matrix**: Who to notify, when, via what method, with what content
|
||||
|
||||
### 8. Post-Deployment Tasks
|
||||
- Immediate (1h): Verify criteria met, review logs
|
||||
- Short-term (24h): Monitor metrics, review errors
|
||||
- Medium-term (1 week): Post-deployment review, lessons learned
|
||||
|
||||
### 9. Contingency Plans
|
||||
Scenarios: Partial failure, performance degradation, data inconsistency, dependency failure
|
||||
For each: Symptoms, response, timeline
|
||||
|
||||
### 10. Contact Information
|
||||
- Primary and secondary on-call
|
||||
- Escalation path
|
||||
- Emergency contacts (infrastructure, security, database, networking)
|
||||
|
||||
## Plan Customization
|
||||
|
||||
Adapt based on:
|
||||
- **Infrastructure Type**: Kubernetes, VMs, serverless, databases
|
||||
- **Risk Level**: Low (simplified), medium (standard), high (additional gates)
|
||||
- **Change Type**: Code deployment, infrastructure, configuration, data migration
|
||||
- **Environment**: Production (full plan), staging (simplified), development (minimal)
|
||||
|
||||
## Remember
|
||||
|
||||
- Always have a tested rollback plan
|
||||
- Communicate early and often
|
||||
- Monitor metrics, not just logs
|
||||
- Document everything
|
||||
- Learn from each deployment
|
||||
- Never deploy on Friday afternoon (unless critical)
|
||||
- Never skip verification steps
|
||||
- Never assume "it should work"
|
||||
@@ -1,115 +1,114 @@
|
||||
---
|
||||
name: ".NET Upgrade Analysis Prompts"
|
||||
description: "Ready-to-use prompts for comprehensive .NET framework upgrade analysis and execution"
|
||||
prompts:
|
||||
---
|
||||
# Project Discovery & Assessment
|
||||
- name: "Project Classification Analysis"
|
||||
prompt: "Identify all projects in the solution and classify them by type (`.NET Framework`, `.NET Core`, `.NET Standard`). Analyze each `.csproj` for its current `TargetFramework` and SDK usage."
|
||||
|
||||
|
||||
- name: "Dependency Compatibility Review"
|
||||
prompt: "Review external and internal dependencies for framework compatibility. Determine the upgrade complexity based on dependency graph depth."
|
||||
|
||||
|
||||
- name: "Legacy Package Detection"
|
||||
prompt: "Identify legacy `packages.config` projects needing migration to `PackageReference` format."
|
||||
|
||||
# Upgrade Strategy & Sequencing
|
||||
- name: "Project Upgrade Ordering"
|
||||
prompt: "Recommend a project upgrade order from least to most dependent components. Suggest how to isolate class library upgrades before API or Azure Function migrations."
|
||||
|
||||
|
||||
- name: "Incremental Strategy Planning"
|
||||
prompt: "Propose an incremental upgrade strategy with rollback checkpoints. Evaluate the use of **Upgrade Assistant** or **manual upgrades** based on project structure."
|
||||
|
||||
|
||||
- name: "Progress Tracking Setup"
|
||||
prompt: "Generate an upgrade checklist for tracking build, test, and deployment readiness across all projects."
|
||||
|
||||
# Framework Targeting & Code Adjustments
|
||||
- name: "Target Framework Selection"
|
||||
prompt: "Suggest the correct `TargetFramework` for each project (e.g., `net8.0`). Review and update deprecated SDK or build configurations."
|
||||
|
||||
|
||||
- name: "Code Modernization Analysis"
|
||||
prompt: "Identify code patterns needing modernization (e.g., `WebHostBuilder` → `HostBuilder`). Suggest replacements for deprecated .NET APIs and third-party libraries."
|
||||
|
||||
|
||||
- name: "Async Pattern Conversion"
|
||||
prompt: "Recommend conversion of synchronous calls to async where appropriate for improved performance and scalability."
|
||||
|
||||
# NuGet & Dependency Management
|
||||
- name: "Package Compatibility Analysis"
|
||||
prompt: "Analyze outdated or incompatible NuGet packages and suggest compatible versions. Identify third-party libraries that lack .NET 8 support and provide migration paths."
|
||||
|
||||
|
||||
- name: "Shared Dependency Strategy"
|
||||
prompt: "Recommend strategies for handling shared dependency upgrades across projects. Evaluate usage of legacy packages and suggest alternatives in Microsoft-supported namespaces."
|
||||
|
||||
|
||||
- name: "Transitive Dependency Review"
|
||||
prompt: "Review transitive dependencies and potential version conflicts after upgrade. Suggest resolution strategies for dependency conflicts."
|
||||
|
||||
# CI/CD & Build Pipeline Updates
|
||||
- name: "Pipeline Configuration Analysis"
|
||||
prompt: "Analyze YAML build definitions for SDK version pinning and recommend updates. Suggest modifications for `UseDotNet@2` and `NuGetToolInstaller` tasks."
|
||||
|
||||
|
||||
- name: "Build Pipeline Modernization"
|
||||
prompt: "Generate updated build pipeline snippets for .NET 8 migration. Recommend validation builds on feature branches before merging to main."
|
||||
|
||||
|
||||
- name: "CI Automation Enhancement"
|
||||
prompt: "Identify opportunities to automate test and build verification in CI pipelines. Suggest strategies for continuous integration validation."
|
||||
|
||||
# Testing & Validation
|
||||
- name: "Build Validation Strategy"
|
||||
prompt: "Propose validation checks to ensure the upgraded solution builds and runs successfully. Recommend automated test execution for unit and integration suites post-upgrade."
|
||||
|
||||
|
||||
- name: "Service Integration Verification"
|
||||
prompt: "Generate validation steps to verify logging, telemetry, and service connectivity. Suggest strategies for verifying backward compatibility and runtime behavior."
|
||||
|
||||
|
||||
- name: "Deployment Readiness Check"
|
||||
prompt: "Recommend UAT deployment verification steps before production rollout. Create comprehensive testing scenarios for upgraded components."
|
||||
|
||||
# Breaking Change Analysis
|
||||
- name: "API Deprecation Detection"
|
||||
prompt: "Identify deprecated APIs or removed namespaces between target versions. Suggest automated scanning using `.NET Upgrade Assistant` and API Analyzer."
|
||||
|
||||
|
||||
- name: "API Replacement Strategy"
|
||||
prompt: "Recommend replacement APIs or libraries for known breaking areas. Review configuration changes such as `Startup.cs` → `Program.cs` refactoring."
|
||||
|
||||
|
||||
- name: "Regression Testing Focus"
|
||||
prompt: "Suggest regression testing scenarios focused on upgraded API endpoints or services. Create test plans for critical functionality validation."
|
||||
|
||||
# Version Control & Commit Strategy
|
||||
- name: "Branching Strategy Planning"
|
||||
prompt: "Recommend branching strategy for safe upgrade with rollback capability. Generate commit templates for partial and complete project upgrades."
|
||||
|
||||
|
||||
- name: "PR Structure Optimization"
|
||||
prompt: "Suggest best practices for creating structured PRs (`Upgrade to .NET [Version]`). Identify tagging strategies for PRs involving breaking changes."
|
||||
|
||||
|
||||
- name: "Code Review Guidelines"
|
||||
prompt: "Recommend peer review focus areas (build, test, and dependency validation). Create checklists for effective upgrade reviews."
|
||||
|
||||
# Documentation & Communication
|
||||
- name: "Upgrade Documentation Strategy"
|
||||
prompt: "Suggest how to document each project's framework change in the PR. Propose automated release note generation summarizing upgrades and test results."
|
||||
|
||||
|
||||
- name: "Stakeholder Communication"
|
||||
prompt: "Recommend communicating version upgrades and migration timelines to consumers. Generate documentation templates for dependency updates and validation results."
|
||||
|
||||
|
||||
- name: "Progress Tracking Systems"
|
||||
prompt: "Suggest maintaining an upgrade summary dashboard or markdown checklist. Create templates for tracking upgrade progress across multiple projects."
|
||||
|
||||
# Tools & Automation
|
||||
- name: "Upgrade Tool Selection"
|
||||
prompt: "Recommend when and how to use: `.NET Upgrade Assistant`, `dotnet list package --outdated`, `dotnet migrate`, and `graph.json` dependency visualization."
|
||||
|
||||
|
||||
- name: "Analysis Script Generation"
|
||||
prompt: "Generate scripts or prompts for analyzing dependency graphs before upgrading. Propose AI-assisted prompts for Copilot to identify upgrade issues automatically."
|
||||
|
||||
|
||||
- name: "Multi-Repository Validation"
|
||||
prompt: "Suggest how to validate automation output across multiple repositories. Create standardized validation workflows for enterprise-scale upgrades."
|
||||
|
||||
# Final Validation & Delivery
|
||||
- name: "Final Solution Validation"
|
||||
prompt: "Generate validation steps to confirm the final upgraded solution passes all validation checks. Suggest production deployment verification steps post-upgrade."
|
||||
|
||||
|
||||
- name: "Deployment Readiness Confirmation"
|
||||
prompt: "Recommend generating final test results and build artifacts. Create a checklist summarizing completion across projects (builds/tests/deployment)."
|
||||
|
||||
|
||||
- name: "Release Documentation"
|
||||
prompt: "Generate a release note summarizing framework changes and CI/CD updates. Create comprehensive upgrade summary documentation."
|
||||
|
||||
|
||||
421
prompts/typespec-api-operations.prompt.md
Normal file
421
prompts/typespec-api-operations.prompt.md
Normal file
@@ -0,0 +1,421 @@
|
||||
---
|
||||
mode: 'agent'
|
||||
tools: ['changes', 'search/codebase', 'edit/editFiles', 'problems']
|
||||
description: 'Add GET, POST, PATCH, and DELETE operations to a TypeSpec API plugin with proper routing, parameters, and adaptive cards'
|
||||
model: 'gpt-4.1'
|
||||
tags: [typespec, m365-copilot, api-plugin, rest-operations, crud]
|
||||
---
|
||||
|
||||
# Add TypeSpec API Operations
|
||||
|
||||
Add RESTful operations to an existing TypeSpec API plugin for Microsoft 365 Copilot.
|
||||
|
||||
## Adding GET Operations
|
||||
|
||||
### Simple GET - List All Items
|
||||
```typescript
|
||||
/**
|
||||
* List all items.
|
||||
*/
|
||||
@route("/items")
|
||||
@get op listItems(): Item[];
|
||||
```
|
||||
|
||||
### GET with Query Parameter - Filter Results
|
||||
```typescript
|
||||
/**
|
||||
* List items filtered by criteria.
|
||||
* @param userId Optional user ID to filter items
|
||||
*/
|
||||
@route("/items")
|
||||
@get op listItems(@query userId?: integer): Item[];
|
||||
```
|
||||
|
||||
### GET with Path Parameter - Get Single Item
|
||||
```typescript
|
||||
/**
|
||||
* Get a specific item by ID.
|
||||
* @param id The ID of the item to retrieve
|
||||
*/
|
||||
@route("/items/{id}")
|
||||
@get op getItem(@path id: integer): Item;
|
||||
```
|
||||
|
||||
### GET with Adaptive Card
|
||||
```typescript
|
||||
/**
|
||||
* List items with adaptive card visualization.
|
||||
*/
|
||||
@route("/items")
|
||||
@card(#{
|
||||
dataPath: "$",
|
||||
title: "$.title",
|
||||
file: "item-card.json"
|
||||
})
|
||||
@get op listItems(): Item[];
|
||||
```
|
||||
|
||||
**Create the Adaptive Card** (`appPackage/item-card.json`):
|
||||
```json
|
||||
{
|
||||
"type": "AdaptiveCard",
|
||||
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
||||
"version": "1.5",
|
||||
"body": [
|
||||
{
|
||||
"type": "Container",
|
||||
"$data": "${$root}",
|
||||
"items": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "**${if(title, title, 'N/A')}**",
|
||||
"wrap": true
|
||||
},
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "${if(description, description, 'N/A')}",
|
||||
"wrap": true
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"actions": [
|
||||
{
|
||||
"type": "Action.OpenUrl",
|
||||
"title": "View Details",
|
||||
"url": "https://example.com/items/${id}"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Adding POST Operations
|
||||
|
||||
### Simple POST - Create Item
|
||||
```typescript
|
||||
/**
|
||||
* Create a new item.
|
||||
* @param item The item to create
|
||||
*/
|
||||
@route("/items")
|
||||
@post op createItem(@body item: CreateItemRequest): Item;
|
||||
|
||||
model CreateItemRequest {
|
||||
title: string;
|
||||
description?: string;
|
||||
userId: integer;
|
||||
}
|
||||
```
|
||||
|
||||
### POST with Confirmation
|
||||
```typescript
|
||||
/**
|
||||
* Create a new item with confirmation.
|
||||
*/
|
||||
@route("/items")
|
||||
@post
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Create Item",
|
||||
body: """
|
||||
Are you sure you want to create this item?
|
||||
* **Title**: {{ function.parameters.item.title }}
|
||||
* **User ID**: {{ function.parameters.item.userId }}
|
||||
"""
|
||||
}
|
||||
})
|
||||
op createItem(@body item: CreateItemRequest): Item;
|
||||
```
|
||||
|
||||
## Adding PATCH Operations
|
||||
|
||||
### Simple PATCH - Update Item
|
||||
```typescript
|
||||
/**
|
||||
* Update an existing item.
|
||||
* @param id The ID of the item to update
|
||||
* @param item The updated item data
|
||||
*/
|
||||
@route("/items/{id}")
|
||||
@patch op updateItem(
|
||||
@path id: integer,
|
||||
@body item: UpdateItemRequest
|
||||
): Item;
|
||||
|
||||
model UpdateItemRequest {
|
||||
title?: string;
|
||||
description?: string;
|
||||
status?: "active" | "completed" | "archived";
|
||||
}
|
||||
```
|
||||
|
||||
### PATCH with Confirmation
|
||||
```typescript
|
||||
/**
|
||||
* Update an item with confirmation.
|
||||
*/
|
||||
@route("/items/{id}")
|
||||
@patch
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Update Item",
|
||||
body: """
|
||||
Updating item #{{ function.parameters.id }}:
|
||||
* **Title**: {{ function.parameters.item.title }}
|
||||
* **Status**: {{ function.parameters.item.status }}
|
||||
"""
|
||||
}
|
||||
})
|
||||
op updateItem(
|
||||
@path id: integer,
|
||||
@body item: UpdateItemRequest
|
||||
): Item;
|
||||
```
|
||||
|
||||
## Adding DELETE Operations
|
||||
|
||||
### Simple DELETE
|
||||
```typescript
|
||||
/**
|
||||
* Delete an item.
|
||||
* @param id The ID of the item to delete
|
||||
*/
|
||||
@route("/items/{id}")
|
||||
@delete op deleteItem(@path id: integer): void;
|
||||
```
|
||||
|
||||
### DELETE with Confirmation
|
||||
```typescript
|
||||
/**
|
||||
* Delete an item with confirmation.
|
||||
*/
|
||||
@route("/items/{id}")
|
||||
@delete
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Delete Item",
|
||||
body: """
|
||||
⚠️ Are you sure you want to delete item #{{ function.parameters.id }}?
|
||||
This action cannot be undone.
|
||||
"""
|
||||
}
|
||||
})
|
||||
op deleteItem(@path id: integer): void;
|
||||
```
|
||||
|
||||
## Complete CRUD Example
|
||||
|
||||
### Define the Service and Models
|
||||
```typescript
|
||||
@service
|
||||
@server("https://api.example.com")
|
||||
@actions(#{
|
||||
nameForHuman: "Items API",
|
||||
descriptionForHuman: "Manage items",
|
||||
descriptionForModel: "Read, create, update, and delete items"
|
||||
})
|
||||
namespace ItemsAPI {
|
||||
|
||||
// Models
|
||||
model Item {
|
||||
@visibility(Lifecycle.Read)
|
||||
id: integer;
|
||||
|
||||
userId: integer;
|
||||
title: string;
|
||||
description?: string;
|
||||
status: "active" | "completed" | "archived";
|
||||
|
||||
@format("date-time")
|
||||
createdAt: utcDateTime;
|
||||
|
||||
@format("date-time")
|
||||
updatedAt?: utcDateTime;
|
||||
}
|
||||
|
||||
model CreateItemRequest {
|
||||
userId: integer;
|
||||
title: string;
|
||||
description?: string;
|
||||
}
|
||||
|
||||
model UpdateItemRequest {
|
||||
title?: string;
|
||||
description?: string;
|
||||
status?: "active" | "completed" | "archived";
|
||||
}
|
||||
|
||||
// Operations
|
||||
@route("/items")
|
||||
@card(#{ dataPath: "$", title: "$.title", file: "item-card.json" })
|
||||
@get op listItems(@query userId?: integer): Item[];
|
||||
|
||||
@route("/items/{id}")
|
||||
@card(#{ dataPath: "$", title: "$.title", file: "item-card.json" })
|
||||
@get op getItem(@path id: integer): Item;
|
||||
|
||||
@route("/items")
|
||||
@post
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Create Item",
|
||||
body: "Creating: **{{ function.parameters.item.title }}**"
|
||||
}
|
||||
})
|
||||
op createItem(@body item: CreateItemRequest): Item;
|
||||
|
||||
@route("/items/{id}")
|
||||
@patch
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Update Item",
|
||||
body: "Updating item #{{ function.parameters.id }}"
|
||||
}
|
||||
})
|
||||
op updateItem(@path id: integer, @body item: UpdateItemRequest): Item;
|
||||
|
||||
@route("/items/{id}")
|
||||
@delete
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Delete Item",
|
||||
body: "⚠️ Delete item #{{ function.parameters.id }}?"
|
||||
}
|
||||
})
|
||||
op deleteItem(@path id: integer): void;
|
||||
}
|
||||
```
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Multiple Query Parameters
|
||||
```typescript
|
||||
@route("/items")
|
||||
@get op listItems(
|
||||
@query userId?: integer,
|
||||
@query status?: "active" | "completed" | "archived",
|
||||
@query limit?: integer,
|
||||
@query offset?: integer
|
||||
): ItemList;
|
||||
|
||||
model ItemList {
|
||||
items: Item[];
|
||||
total: integer;
|
||||
hasMore: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
### Header Parameters
|
||||
```typescript
|
||||
@route("/items")
|
||||
@get op listItems(
|
||||
@header("X-API-Version") apiVersion?: string,
|
||||
@query userId?: integer
|
||||
): Item[];
|
||||
```
|
||||
|
||||
### Custom Response Models
|
||||
```typescript
|
||||
@route("/items/{id}")
|
||||
@delete op deleteItem(@path id: integer): DeleteResponse;
|
||||
|
||||
model DeleteResponse {
|
||||
success: boolean;
|
||||
message: string;
|
||||
deletedId: integer;
|
||||
}
|
||||
```
|
||||
|
||||
### Error Responses
|
||||
```typescript
|
||||
model ErrorResponse {
|
||||
error: {
|
||||
code: string;
|
||||
message: string;
|
||||
details?: string[];
|
||||
};
|
||||
}
|
||||
|
||||
@route("/items/{id}")
|
||||
@get op getItem(@path id: integer): Item | ErrorResponse;
|
||||
```
|
||||
|
||||
## Testing Prompts
|
||||
|
||||
After adding operations, test with these prompts:
|
||||
|
||||
**GET Operations:**
|
||||
- "List all items and show them in a table"
|
||||
- "Show me items for user ID 1"
|
||||
- "Get the details of item 42"
|
||||
|
||||
**POST Operations:**
|
||||
- "Create a new item with title 'My Task' for user 1"
|
||||
- "Add an item: title 'New Feature', description 'Add login'"
|
||||
|
||||
**PATCH Operations:**
|
||||
- "Update item 10 with title 'Updated Title'"
|
||||
- "Change the status of item 5 to completed"
|
||||
|
||||
**DELETE Operations:**
|
||||
- "Delete item 99"
|
||||
- "Remove the item with ID 15"
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Parameter Naming
|
||||
- Use descriptive parameter names: `userId` not `uid`
|
||||
- Be consistent across operations
|
||||
- Use optional parameters (`?`) for filters
|
||||
|
||||
### Documentation
|
||||
- Add JSDoc comments to all operations
|
||||
- Describe what each parameter does
|
||||
- Document expected responses
|
||||
|
||||
### Models
|
||||
- Use `@visibility(Lifecycle.Read)` for read-only fields like `id`
|
||||
- Use `@format("date-time")` for date fields
|
||||
- Use union types for enums: `"active" | "completed"`
|
||||
- Make optional fields explicit with `?`
|
||||
|
||||
### Confirmations
|
||||
- Always add confirmations to destructive operations (DELETE, PATCH)
|
||||
- Show key details in confirmation body
|
||||
- Use warning emoji (⚠️) for irreversible actions
|
||||
|
||||
### Adaptive Cards
|
||||
- Keep cards simple and focused
|
||||
- Use conditional rendering with `${if(..., ..., 'N/A')}`
|
||||
- Include action buttons for common next steps
|
||||
- Test data binding with actual API responses
|
||||
|
||||
### Routing
|
||||
- Use RESTful conventions:
|
||||
- `GET /items` - List
|
||||
- `GET /items/{id}` - Get one
|
||||
- `POST /items` - Create
|
||||
- `PATCH /items/{id}` - Update
|
||||
- `DELETE /items/{id}` - Delete
|
||||
- Group related operations in the same namespace
|
||||
- Use nested routes for hierarchical resources
|
||||
|
||||
## Common Issues
|
||||
|
||||
### Issue: Parameter not showing in Copilot
|
||||
**Solution**: Check parameter is properly decorated with `@query`, `@path`, or `@body`
|
||||
|
||||
### Issue: Adaptive card not rendering
|
||||
**Solution**: Verify file path in `@card` decorator and check JSON syntax
|
||||
|
||||
### Issue: Confirmation not appearing
|
||||
**Solution**: Ensure `@capabilities` decorator is properly formatted with confirmation object
|
||||
|
||||
### Issue: Model property not appearing in response
|
||||
**Solution**: Check if property needs `@visibility(Lifecycle.Read)` or remove it if it should be writable
|
||||
94
prompts/typespec-create-agent.prompt.md
Normal file
94
prompts/typespec-create-agent.prompt.md
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
mode: 'agent'
|
||||
tools: ['changes', 'search/codebase', 'edit/editFiles', 'problems']
|
||||
description: 'Generate a complete TypeSpec declarative agent with instructions, capabilities, and conversation starters for Microsoft 365 Copilot'
|
||||
model: 'gpt-4.1'
|
||||
tags: [typespec, m365-copilot, declarative-agent, agent-development]
|
||||
---
|
||||
|
||||
# Create TypeSpec Declarative Agent
|
||||
|
||||
Create a complete TypeSpec declarative agent for Microsoft 365 Copilot with the following structure:
|
||||
|
||||
## Requirements
|
||||
|
||||
Generate a `main.tsp` file with:
|
||||
|
||||
1. **Agent Declaration**
|
||||
- Use `@agent` decorator with a descriptive name and description
|
||||
- Name should be 100 characters or less
|
||||
- Description should be 1,000 characters or less
|
||||
|
||||
2. **Instructions**
|
||||
- Use `@instructions` decorator with clear behavioral guidelines
|
||||
- Define the agent's role, expertise, and personality
|
||||
- Specify what the agent should and shouldn't do
|
||||
- Keep under 8,000 characters
|
||||
|
||||
3. **Conversation Starters**
|
||||
- Include 2-4 `@conversationStarter` decorators
|
||||
- Each with a title and example query
|
||||
- Make them diverse and showcase different capabilities
|
||||
|
||||
4. **Capabilities** (based on user needs)
|
||||
- `WebSearch` - for web content with optional site scoping
|
||||
- `OneDriveAndSharePoint` - for document access with URL filtering
|
||||
- `TeamsMessages` - for Teams channel/chat access
|
||||
- `Email` - for email access with folder filtering
|
||||
- `People` - for organization people search
|
||||
- `CodeInterpreter` - for Python code execution
|
||||
- `GraphicArt` - for image generation
|
||||
- `GraphConnectors` - for Copilot connector content
|
||||
- `Dataverse` - for Dataverse data access
|
||||
- `Meetings` - for meeting content access
|
||||
|
||||
## Template Structure
|
||||
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@typespec/openapi3";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Agents;
|
||||
|
||||
@agent({
|
||||
name: "[Agent Name]",
|
||||
description: "[Agent Description]"
|
||||
})
|
||||
@instructions("""
|
||||
[Detailed instructions about agent behavior, role, and guidelines]
|
||||
""")
|
||||
@conversationStarter(#{
|
||||
title: "[Starter Title 1]",
|
||||
text: "[Example query 1]"
|
||||
})
|
||||
@conversationStarter(#{
|
||||
title: "[Starter Title 2]",
|
||||
text: "[Example query 2]"
|
||||
})
|
||||
namespace [AgentName] {
|
||||
// Add capabilities as operations here
|
||||
op capabilityName is AgentCapabilities.[CapabilityType]<[Parameters]>;
|
||||
}
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Use descriptive, role-based agent names (e.g., "Customer Support Assistant", "Research Helper")
|
||||
- Write instructions in second person ("You are...")
|
||||
- Be specific about the agent's expertise and limitations
|
||||
- Include diverse conversation starters that showcase different features
|
||||
- Only include capabilities the agent actually needs
|
||||
- Scope capabilities (URLs, folders, etc.) when possible for better performance
|
||||
- Use triple-quoted strings for multi-line instructions
|
||||
|
||||
## Examples
|
||||
|
||||
Ask the user:
|
||||
1. What is the agent's purpose and role?
|
||||
2. What capabilities does it need?
|
||||
3. What knowledge sources should it access?
|
||||
4. What are typical user interactions?
|
||||
|
||||
Then generate the complete TypeSpec agent definition.
|
||||
167
prompts/typespec-create-api-plugin.prompt.md
Normal file
167
prompts/typespec-create-api-plugin.prompt.md
Normal file
@@ -0,0 +1,167 @@
|
||||
---
|
||||
mode: 'agent'
|
||||
tools: ['changes', 'search/codebase', 'edit/editFiles', 'problems']
|
||||
description: 'Generate a TypeSpec API plugin with REST operations, authentication, and Adaptive Cards for Microsoft 365 Copilot'
|
||||
model: 'gpt-4.1'
|
||||
tags: [typespec, m365-copilot, api-plugin, rest-api]
|
||||
---
|
||||
|
||||
# Create TypeSpec API Plugin
|
||||
|
||||
Create a complete TypeSpec API plugin for Microsoft 365 Copilot that integrates with external REST APIs.
|
||||
|
||||
## Requirements
|
||||
|
||||
Generate TypeSpec files with:
|
||||
|
||||
### main.tsp - Agent Definition
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@typespec/openapi3";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
import "./actions.tsp";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Agents;
|
||||
using TypeSpec.M365.Copilot.Actions;
|
||||
|
||||
@agent({
|
||||
name: "[Agent Name]",
|
||||
description: "[Description]"
|
||||
})
|
||||
@instructions("""
|
||||
[Instructions for using the API operations]
|
||||
""")
|
||||
namespace [AgentName] {
|
||||
// Reference operations from actions.tsp
|
||||
op operation1 is [APINamespace].operationName;
|
||||
}
|
||||
```
|
||||
|
||||
### actions.tsp - API Operations
|
||||
```typescript
|
||||
import "@typespec/http";
|
||||
import "@microsoft/typespec-m365-copilot";
|
||||
|
||||
using TypeSpec.Http;
|
||||
using TypeSpec.M365.Copilot.Actions;
|
||||
|
||||
@service
|
||||
@actions(#{
|
||||
nameForHuman: "[API Display Name]",
|
||||
descriptionForModel: "[Model description]",
|
||||
descriptionForHuman: "[User description]"
|
||||
})
|
||||
@server("[API_BASE_URL]", "[API Name]")
|
||||
@useAuth([AuthType]) // Optional
|
||||
namespace [APINamespace] {
|
||||
|
||||
@route("[/path]")
|
||||
@get
|
||||
@action
|
||||
op operationName(
|
||||
@path param1: string,
|
||||
@query param2?: string
|
||||
): ResponseModel;
|
||||
|
||||
model ResponseModel {
|
||||
// Response structure
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Authentication Options
|
||||
|
||||
Choose based on API requirements:
|
||||
|
||||
1. **No Authentication** (Public APIs)
|
||||
```typescript
|
||||
// No @useAuth decorator needed
|
||||
```
|
||||
|
||||
2. **API Key**
|
||||
```typescript
|
||||
@useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">)
|
||||
```
|
||||
|
||||
3. **OAuth2**
|
||||
```typescript
|
||||
@useAuth(OAuth2Auth<[{
|
||||
type: OAuth2FlowType.authorizationCode;
|
||||
authorizationUrl: "https://oauth.example.com/authorize";
|
||||
tokenUrl: "https://oauth.example.com/token";
|
||||
refreshUrl: "https://oauth.example.com/token";
|
||||
scopes: ["read", "write"];
|
||||
}]>)
|
||||
```
|
||||
|
||||
4. **Registered Auth Reference**
|
||||
```typescript
|
||||
@useAuth(Auth)
|
||||
|
||||
@authReferenceId("registration-id-here")
|
||||
model Auth is ApiKeyAuth<ApiKeyLocation.header, "X-API-Key">
|
||||
```
|
||||
|
||||
## Function Capabilities
|
||||
|
||||
### Confirmation Dialog
|
||||
```typescript
|
||||
@capabilities(#{
|
||||
confirmation: #{
|
||||
type: "AdaptiveCard",
|
||||
title: "Confirm Action",
|
||||
body: """
|
||||
Are you sure you want to perform this action?
|
||||
* **Parameter**: {{ function.parameters.paramName }}
|
||||
"""
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Adaptive Card Response
|
||||
```typescript
|
||||
@card(#{
|
||||
dataPath: "$.items",
|
||||
title: "$.title",
|
||||
url: "$.link",
|
||||
file: "cards/card.json"
|
||||
})
|
||||
```
|
||||
|
||||
### Reasoning & Response Instructions
|
||||
```typescript
|
||||
@reasoning("""
|
||||
Consider user's context when calling this operation.
|
||||
Prioritize recent items over older ones.
|
||||
""")
|
||||
@responding("""
|
||||
Present results in a clear table format with columns: ID, Title, Status.
|
||||
Include a summary count at the end.
|
||||
""")
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Operation Names**: Use clear, action-oriented names (listProjects, createTicket)
|
||||
2. **Models**: Define TypeScript-like models for requests and responses
|
||||
3. **HTTP Methods**: Use appropriate verbs (@get, @post, @patch, @delete)
|
||||
4. **Paths**: Use RESTful path conventions with @route
|
||||
5. **Parameters**: Use @path, @query, @header, @body appropriately
|
||||
6. **Descriptions**: Provide clear descriptions for model understanding
|
||||
7. **Confirmations**: Add for destructive operations (delete, update critical data)
|
||||
8. **Cards**: Use for rich visual responses with multiple data items
|
||||
|
||||
## Workflow
|
||||
|
||||
Ask the user:
|
||||
1. What is the API base URL and purpose?
|
||||
2. What operations are needed (CRUD operations)?
|
||||
3. What authentication method does the API use?
|
||||
4. Should confirmations be required for any operations?
|
||||
5. Do responses need Adaptive Cards?
|
||||
|
||||
Then generate:
|
||||
- Complete `main.tsp` with agent definition
|
||||
- Complete `actions.tsp` with API operations and models
|
||||
- Optional `cards/card.json` if Adaptive Cards are needed
|
||||
21
skills/azure-role-selector/LICENSE.txt
Normal file
21
skills/azure-role-selector/LICENSE.txt
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright 2025 (c) Microsoft Corporation.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE
|
||||
6
skills/azure-role-selector/SKILL.md
Normal file
6
skills/azure-role-selector/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: azure-role-selector
|
||||
description: When user is asking for guidance for which role to assign to an identity given desired permissions, this agent helps them understand the role that will meet the requirements with least privilege access and how to apply that role.
|
||||
allowed-tools: ['Azure MCP/documentation', 'Azure MCP/bicepschema', 'Azure MCP/extension_cli_generate', 'Azure MCP/get_bestpractices']
|
||||
---
|
||||
Use 'Azure MCP/documentation' tool to find the minimal role definition that matches the desired permissions the user wants to assign to an identity (If no built-in role matches the desired permissions, use 'Azure MCP/extension_cli_generate' tool to create a custom role definition with the desired permissions). Use 'Azure MCP/extension_cli_generate' tool to generate the CLI commands needed to assign that role to the identity and use the 'Azure MCP/bicepschema' and the 'Azure MCP/get_bestpractices' tool to provide a Bicep code snippet for adding the role assignment.
|
||||
70
skills/snowflake-semanticview/SKILL.md
Normal file
70
skills/snowflake-semanticview/SKILL.md
Normal file
@@ -0,0 +1,70 @@
|
||||
---
|
||||
name: snowflake-semanticview
|
||||
description: Create, alter, and validate Snowflake semantic views using Snowflake CLI (snow). Use when asked to build or troubleshoot semantic views/semantic layer definitions with CREATE/ALTER SEMANTIC VIEW, to validate semantic-view DDL against Snowflake via CLI, or to guide Snowflake CLI installation and connection setup.
|
||||
---
|
||||
|
||||
# Snowflake Semantic Views
|
||||
|
||||
## One-Time Setup
|
||||
|
||||
- Verify Snowflake CLI installation by opening a new terminal and running `snow --help`.
|
||||
- If Snowflake CLI is missing or the user cannot install it, direct them to https://docs.snowflake.com/en/developer-guide/snowflake-cli/installation/installation.
|
||||
- Configure a Snowflake connection with `snow connection add` per https://docs.snowflake.com/en/developer-guide/snowflake-cli/connecting/configure-connections#add-a-connection.
|
||||
- Use the configured connection for all validation and execution steps.
|
||||
|
||||
## Workflow For Each Semantic View Request
|
||||
|
||||
1. Confirm the target database, schema, role, warehouse, and final semantic view name.
|
||||
2. Confirm the model follows a star schema (facts with conformed dimensions).
|
||||
3. Draft the semantic view DDL using the official syntax:
|
||||
- https://docs.snowflake.com/en/sql-reference/sql/create-semantic-view
|
||||
4. Populate synonyms and comments for each dimension, fact, and metric:
|
||||
- Read Snowflake table/view/column comments first (preferred source):
|
||||
- https://docs.snowflake.com/en/sql-reference/sql/comment
|
||||
- If comments or synonyms are missing, ask whether you can create them, whether the user wants to provide text, or whether you should draft suggestions for approval.
|
||||
5. Create a temporary validation name (for example, append `__tmp_validate`) while keeping the same database and schema.
|
||||
6. Always validate by sending the DDL to Snowflake via Snowflake CLI before finalizing:
|
||||
- Use `snow sql` to execute the statement with the configured connection.
|
||||
- If flags differ by version, check `snow sql --help` and use the connection option shown there.
|
||||
7. If validation fails, iterate on the DDL and re-run the validation step until it succeeds.
|
||||
8. Apply the final DDL (create or alter) using the real semantic view name.
|
||||
9. Clean up any temporary semantic view created during validation.
|
||||
|
||||
## Synonyms And Comments (Required)
|
||||
|
||||
- Use the semantic view syntax for synonyms and comments:
|
||||
|
||||
```
|
||||
WITH SYNONYMS [ = ] ( 'synonym' [ , ... ] )
|
||||
COMMENT = 'comment_about_dim_fact_or_metric'
|
||||
```
|
||||
|
||||
- Treat synonyms as informational only; do not use them to reference dimensions, facts, or metrics elsewhere.
|
||||
- Use Snowflake comments as the preferred and first source for synonyms and comments:
|
||||
- https://docs.snowflake.com/en/sql-reference/sql/comment
|
||||
- If Snowflake comments are missing, ask whether you can create them, whether the user wants to provide text, or whether you should draft suggestions for approval.
|
||||
- Do not invent synonyms or comments without user approval.
|
||||
|
||||
## Validation Pattern (Required)
|
||||
|
||||
- Never skip validation. Always execute the DDL against Snowflake with Snowflake CLI before presenting it as final.
|
||||
- Prefer a temporary name for validation to avoid clobbering the real view.
|
||||
|
||||
## Example CLI Validation (Template)
|
||||
|
||||
```bash
|
||||
# Replace placeholders with real values.
|
||||
snow sql -q "<CREATE OR ALTER SEMANTIC VIEW ...>" --connection <connection_name>
|
||||
```
|
||||
|
||||
If the CLI uses a different connection flag in your version, run:
|
||||
|
||||
```bash
|
||||
snow sql --help
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat installation and connection setup as one-time steps, but confirm they are done before the first validation.
|
||||
- Keep the final semantic view definition identical to the validated temporary definition except for the name.
|
||||
- Do not omit synonyms or comments; consider them required for completeness even if optional in syntax.
|
||||
Reference in New Issue
Block a user