Skip to content

Add best practices to MCP docs #22114

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
merged 1 commit into from
Apr 30, 2025
Merged

Add best practices to MCP docs #22114

merged 1 commit into from
Apr 30, 2025

Conversation

dinasaur404
Copy link
Contributor

image

Copy link
Contributor

hyperlint-ai bot commented Apr 30, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Added best practices to the Model Context Protocol (MCP) documentation to enhance user understanding and tool effectiveness.

  • Introduced a section on best practices for MCP tool design and usage.
  • Outlined recommendations for scoped permissions to enhance security.
  • Emphasized the importance of detailed tool descriptions for user clarity.
  • Suggested the use of evaluation tests to track tool performance and improvements.

Modified Files

  • src/content/docs/agents/model-context-protocol/index.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@irvinebroque irvinebroque merged commit bee8c86 into production Apr 30, 2025
10 of 13 checks passed
@irvinebroque irvinebroque deleted the dinasaur404-patch-2 branch April 30, 2025 19:02
GregBrimble pushed a commit that referenced this pull request May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants