Skip to content

Commit aa2f8f4

Browse files
authored
Improve docs landing page (#1114)
1 parent 8316aa0 commit aa2f8f4

File tree

4 files changed

+23
-5
lines changed

4 files changed

+23
-5
lines changed

docs/concepts/elicitation/elicitation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ uid: elicitation
1010
The **elicitation** feature allows servers to request additional information from users during interactions. This enables more dynamic and interactive AI experiences, making it easier to gather necessary context before executing tasks.
1111

1212
The protocol supports two modes of elicitation:
13-
- **Form (In-Band)**: The server requests structured data (strings, numbers, booleans, enums) which the client collects via a form interface and returns to the server.
14-
- **URL Mode**: The server provides a URL for the user to visit (e.g., for OAuth, payments, or sensitive data entry). The interaction happens outside the MCP client.
13+
14+
- **Form (In-Band)**: The server requests structured data (strings, numbers, Booleans, enums) which the client collects via a form interface and returns to the server.
15+
- **URL Mode**: The server provides a URL for the user to visit (for example, for OAuth, payments, or sensitive data entry). The interaction happens outside the MCP client.
1516

1617
### Server Support for Elicitation
1718

@@ -208,6 +209,7 @@ await using var completionHandler = client.RegisterNotificationHandler(
208209
```
209210

210211
This pattern is particularly useful for:
212+
211213
- **Third-party OAuth flows**: When the MCP server needs to obtain tokens from external services on behalf of the user
212214
- **Payment processing**: When user confirmation is required through a secure payment interface
213215
- **Sensitive credential collection**: When API keys or other secrets must be entered directly on a trusted server page rather than through the MCP client

docs/concepts/httpcontext/httpcontext.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ uid: httpcontext
88
## HTTP Context
99

1010
When using the Streamable HTTP transport, an MCP server might need to access the underlying [HttpContext] for a request.
11-
The [HttpContext] contains request metadata such as the HTTP headers, authorization context, and the actual path and query string for the request.
11+
The [HttpContext] object contains request metadata such as the HTTP headers, authorization context, and the actual path and query string for the request.
1212

1313
To access the [HttpContext], the MCP server should add the [IHttpContextAccessor] service to the application service collection (typically in Program.cs).
1414
Then any classes, for example, a class containing MCP tools, should accept an [IHttpContextAccessor] in their constructor and store this for use by its methods.

docs/concepts/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
# Conceptual documentation
12

23
Welcome to the conceptual documentation for the Model Context Protocol SDK. Here you'll find high-level overviews, explanations, and guides to help you understand how the SDK implements the Model Context Protocol.
4+
5+
## Contents
6+
7+
| Title | Description |
8+
| - | - |
9+
| [Progress tracking](progress/progress.md) | Learn how to track progress for long-running operations through notification messages. |
10+
| [Elicitation](elicitation/elicitation.md) | Learn how to request additional information from users during interactions. |
11+
| [Logging](logging/logging.md) | Learn how to implement logging in MCP servers and how clients can consume log messages. |
12+
| [HTTP Context](httpcontext/httpcontext.md) | Learn how to access the underlying `HttpContext` for a request. |
13+
| [MCP Server Handler Filters](filters.md) | Learn how to add filters to the handler pipeline. Filters let you wrap the original handler with additional functionality. |

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,20 @@ _layout: landing
44

55
# Overview
66

7-
The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. For more details on available functionality, please see the [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html).
7+
This SDK is the official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers.
8+
9+
For more details on available functionality, see:
10+
11+
- [Conceptual documentation](https://modelcontextprotocol.github.io/csharp-sdk/concepts/index.html)
12+
- [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html).
813

914
## About MCP
1015

1116
The Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It enables secure integration between LLMs and various data sources and tools.
1217

1318
For more information about MCP:
1419

15-
- [Official Documentation](https://modelcontextprotocol.io/)
20+
- [Official MCP Documentation](https://modelcontextprotocol.io/)
1621
- [Protocol Specification](https://modelcontextprotocol.io/specification/)
1722
- [GitHub Organization](https://github.com/modelcontextprotocol)
1823

0 commit comments

Comments
 (0)