Skip to content

Commit 91756aa

Browse files
Copilotstephentoub
andcommitted
Consolidate package READMEs into shared src/PACKAGE.md
Replace three individual package README.md files with a single shared PACKAGE.md in the src folder. All three csproj files now reference ../PACKAGE.md and pack it as README.md inside the NuGet package. Also update the top-level README.md to use absolute docs site URLs for the Documentation links since the per-package READMEs no longer exist. Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
1 parent e5ebb50 commit 91756aa

File tree

7 files changed

+9
-65
lines changed

7 files changed

+9
-65
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ The official C# SDK for the [Model Context Protocol](https://modelcontextprotoco
88

99
This SDK consists of three main packages:
1010

11-
- **[ModelContextProtocol.Core](https://www.nuget.org/packages/ModelContextProtocol.Core)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.Core.svg)](https://www.nuget.org/packages/ModelContextProtocol.Core) - For projects that only need to use the client or low-level server APIs and want the minimum number of dependencies. [Documentation](src/ModelContextProtocol.Core/README.md)
11+
- **[ModelContextProtocol.Core](https://www.nuget.org/packages/ModelContextProtocol.Core)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.Core.svg)](https://www.nuget.org/packages/ModelContextProtocol.Core) - For projects that only need to use the client or low-level server APIs and want the minimum number of dependencies. [Documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html)
1212

13-
- **[ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.svg)](https://www.nuget.org/packages/ModelContextProtocol) - The main package with hosting and dependency injection extensions. References `ModelContextProtocol.Core`. This is the right fit for most projects that don't need HTTP server capabilities. [Documentation](src/ModelContextProtocol/README.md)
13+
- **[ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.svg)](https://www.nuget.org/packages/ModelContextProtocol) - The main package with hosting and dependency injection extensions. References `ModelContextProtocol.Core`. This is the right fit for most projects that don't need HTTP server capabilities. [Documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html)
1414

15-
- **[ModelContextProtocol.AspNetCore](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.AspNetCore.svg)](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore) - The library for HTTP-based MCP servers. References `ModelContextProtocol`. [Documentation](src/ModelContextProtocol.AspNetCore/README.md)
15+
- **[ModelContextProtocol.AspNetCore](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.AspNetCore.svg)](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore) - The library for HTTP-based MCP servers. References `ModelContextProtocol`. [Documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.AspNetCore.html)
1616

1717
## Getting Started
1818

src/ModelContextProtocol.AspNetCore/ModelContextProtocol.AspNetCore.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</ItemGroup>
1818

1919
<ItemGroup>
20-
<None Include="README.md" pack="true" PackagePath="\" />
20+
<None Include="..\PACKAGE.md" Pack="true" PackagePath="\README.md" />
2121
</ItemGroup>
2222

2323
<ItemGroup>

src/ModelContextProtocol.AspNetCore/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

src/ModelContextProtocol.Core/ModelContextProtocol.Core.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
</ItemGroup>
7474

7575
<ItemGroup>
76-
<None Include="README.md" pack="true" PackagePath="\" />
76+
<None Include="..\PACKAGE.md" Pack="true" PackagePath="\README.md" />
7777
</ItemGroup>
7878

7979
</Project>

src/ModelContextProtocol.Core/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

src/ModelContextProtocol/ModelContextProtocol.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</ItemGroup>
3232

3333
<ItemGroup>
34-
<None Include="README.md" pack="true" PackagePath="\" />
34+
<None Include="..\PACKAGE.md" Pack="true" PackagePath="\README.md" />
3535
</ItemGroup>
3636

3737
</Project>
Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.svg)](https://www.nuget.org/packages/ModelContextProtocol)
44

5-
The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), with hosting and dependency injection extensions. References `ModelContextProtocol.Core`. Please visit the [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html) for more details on available functionality.
5+
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. Please visit the [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html) for more details on available functionality.
66

77
## Packages
88

@@ -14,16 +14,12 @@ This SDK consists of three main packages:
1414

1515
- **[ModelContextProtocol.AspNetCore](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore)** [![NuGet version](https://img.shields.io/nuget/v/ModelContextProtocol.AspNetCore.svg)](https://www.nuget.org/packages/ModelContextProtocol.AspNetCore) - The library for HTTP-based MCP servers. References `ModelContextProtocol`. [Documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.AspNetCore.html)
1616

17-
## Installation
18-
19-
```
20-
dotnet add package ModelContextProtocol
21-
```
22-
2317
## Getting Started
2418

2519
To get started, see the [Getting Started](https://modelcontextprotocol.github.io/csharp-sdk/concepts/getting-started.html) guide for installation instructions, package-selection guidance, and complete examples for both clients and servers.
2620

21+
You can also browse the [samples](https://github.com/modelcontextprotocol/csharp-sdk/tree/main/samples) directory and the [API documentation](https://modelcontextprotocol.github.io/csharp-sdk/api/ModelContextProtocol.html) for more details on available functionality.
22+
2723
## About MCP
2824

2925
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.

0 commit comments

Comments
 (0)