-
Notifications
You must be signed in to change notification settings - Fork 605
Document MCP Server project template in README #1148
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
Open
leslierichardson95
wants to merge
1
commit into
modelcontextprotocol:main
Choose a base branch
from
leslierichardson95:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+4
−0
Open
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -88,6 +88,10 @@ var response = await chatClient.GetResponseAsync( | |||||
|
|
||||||
| ## Getting Started (Server) | ||||||
|
|
||||||
| ### MCP Server Project Template | ||||||
|
|
||||||
| You can create your own MCP server by using the MCP Server project template. This template will set you up with a working MCP server containing a random number tool that returns a random number between a specified min and max value. This template also lets you select an MCP transport type (stdio or http) and it will confgure the MCP Server based on that choice. To learn more about the template, read this MS Learn doc on [creating minimal MCP servers](https://learn.microsoft.com/en-us/dotnet/ai/quickstarts/build-mcp-server). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Typo
Suggested change
|
||||||
|
|
||||||
| Here is an example of how to create an MCP server and register all tools from the current application. | ||||||
| It includes a simple echo tool as an example (this is included in the same file here for easy of copy and paste, but it needn't be in the same file... | ||||||
| the employed overload of `WithTools` examines the current assembly for classes with the `McpServerToolType` attribute, and registers all methods with the | ||||||
|
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should put the content after this paragraph in another subsection to more clearly separate the "project template" documentation from the usage examples.
Or we could:
Tip
You can use the MCP Server project template to quickly get started with creating your own MCP server.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the tip block suggestion!