Skip to content

Commit 1aee5bb

Browse files
Fix more broken links
1 parent 2b13474 commit 1aee5bb

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/ModelContextProtocol/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,21 @@ The official C# SDK for the [Model Context Protocol](https://modelcontextprotoco
1010
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.
1111

1212
For more information about MCP:
13+
1314
- [Official Documentation](https://modelcontextprotocol.io/)
1415
- [Protocol Specification](https://spec.modelcontextprotocol.io/)
1516
- [GitHub Organization](https://github.com/modelcontextprotocol)
1617

1718
## Getting Started (Client)
1819

1920
Then create a client and start using tools, or other capabilities, from the servers you configure:
21+
2022
```csharp
2123
McpClientOptions options = new()
2224
{
2325
ClientInfo = new() { Name = "TestClient", Version = "1.0.0" }
2426
};
25-
27+
2628
McpServerConfig config = new()
2729
{
2830
Id = "everything",
@@ -34,7 +36,7 @@ McpServerConfig config = new()
3436
["arguments"] = "-y @modelcontextprotocol/server-everything",
3537
}
3638
};
37-
39+
3840
var client = await McpClientFactory.CreateAsync(config, options);
3941

4042
// Print the list of tools available from the server.
@@ -57,13 +59,14 @@ Note that you should pass CancellationToken objects suitable for your use case,
5759

5860
It is also highly recommended that you pass a proper LoggerFactory instance to the factory constructor, to enable logging of MCP client operations.
5961

60-
You can find samples demonstrating how to use ModelContextProtocol with an LLM SDK in the [samples](samples) directory, and also refer to the [IntegrationTests](test/ModelContextProtocol.IntegrationTests) project for more examples.
62+
You can find samples demonstrating how to use ModelContextProtocol with an LLM SDK in the [samples](https://github.com/modelcontextprotocol/csharp-sdk/tree/main/samples) directory, and also refer to the [tests](https://github.com/modelcontextprotocol/csharp-sdk/tree/main/tests/ModelContextProtocol.Tests) project for more examples.
6163

6264
Additional examples and documentation will be added as in the near future.
6365

6466
Remember you can connect to any MCP server, not just ones created using ModelContextProtocol. The protocol is designed to be server-agnostic, so you can use this library to connect to any compliant server.
6567

6668
Tools can be exposed easily as `AIFunction` instances so that they are immediately usable with `IChatClient`s.
69+
6770
```csharp
6871
// Get available functions.
6972
IList<AIFunction> tools = await client.GetAIFunctionsAsync();
@@ -107,6 +110,7 @@ public static class EchoTool
107110
```
108111

109112
More control is also available, with fine-grained control over configuring the server and how it should handle client requests. For example:
113+
110114
```csharp
111115
using ModelContextProtocol.Protocol.Transport;
112116
using ModelContextProtocol.Protocol.Types;
@@ -174,4 +178,4 @@ await Task.Delay(Timeout.Infinite);
174178

175179
## License
176180

177-
This project is licensed under the [MIT License](LICENSE).
181+
This project is licensed under the [MIT License](https://github.com/modelcontextprotocol/csharp-sdk/blob/main/LICENSE).

0 commit comments

Comments
 (0)