-
Notifications
You must be signed in to change notification settings - Fork 10.3k
MCP Server basics #20934
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
MCP Server basics #20934
Conversation
| M->>C: MCP access token | ||
| ``` | ||
|
|
||
| Read the docs for the [Workers oAuth Provider Library](/agents/model-context-protocol/mcp-server/authorization/oauth-provider-api-reference/) for more details. |
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.
Identified issues
- Vale Style Guide - (Terms-error) Use 'OAuth' instead of 'oAuth'.
Proposed fix
| Read the docs for the [Workers oAuth Provider Library](/agents/model-context-protocol/mcp-server/authorization/oauth-provider-api-reference/) for more details. | |
| Read the docs for the [Workers OAuth Provider Library](/agents/model-context-protocol/mcp-server/authorization/oauth-provider-api-reference/) for more details. |
The term 'oAuth' should be capitalized as 'OAuth' to comply with the style guide. This change is outside of any code references or URLs, so it's appropriate to make this correction.
|
|
||
| ### (3) Bring your own OAuth Provider | ||
|
|
||
| If your application already implements an Oauth Provider itself, or you use Stytch, Auth0, or authorization-as-a-service provider, you can use this in the same way that you would use a third-party OAuth provider, described above in (2). |
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.
Identified issues
- Vale Style Guide - (Terms-error) Use 'OAuth' instead of 'Oauth'.
Proposed fix
| If your application already implements an Oauth Provider itself, or you use Stytch, Auth0, or authorization-as-a-service provider, you can use this in the same way that you would use a third-party OAuth provider, described above in (2). | |
| If your application already implements an OAuth Provider itself, or you use Stytch, Auth0, or authorization-as-a-service provider, you can use this in the same way that you would use a third-party OAuth provider, described above in (2). |
I corrected the capitalization of 'Oauth' to 'OAuth' as per the style guide recommendation. This change does not affect any code references or URLs.
|
|
||
| For example, the following code defines a simple MCP server that adds two numbers together: | ||
|
|
||
| {/* TODO: Reference code in Github, link to a runnable example, use Deploy to Workers button */} |
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.
Identified issues
- Vale Style Guide - (Terms-error) Use 'GitHub' instead of 'Github'.
Proposed fix
| {/* TODO: Reference code in Github, link to a runnable example, use Deploy to Workers button */} | |
| {/* TODO: Reference code in GitHub, link to a runnable example, use Deploy to Workers button */} |
I corrected the capitalization of 'Github' to 'GitHub' as it was a straightforward capitalization issue not within any restricted context.
| * Define public methods on your Worker that can be called by other Workers on the same Cloudflare account, via [Service Bindings](/workers/runtime-apis/bindings/service-bindings/rpc) | ||
| * Define public methods on [Durable Objects](/durable-objects) that can be called by other workers on the same Cloudflare account that declare a binding to it. | ||
| - Define public methods on your Worker that can be called by other Workers on the same Cloudflare account, via [Service Bindings](/workers/runtime-apis/bindings/service-bindings/rpc) | ||
| - Define public methods on [Durable Objects](/durable-objects) that can be called by other workers on the same Cloudflare account that declare a binding to it. |
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.
Identified issues
- Vale Style Guide - (Terms-error) Use 'Workers' instead of 'workers'.
Proposed fix
| - Define public methods on [Durable Objects](/durable-objects) that can be called by other workers on the same Cloudflare account that declare a binding to it. | |
| - Define public methods on [Durable Objects](/durable-objects) that can be called by other Workers on the same Cloudflare account that declare a binding to it. |
I capitalized 'Workers' as per the style guide recommendation. This change does not affect any code references or special syntax.
|
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 SummaryIntroduced the Model Context Protocol (MCP) server documentation with comprehensive guides and examples.
Modified Files
Added Files
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 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 What is Hyperlint?Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation. |
You don't have to re-deploy after adding secrets. But we should tell you to connect to your remote MCP server
* Update MCP server documentation with improved Claude Desktop connection section * Add page for how to test your remote mcp server * Apply suggestions from code review * Simplify the section that explains testing with Claude Desktop And link to newly created section in the docs --------- Co-authored-by: Brendan Irvine-Broque <[email protected]>
d0b7804 to
ba3a8bf
Compare
|
@rita3ko see changes |
* Scaffolding * Scaffolding * Start to add and structure content * Reference MCP tools in RPC docs * Basic tools docs * Add note to tools docs * More details * Scaffolding out authorization docs * More updates * Scaffold out a few more things * Move content to overview, link to workers-mcp instead * Start adding next steps after initial getting started * Remove JSRPC tools, replace with standard sdk * Pared down MCP docs * Complete docs for GitHub auth * Remove RPC content * Small updates * URL structure * More fixes * updates * Add link to MCP at top * Fix broken links * Fix broken links * Fix one more link * Replace with cloudflare/workers-oauth-provider * Remove extra deploy step at the end of GitHub instructions You don't have to re-deploy after adding secrets. But we should tell you to connect to your remote MCP server * update links * Omit Slack example * Add instructions for Oauth proxy (#20967) * Update MCP server documentation with improved Claude Desktop connection section * Add page for how to test your remote mcp server * Apply suggestions from code review * Simplify the section that explains testing with Claude Desktop And link to newly created section in the docs --------- Co-authored-by: Brendan Irvine-Broque <[email protected]> * Fix broken link * Restructure docs to keep things within guides * Redirects, broken links from structure changes * Use <TypeScriptCode> block * Fix broken link * fix broken link --------- Co-authored-by: dinasaur404 <[email protected]>
Replaces #20860 for now, smaller scope.
refs cloudflare/ai#10 and other incoming PRs to
cloudflare/aidemos.workers-mcpuntil APIs land there and we update readme