docs: add MCP server usage documentation by AnassKartit · Pull Request #98 · github/copilot-sdk

AnassKartit · 2026-01-22T20:16:11Z

Summary

This PR adds comprehensive documentation for configuring and using MCP (Model Context Protocol) servers with the Copilot SDK, addressing the request in #36.

Changes

New file: docs/mcp.md - Complete MCP documentation including:
- Overview of MCP and server types (local/stdio vs HTTP/SSE)
- Configuration examples for all 4 SDKs (Node.js, Python, Go, .NET)
- Complete reference table for all configuration options
- Troubleshooting guide for common issues
- Links to related resources
Updated: docs/getting-started.md
- Added link to new MCP docs in the "Connect to MCP Servers" section
- Added MCP docs to the "Learn More" section

References

Closes Add MCP usage documentation #36
Related to Mcp tools usage #9 (original MCP usage question)

Test plan

Verified all code examples match the actual SDK types
Cross-referenced with python/copilot/types.py and nodejs/src/types.ts
Links to external resources verified

Add comprehensive documentation for configuring and using MCP servers with the Copilot SDK across all supported languages (Node.js, Python, Go, .NET). This includes: - Configuration examples for local/stdio and remote HTTP/SSE servers - Complete reference for all configuration options - Troubleshooting guide for common issues - Links to related resources and issues Closes github#36

Copilot

Pull request overview

This PR adds comprehensive documentation for configuring and using MCP (Model Context Protocol) servers with the GitHub Copilot SDK.

Changes:

New documentation file explaining MCP server types, configuration for all 4 SDKs, complete configuration reference, and troubleshooting guidance
Updates to getting-started guide with links to the new MCP documentation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
docs/mcp.md	Comprehensive MCP documentation with examples for Node.js, Python, Go, and .NET SDKs, configuration reference tables, and troubleshooting guide
docs/getting-started.md	Added links to new MCP documentation in the "Connect to MCP Servers" section and "Learn More" section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-22T20:21:23Z

docs/mcp.md

+
+const client = new CopilotClient();
+const session = await client.createSession({
+    model: "gpt-4.1",


The model value "gpt-4.1" is inconsistent with the rest of the codebase and may not be valid. According to the Python SDK types in python/copilot/types.py line 200, valid models are: "gpt-5", "claude-sonnet-4", "claude-sonnet-4.5", "claude-haiku-4.5". The rest of the documentation and examples in this repository use "gpt-5". Consider changing this to "gpt-5" to maintain consistency.

Suggested change

model: "gpt-4.1",

model: "gpt-5",

Copilot · 2026-01-22T20:21:23Z

docs/mcp.md

+    await client.start()
+
+    session = await client.create_session({
+        "model": "gpt-4.1",


The model value "gpt-4.1" is inconsistent with the rest of the codebase and may not be valid. According to the Python SDK types in python/copilot/types.py line 200, valid models are: "gpt-5", "claude-sonnet-4", "claude-sonnet-4.5", "claude-haiku-4.5". The rest of the documentation and examples in this repository use "gpt-5". Consider changing this to "gpt-5" to maintain consistency.

Copilot · 2026-01-22T20:21:24Z

docs/mcp.md

+    defer client.Stop()
+
+    session, err := client.CreateSession(&copilot.SessionConfig{
+        Model: "gpt-4.1",


The model value "gpt-4.1" is inconsistent with the rest of the codebase and may not be valid. According to the Python SDK types in python/copilot/types.py line 200, valid models are: "gpt-5", "claude-sonnet-4", "claude-sonnet-4.5", "claude-haiku-4.5". The rest of the documentation and examples in this repository use "gpt-5". Consider changing this to "gpt-5" to maintain consistency.

Copilot · 2026-01-22T20:21:24Z

docs/mcp.md

+await using var client = new CopilotClient();
+await using var session = await client.CreateSessionAsync(new SessionConfig
+{
+    Model = "gpt-4.1",


The model value "gpt-4.1" is inconsistent with the rest of the codebase and may not be valid. According to the Python SDK types in python/copilot/types.py line 200, valid models are: "gpt-5", "claude-sonnet-4", "claude-sonnet-4.5", "claude-haiku-4.5". The rest of the documentation and examples in this repository use "gpt-5". Consider changing this to "gpt-5" to maintain consistency.

Copilot · 2026-01-22T20:21:24Z

docs/mcp.md

+await using var session = await client.CreateSessionAsync(new SessionConfig
+{
+    Model = "gpt-4.1",
+    McpServers = new Dictionary<string, McpServerConfig>


The type annotation is incorrect. According to the .NET SDK types in dotnet/src/Types.cs line 335, McpServers is defined as Dictionary<string, object>?, not Dictionary<string, McpServerConfig>. The McpServerConfig type doesn't exist in the .NET SDK - instead, the dictionary values should be typed as object to allow either McpLocalServerConfig or McpRemoteServerConfig.

Suggested change

McpServers = new Dictionary<string, McpServerConfig>

McpServers = new Dictionary<string, object>

Added a Quick Start section with a complete, tested example using @modelcontextprotocol/server-filesystem. This provides users with a copy-paste working example they can try immediately.

- Changed 'gpt-4.1' to 'gpt-5' for consistency with codebase - Fixed .NET McpServers type to Dictionary<string, object>

patniko · 2026-01-26T04:28:54Z

Thanks @AnassKartit 🙏 Appreciate you adding this while we work to catch up on docs.

Copilot AI review requested due to automatic review settings January 22, 2026 20:16

AnassKartit requested a review from a team as a code owner January 22, 2026 20:16

Copilot started reviewing on behalf of AnassKartit January 22, 2026 20:16 View session

AnassKartit force-pushed the docs/add-mcp-documentation branch from bd0bd16 to f51aebc Compare January 22, 2026 20:17

Copilot AI reviewed Jan 22, 2026

View reviewed changes

AnassKartit added 2 commits January 22, 2026 21:37

docs: add working filesystem MCP server example

601f4e8

Added a Quick Start section with a complete, tested example using @modelcontextprotocol/server-filesystem. This provides users with a copy-paste working example they can try immediately.

docs: fix model name and .NET type annotation

a78408b

- Changed 'gpt-4.1' to 'gpt-5' for consistency with codebase - Fixed .NET McpServers type to Dictionary<string, object>

AnassKartit force-pushed the docs/add-mcp-documentation branch from 546a77e to a78408b Compare January 22, 2026 20:45

Reorder MCP link

d729a28

patniko approved these changes Jan 26, 2026

View reviewed changes

patniko added this pull request to the merge queue Jan 26, 2026

Merged via the queue into github:main with commit 505b6b5 Jan 26, 2026

friggeri mentioned this pull request Jan 26, 2026

docs: add MCP usage documentation and language specific examples #89

Closed

This was referenced Jan 27, 2026

Bump GitHub.Copilot.SDK from 0.1.18 to 0.1.19 dariuszparys/coralph#44

Merged

Bump GitHub.Copilot.SDK from 0.1.18 to 0.1.19 sikebe-demo/copilot-sdk-playground#48

Merged

Bump GitHub.Copilot.SDK from 0.1.18 to 0.1.20 Glenn-MS/agent-framework#42

Closed

dependabot bot mentioned this pull request Feb 5, 2026

Bump GitHub.Copilot.SDK from 0.1.18 to 0.1.21 Glenn-MS/agent-framework#46

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add MCP server usage documentation#98

docs: add MCP server usage documentation#98
patniko merged 4 commits intogithub:mainfrom
AnassKartit:docs/add-mcp-documentation

AnassKartit commented Jan 22, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

patniko commented Jan 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	McpServers = new Dictionary<string, McpServerConfig>
	McpServers = new Dictionary<string, object>

Conversation

AnassKartit commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

References

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

patniko commented Jan 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AnassKartit commented Jan 22, 2026 •

edited

Loading