You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+26-1Lines changed: 26 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,7 @@ For snippets >6 lines:
44
44
1. All code should use the latest stable versions/features.
45
45
1. Create examples in both C# and Visual Basic unless the article referencing the snippet resides in the in the `csharp`, `fsharp`, and `visual-basic` language folders.
46
46
1. When you add code, use code comments sparingly because they don't get localized. You can use them to briefly clarify code-specific details (such as logic, parameters, or edge cases). Put any critical information and context in the markdown text of the referencing article.
47
+
1. IMPORTANT: For created code, always try to encapsulate it in an standalone executable (e.g. `dotnet fsi myFile.fsx` or `dotnet run myFile.cs`, add the necessary boilerplate/imports/usings where needed, and execute it.). Run it, and for every code snippet, include a PR commentary checking each code sample and proving what it has produced - this can be diagnostics, standard output, or a result value. That standalone file is just for the purpose of verification within copilot's execution environment, the published docs snippet should remain a subset as you would normally write to maximize clarity.
47
48
48
49
## File Naming
49
50
@@ -57,6 +58,30 @@ Examples:
57
58
- ❌ Bad: `configure_logging.md`
58
59
- ❌ Bad: `DependencyInjectionGuidelines.md`
59
60
61
+
## Documentation from External Sources (Blog Posts, Announcements)
62
+
63
+
When adapting content from external sources like blog posts into documentation:
64
+
65
+
**DO:**
66
+
- Work on one version, or topic at a time - never combine multiple versions in a single PR. Some blog posts or source material may include many versions or preview builds. The issue or task should specify which one to focus on.
67
+
- Copy working code samples directly from source when available. Follow the rules under ["Code Snippets"](#code-snippets) above.
68
+
- Create a checklist TODO for each section of the source document before writing.
69
+
- Map each documentation section 1:1 to source content.
70
+
- Explicitly state what is copied vs. generated in PR description.
71
+
- Add disclaimers about AI usage when applicable.
72
+
73
+
**DON'T:**
74
+
- Invent or elaborate on features not explicitly mentioned in source.
75
+
- Create placeholder sections without content.
76
+
- Assume feature details or characteristics.
77
+
- Combine information from multiple versions/sources.
78
+
- Add examples without verifying they demonstrate the stated feature.
79
+
80
+
**PR Description Must Include:**
81
+
- Content source breakdown. In the description, list each section of the source document and indicate whether it was copied verbatim, adapted, or newly generated.
82
+
- Note all generated sections requiring expert review.
83
+
- Clear warnings about any uncertainties.
84
+
60
85
## Special Cases
61
86
62
87
### Breaking Changes
@@ -69,4 +94,4 @@ When assigned an issue or directly given a task in GitHub:
69
94
3. Check for build warnings in the OpenPublishing.Build status check
description: Learn about .NET AI and MCP key concepts and development resources to get started building MCP clients and servers
4
-
ms.date: 04/29/2025
4
+
ms.date: 11/20/2025
5
5
ms.topic: overview
6
6
author: alexwolfmsft
7
7
ms.author: alexwolf
8
-
# CustomerIntent: As a .NET developer new to OpenAI, I want deploy and use sample code to interact to learn from the sample code to summarize text.
9
8
---
10
9
11
10
# Get started with .NET AI and the Model Context Protocol
12
11
13
-
The Model Context Protocol (MCP) is an open protocol designed to standardize integrations between AI apps and external tools and data sources. By using MCP, developers can enhance the capabilities of AI models, enabling them to produce more accurate, relevant, and context-aware responses.
12
+
Model Context Protocol (MCP) is an open protocol designed to standardize integrations between AI apps and external tools and data sources. By using MCP, developers can enhance the capabilities of AI models, enabling them to produce more accurate, relevant, and context-aware responses.
14
13
15
14
For example, using MCP, you can connect your LLM to resources such as:
16
15
@@ -22,36 +21,36 @@ Many Microsoft products already support MCP, including:
You can use the [MCP C# SDK](#develop-with-the-mcp-c-sdk) to quickly create your own MCP integrations and switch between different AI models without significant code changes.
28
27
29
-
###MCP client-server architecture
28
+
## MCP client-server architecture
30
29
31
30
MCP uses a client-server architecture that enables an AI-powered app (the host) to connect to multiple MCP servers through MCP clients:
32
31
33
-
-**MCP Hosts**: AI tools, code editors, or other software that enhance their AI models using contextual resources through MCP. For example, GitHub Copilot in Visual Studio Code can act as an MCP host and use MCP clients and servers to expand its capabilities.
34
-
-**MCP Clients**: Clients used by the host application to connect to MCP servers to retrieve contextual data.
35
-
-**MCP Servers**: Services that expose capabilities to clients through MCP. For example, an MCP server might provide an abstraction over a REST API or local data source to provide business data to the AI model.
32
+
-**MCP hosts**: AI tools, code editors, or other software that enhance their AI models using contextual resources through MCP. For example, GitHub Copilot in Visual Studio Code can act as an MCP host and use MCP clients and servers to expand its capabilities.
33
+
-**MCP clients**: Clients used by the host application to connect to MCP servers to retrieve contextual data.
34
+
-**MCP servers**: Services that expose capabilities to clients through MCP. For example, an MCP server might provide an abstraction over a REST API or local data source to provide business data to the AI model.
36
35
37
36
The following diagram illustrates this architecture:
38
37
39
38
:::image type="content" source="media/mcp/model-context-protocol-architecture-diagram.png" alt-text="A diagram showing the architecture pattern of MCP, including hosts, clients, and servers.":::
40
39
41
40
MCP client and server can exchange a set of standard messages:
|`InitializeRequest`| This request is sent by the client to the server when it first connects, asking it to begin initialization. |
46
-
|`ListToolsRequest`|Sent by the client to request a list of tools the server has.|
47
-
|`CallToolRequest`|Used by the client to invoke a tool provided by the server.|
48
-
|`ListResourcesRequest`| Sent by the client to request a list of available server resources.|
49
-
|`ReadResourceRequest`| Sent by the client to the server to read a specific resource URI.|
50
-
|`ListPromptsRequest`| Sent by the client to request a list of available prompts and prompt templates from the server. |
51
-
|`GetPromptRequest`| Used by the client to get a prompt provided by the server.|
52
-
|`PingRequest`| A ping, issued by either the server or the client, to check that the other party is still alive.|
53
-
|`CreateMessageRequest`| A request by the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.|
54
-
|`SetLevelRequest`| A request by the client to the server, to enable or adjust logging.|
45
+
|`ListToolsRequest`|Sent by the client to request a list of tools the server has. |
46
+
|`CallToolRequest`|Used by the client to invoke a tool provided by the server. |
47
+
|`ListResourcesRequest`| Sent by the client to request a list of available server resources. |
48
+
|`ReadResourceRequest`| Sent by the client to the server to read a specific resource URI. |
49
+
|`ListPromptsRequest`| Sent by the client to request a list of available prompts and prompt templates from the server. |
50
+
|`GetPromptRequest`| Used by the client to get a prompt provided by the server. |
51
+
|`PingRequest`| A ping, issued by either the server or the client, to check that the other party is still alive. |
52
+
|`CreateMessageRequest`| A request by the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it. |
53
+
|`SetLevelRequest`| A request by the client to the server, to enable or adjust logging. |
55
54
56
55
## Develop with the MCP C# SDK
57
56
@@ -74,25 +73,22 @@ Instead of building unique connectors for each integration point, you can often
74
73
75
74
The MCP C# SDK depends on the [Microsoft.Extensions.AI libraries](/dotnet/ai/ai-extensions) to handle various AI interactions and tasks. These extension libraries provides core types and abstractions for working with AI services, so developers can focus on coding against conceptual AI capabilities rather than specific platforms or provider implementations.
76
75
77
-
View the MCP C# SDK dependencies on the [NuGet package page](https://www.nuget.org/packages/ModelContextProtocol/0.1.0-preview.11).
76
+
View the MCP C# SDK dependencies on the [NuGet package page](https://www.nuget.org/packages/ModelContextProtocol).
78
77
79
78
## More .NET MCP development resources
80
79
81
80
Various tools, services, and learning resources are available in the .NET and Azure ecosystems to help you build MCP clients and servers or integrate with existing MCP servers.
82
81
83
82
Get started with the following development tools:
84
83
85
-
-[Semantic Kernel](/semantic-kernel/concepts/plugins/adding-mcp-plugins) allows you to add plugins for MCP servers. Semantic Kernel supports both local MCP servers through standard I/O and remote servers that connect through SSE over HTTPS.
84
+
-[Agent Framework](/agent-framework/user-guide/model-context-protocol/using-mcp-tools) supports integration with MCP servers, allowing your agents to access external tools and services. Agent Framework works with the official MCP C# SDK to enable agents to connect to MCP servers, retrieve available tools, and use them through function calling to extend agent capabilities with external data sources and services.
86
85
-[Azure Functions remote MCP servers](https://devblogs.microsoft.com/dotnet/build-mcp-remote-servers-with-azure-functions/) combine MCP standards with the flexible architecture of Azure Functions. Visit the [Remote MCP functions sample repository](https://aka.ms/cadotnet/mcp/functions/remote-sample) for code examples.
87
86
-[Azure MCP Server](https://github.com/Azure/azure-mcp) implements the MCP specification to seamlessly connect AI agents with key Azure services like Azure Storage, Cosmos DB, and more.
88
87
89
-
Learn more about .NET and MCP using these resources:
-[Microsoft partners with Anthropic to create official C# SDK for Model Context Protocol](https://devblogs.microsoft.com/blog/microsoft-partners-with-anthropic-to-create-official-c-sdk-for-model-context-protocol)
92
94
-[Build a Model Context Protocol (MCP) server in C#](https://devblogs.microsoft.com/dotnet/build-a-model-context-protocol-mcp-server-in-csharp/)
0 commit comments