Skip to content

Commit 79b3497

Browse files
committed
Fix a few issues in the README
1 parent a1b2803 commit 79b3497

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.MD

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCP C# SDK
22

3-
The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications to connect to and interact with MCP clients and servers.
3+
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.
44

55
> [!NOTE]
66
> This repo is still in preview, breaking changes can be introduced without prior notice.
@@ -16,7 +16,9 @@ For more information about MCP:
1616

1717
## Getting Started (Client)
1818

19-
Then create a client and start using tools, or other capabilities, from the servers you configure:
19+
To get started writing a client, the `McpClientFactory.CreateAsync` method is used to instantiate and connect an `IMcpClient`
20+
to a server, with details about the client and server specified in `McpClientOptions` and `McpServerConfig` objects.
21+
Once you have an `IMcpClient`, you can interact with it, such as to enumerate all available tools and invoke tools.
2022
```csharp
2123
McpClientOptions options = new()
2224
{
@@ -53,15 +55,9 @@ var result = await client.CallToolAsync(
5355
Console.WriteLine(result.Content.First(c => c.Type == "text").Text);
5456
```
5557

56-
Note that you should pass CancellationToken objects suitable for your use case, to enable proper error handling, timeouts, etc. This example also does not paginate the tools list, which may be necessary for large tool sets. See the IntegrationTests project for an example of pagination, as well as examples of how to handle Prompts and Resources.
58+
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. Additional examples and documentation will be added as in the near future.
5759

58-
It is also highly recommended that you pass a proper LoggerFactory instance to the factory constructor, to enable logging of MCP client operations.
59-
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.
61-
62-
Additional examples and documentation will be added as in the near future.
63-
64-
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.
60+
Clients can connect to any MCP server, not just ones created using this library. The protocol is designed to be server-agnostic, so you can use this library to connect to any compliant server.
6561

6662
Tools can be exposed easily as `AIFunction` instances so that they are immediately usable with `IChatClient`s.
6763
```csharp

0 commit comments

Comments
 (0)