Add Best practices for Custom MCP Tools #34
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a "Best practices for Custom MCP Tools" section to both the English and Japanese READMEs to provide guidance on error handling, asynchronous processing, and the usage of MCPInspector.
- Removed outdated asynchronous examples using UniTask.
- Added new guidelines and code examples for error handling and asynchronous processing using Task.
- Updated both the English (README.md) and Japanese (README.ja.md) documentation files.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Added a best practices section with new examples for error handling and asynchronous processing. |
| README.ja.md | Introduced translated best practices similar to the English readme. |
Comments suppressed due to low confidence (1)
README.md:195
- Consider using 'Task' as the return type instead of 'async void' to ensure exceptions can be properly propagated and handled.
public async void ErrorMethod()
| } | ||
| ``` | ||
|
|
||
| #### Asynchonous Processing |
There was a problem hiding this comment.
Correct the heading spelling from 'Asynchonous Processing' to 'Asynchronous Processing'.
Suggested change
| #### Asynchonous Processing | |
| #### Asynchronous Processing |
| } | ||
| ``` | ||
|
|
||
| #### Asynchonous Processing |
There was a problem hiding this comment.
Correct the heading spelling from 'Asynchonous Processing' to 'Asynchronous Processing'.
Suggested change
| #### Asynchonous Processing | |
| #### Asynchronous Processing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.