-
Notifications
You must be signed in to change notification settings - Fork 301
Add Copilot repository instructions #3090
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Aniruddh25 <3513779+Aniruddh25@users.noreply.github.com>
Co-authored-by: Aniruddh25 <3513779+Aniruddh25@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive Copilot instructions to help GitHub Copilot understand the Data API builder (DAB) repository structure, conventions, and workflows. The new .github/copilot-instructions.md file provides detailed guidance about the .NET 8 C# service that supports 6 database types, build/test commands, code conventions, security practices, and common development workflows.
Changes:
- Added
.github/copilot-instructions.mdwith comprehensive repository documentation including project overview, structure, build/test procedures, code style guidelines, and development workflows
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Language**: C# / .NET | ||
| - **.NET Version**: .NET 8.0 (see `global.json`) | ||
| - **Supported Databases**: Azure SQL, SQL Server, SQLDW, Cosmos DB, PostgreSQL, MySQL | ||
| - **API Types**: REST, GraphQL, MCP |
Copilot
AI
Jan 31, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API Types list includes "MCP" but the main README.md (lines 37-39) indicates MCP is "Coming soon" and not yet supported. While there is MCP code in the repository (src/Azure.DataApiBuilder.Mcp and tests in src/Service.Tests/Mcp), the documentation should be consistent. Either this should say "MCP (experimental)" or "MCP (preview)" or align with the official status in README.md.
| - Introspection enabled in development mode | ||
| - Nitro UI in development mode: `/graphql` | ||
| - Schema generated from database metadata | ||
| ### MCP tools |
Copilot
AI
Jan 31, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization in section header. The previous two section headers are "### REST API" and "### GraphQL API" (with "API" capitalized), so this should be either "### MCP API" or maintain the pattern with "MCP Tools" as a distinct section name. Consider changing to "### MCP API" or "### MCP Tools" (capital T) for consistency.
| ### MCP tools | |
| ### MCP Tools |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
/azp run |
|
Azure Pipelines could not run because the pipeline triggers exclude this branch/path. |
Why make this change?
Per GitHub best practices, Copilot coding agent uses
.github/copilot-instructions.mdto understand repository context, conventions, and workflows. Without this, the agent lacks project-specific knowledge for optimal assistance.What is this change?
Created
.github/copilot-instructions.mdcontaining:dotnet formatrequirements, schema setupdotnet formatenforcement, SQL query formatting per engine@env()syntax for connection strings, never commit secretsKey details for AI assistance:
src/Service.Tests/DatabaseSchema-<engine>.sql@env('var_name')for secretsHow was this tested?
Sample Request(s)
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
gh.io/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.