Skip to content

Fix the docs and make the more readable #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 12, 2025
Merged

Fix the docs and make the more readable #281

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2ec2e8d
Fix the docs and make the more readable
MikeAlhayek Apr 11, 2025
6488637
Undo some changes and address styling preference
MikeAlhayek Apr 12, 2025
6418ccb
Merge branch 'main' into ma/make-docs-readable
MikeAlhayek Apr 12, 2025
aefd250
Undo one a missed item
MikeAlhayek Apr 12, 2025
4a7dd07
Apply suggestions from code review
stephentoub Apr 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To get started writing a client, the `McpClientFactory.CreateAsync` method is us
to a server. Once you have an `IMcpClient`, you can interact with it, such as to enumerate all available tools and invoke tools.

```csharp
var clientTransport = new StdioClientTransport(new()
var clientTransport = new StdioClientTransport(new StdioClientTransportOptions
{
Name = "Everything",
Command = "npx",
Expand Down Expand Up @@ -163,10 +163,10 @@ using System.Text.Json;

McpServerOptions options = new()
{
ServerInfo = new() { Name = "MyServer", Version = "1.0.0" },
Capabilities = new()
ServerInfo = new Implementation() { Name = "MyServer", Version = "1.0.0" },
Capabilities = new ServerCapabilities()
{
Tools = new()
Tools = new ToolsCapability()
{
ListToolsHandler = (request, cancellationToken) =>
Task.FromResult(new ListToolsResult()
Expand Down Expand Up @@ -199,7 +199,7 @@ McpServerOptions options = new()
{
if (request.Params.Arguments?.TryGetValue("message", out var message) is not true)
{
throw new McpServerException("Missing required argument 'message'");
throw new McpException("Missing required argument 'message'");
}

return Task.FromResult(new CallToolResponse()
Expand All @@ -208,7 +208,7 @@ McpServerOptions options = new()
});
}

throw new McpServerException($"Unknown tool: '{request.Params?.Name}'");
throw new McpException($"Unknown tool: '{request.Params?.Name}'");
},
}
},
Expand Down