Tweak the file-based MCP server sample (#1019)

This commit is contained in:
Eirik Tsarpalis 2025-11-24 16:42:20 +02:00 • committed by GitHub
commit a9427f9f12
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 19 additions and 24 deletions

View file

@ -1,4 +1,4 @@
#!/usr/bin/env -S dotnet run -- #!/usr/bin/env dotnet
#:package Microsoft.Extensions.Hosting #:package Microsoft.Extensions.Hosting
#:project ../../src/ModelContextProtocol/ModelContextProtocol.csproj #:project ../../src/ModelContextProtocol/ModelContextProtocol.csproj

View file

@ -1,64 +1,59 @@
# File-Based MCP Server Sample # File-Based MCP Server Sample
This sample demonstrates how to create a complete MCP (Model Context Protocol) server using .NET 10's file-based programs feature. Unlike traditional .NET projects that require a `.csproj` file, file-based programs allow you to write and run complete applications in a single `.cs` file. This sample demonstrates how to create a complete MCP (Model Context Protocol) server using [.NET 10's file-based programs feature](https://learn.microsoft.com/dotnet/csharp/fundamentals/tutorials/file-based-programs). Unlike traditional .NET projects that require a `.csproj` file, file-based programs allow you to write and run complete applications in a single `.cs` file.
## Requirements
- .NET 10 SDK (RC2 or later)
- No project file required!
## Running the Sample ## Running the Sample
Simply run the Program.cs file directly: Simply run the Program.cs file directly:
```bash ```bash
dotnet run Program.cs ./Program.cs
``` ```
The server will start and listen for MCP messages on stdin/stdout (stdio transport). The server will start and listen for MCP messages on stdin/stdout (stdio transport).
### Making it Executable (Unix/Linux/macOS)
On Unix-like systems, you can make the file executable:
```bash
chmod +x Program.cs
./Program.cs
```
Note: The shebang line uses `/usr/bin/env` to locate `dotnet`, so ensure it's in your PATH.
## Testing the Server ## Testing the Server
You can test the server by using `@modelcontextprotocol/inspector`, any stdio-compatible client, or sending JSON-RPC messages to stdin. Here's an example: You can test the server by using `@modelcontextprotocol/inspector`, any stdio-compatible client, or sending JSON-RPC messages to stdin.
### Using the Inspector
### Initialize the server:
```bash ```bash
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' | dotnet run Program.cs npx @modelcontextprotocol/inspector ./Program.cs
``` ```
### List available tools: ### Using STDIN
#### Initialize the server
```bash
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' | ./Program.cs
```
#### List available tools
```bash ```bash
( (
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}'
sleep 0.5 sleep 0.5
echo '{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}' echo '{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}'
sleep 1 sleep 1
) | dotnet run Program.cs 2>/dev/null | grep '^{' | jq . ) | ./Program.cs 2>/dev/null | grep '^{' | jq .
``` ```
### Call the echo tool: #### Call the echo tool
```bash ```bash
( (
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}'
sleep 0.5 sleep 0.5
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"echo","arguments":{"message":"Hello, MCP!"}}}' echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"echo","arguments":{"message":"Hello, MCP!"}}}'
sleep 1 sleep 1
) | dotnet run Program.cs 2>/dev/null | grep '^{' | jq . ) | ./Program.cs 2>/dev/null | grep '^{' | jq .
``` ```
## Reference ## Reference
- [File-Based Programs Tutorial](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/tutorials/file-based-programs) - [File-Based Programs Tutorial](https://learn.microsoft.com/dotnet/csharp/fundamentals/tutorials/file-based-programs)
- [C# Preprocessor Directives for File-Based Apps](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/preprocessor-directives#file-based-apps) - [C# Preprocessor Directives for File-Based Apps](https://learn.microsoft.com/dotnet/csharp/language-reference/preprocessor-directives#file-based-apps)
- [Model Context Protocol Specification](https://modelcontextprotocol.io/specification/) - [Model Context Protocol Specification](https://modelcontextprotocol.io/specification/)