Skip to content

Commit c54a01e

Browse files
CopilotRubenCerna2079Aniruddh25
authored
docs: Update nuget/README.md with MCP endpoint and comprehensive content (#3475)
## Why make this change? `nuget/README.md` (the README shown on the NuGet package page) was minimal and stale — it described only REST and GraphQL, omitted the MCP endpoint entirely and other content present in the root `README.md`. ## What is this change? Rewrote `nuget/README.md` to match the quality and completeness of the root `README.md`, adapted for the NuGet context: - **Badges** — docs link, license - **About** — updated to cover REST, GraphQL, and MCP endpoints - **Features** — added MCP section: DML tools, custom tools via stored procedures, configurable path (`/mcp` default), AI client compatibility (GitHub Copilot, Azure AI Foundry) - **Resources** — aligned with root README; links use absolute GitHub URLs ## How was this tested? - [ ] Integration Tests - [ ] Unit Tests Documentation-only change; no code logic modified. ## Sample Request(s) N/A --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RubenCerna2079 <32799214+RubenCerna2079@users.noreply.github.com> Co-authored-by: Ruben Cerna <rcernaserna@microsoft.com> Co-authored-by: Aniruddh Munde <anmunde@microsoft.com>
1 parent 0512b00 commit c54a01e

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

nuget/README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Data API builder for Azure Databases
22

33
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
4+
[![Documentation](https://img.shields.io/badge/docs-website-%23fc0)](https://learn.microsoft.com/azure/data-api-builder/)
5+
6+
[What's new?](https://learn.microsoft.com/azure/data-api-builder/whats-new)
47

58
## About
69

7-
**Data API builder for Azure Databases provides modern REST and GraphQL endpoints to your Azure Databases.**
10+
**Data API builder for Azure Databases provides modern REST and GraphQL endpoints and MCP tools to your Azure Databases.**
811

9-
With data API builder, database objects can be exposed via REST or GraphQL endpoints so that your data can be accessed using modern techniques on any platform, any language, and any device. With an integrated and flexible policy engine, native support for common behavior like pagination, filtering, projection and sorting, the creation of CRUD backend services can be done in minutes instead of hours or days, giving developers an efficiency boost like never seen before.
12+
With data API builder, database objects can be exposed via REST or GraphQL endpoints as well as MCP tools so that your data can be accessed using modern techniques on any platform, any language, and any device. With an integrated and flexible policy engine, native support for common behavior like pagination, filtering, projection and sorting, the creation of CRUD backend services and MCP tools can be done in minutes instead of hours or days, giving developers an efficiency boost like never seen before.
1013

11-
Data API builder is Open Source and works on any platform. It can be executed on-premises, in a container or as a Managed Service in Azure, via the new [Database Connection](https://learn.microsoft.com/azure/static-web-apps/database-overview) feature available in Azure Static Web Apps.
14+
Data API builder is Open Source and works on any platform. It can be executed on-premises, in a container or as a Managed Service in Azure, via the [Database Connection](https://learn.microsoft.com/azure/static-web-apps/database-overview) feature available in Azure Static Web Apps.
1215

1316
## Features
1417

15-
- Allow collections, tables, views and stored procedures to be accessed via REST and GraphQL
18+
- Allow collections, tables, views and stored procedures to be accessed via REST, GraphQL, and MCP
1619
- Support authentication via OAuth2/JWT
1720
- Support for EasyAuth when running in Azure
1821
- Role-based authorization using received claims
@@ -24,6 +27,26 @@ Data API builder is Open Source and works on any platform. It can be executed on
2427
- Queries and mutations
2528
- Filtering, sorting and pagination
2629
- Relationship navigation
30+
- MCP (Model Context Protocol)
31+
- Exposes database tables, views, and stored procedures through MCP tools
32+
- Compatible with any MCP-enabled AI client (e.g., GitHub Copilot, Azure AI Foundry)
33+
- DML tools for create, read, update, and delete operations
34+
- Custom tools via stored procedures
2735
- Easy development via dedicated CLI
2836
- Full integration with Static Web Apps via Database Connection feature when running in Azure
2937
- Open Source
38+
39+
## Getting started
40+
41+
Use the [Getting Started](https://learn.microsoft.com/azure/data-api-builder/get-started/get-started-with-data-api-builder) tutorial to quickly explore the core tools and concepts.
42+
43+
#### Other endpoints to explore
44+
45+
- DAB's Health endpoint: `http://localhost:5000/health`
46+
- DAB's Swagger UI: `http://localhost:5000/api/openapi`
47+
48+
## Additional resources
49+
50+
- [Online Documentation](https://learn.microsoft.com/en-us/azure/data-api-builder/overview)
51+
- [Official Samples](https://github.com/Azure-samples/data-api-builder)
52+
- [Known Issues](https://learn.microsoft.com/azure/data-api-builder/known-issues)

0 commit comments

Comments
 (0)