-
Notifications
You must be signed in to change notification settings - Fork 578
Tweak the file-based MCP server sample #1019
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.
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
eiriktsarpalis
merged 1 commit into
modelcontextprotocol:main
from
eiriktsarpalis:update-file-based-server
Nov 24, 2025
+19
−24
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,59 @@ | ||
| # 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. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - .NET 10 SDK (RC2 or later) | ||
| - No project file required! | ||
| 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. | ||
|
|
||
| ## Running the Sample | ||
|
|
||
| Simply run the Program.cs file directly: | ||
|
|
||
| ```bash | ||
| dotnet run Program.cs | ||
| ./Program.cs | ||
| ``` | ||
|
|
||
| The server will start and listen for MCP messages on stdin/stdout (stdio transport). | ||
|
|
||
| ### Making it Executable (Unix/Linux/macOS) | ||
| ## Testing the Server | ||
|
|
||
| You can test the server by using `@modelcontextprotocol/inspector`, any stdio-compatible client, or sending JSON-RPC messages to stdin. | ||
|
|
||
| On Unix-like systems, you can make the file executable: | ||
| ### Using the Inspector | ||
|
|
||
| ```bash | ||
| chmod +x Program.cs | ||
| ./Program.cs | ||
| npx @modelcontextprotocol/inspector ./Program.cs | ||
| ``` | ||
|
|
||
| Note: The shebang line uses `/usr/bin/env` to locate `dotnet`, so ensure it's in your PATH. | ||
|
|
||
| ## Testing the Server | ||
| ### Using STDIN | ||
|
|
||
| You can test the server by using `@modelcontextprotocol/inspector`, any stdio-compatible client, or sending JSON-RPC messages to stdin. Here's an example: | ||
| #### Initialize the server | ||
|
|
||
| ### 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"}}}' | dotnet run Program.cs | ||
| 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: | ||
| #### List available tools | ||
|
|
||
| ```bash | ||
| ( | ||
| echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' | ||
| sleep 0.5 | ||
| echo '{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}' | ||
| 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 | ||
| ( | ||
| echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test-client","version":"1.0"}}}' | ||
| sleep 0.5 | ||
| echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"echo","arguments":{"message":"Hello, MCP!"}}}' | ||
| sleep 1 | ||
| ) | dotnet run Program.cs 2>/dev/null | grep '^{' | jq . | ||
| ) | ./Program.cs 2>/dev/null | grep '^{' | jq . | ||
| ``` | ||
|
|
||
| ## Reference | ||
|
|
||
| - [File-Based Programs Tutorial](https://learn.microsoft.com/en-us/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) | ||
| - [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/dotnet/csharp/language-reference/preprocessor-directives#file-based-apps) | ||
| - [Model Context Protocol Specification](https://modelcontextprotocol.io/specification/) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.