Skip to content

Custom MCP requests + hooks #535

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Custom MCP requests + hooks #535

wants to merge 21 commits into from
+575 −31

Conversation

cmrfrd
Copy link

@cmrfrd cmrfrd commented Apr 17, 2025 •
edited
Loading

Allow users to opt-in to defining custom message types for MCP and server/client side hooks for how to process them.

Motivation and Context

This change allows users to define their own opt-in sub-protocols extending MCP to fit their needs outside the specification. With custom messages, users don't need to fork the MCP sdk's in order to extend the protocol.

Our specific use case for is so we can define sub-protocols for sensitive data transfer (ex: payment information, PII, credentials, etc.) but there are other users that may want to implement their own systems.

How Has This Been Tested?

See examples/custom_requests or updated readme.

Breaking Changes

This feature is opt-in via experimental_capabilities and won't break existing code / configs.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

This PR only applies to the python sdk, so in order to provide this to MCP as a whole, we would need similar PR's for the other MCP sdk's. Consider this implementation a POC, and we can replicate this approach across the other sdks's.

cmrfrd added 21 commits April 15, 2025 07:02
@cmrfrd
new types
6789a60
@cmrfrd
expose new types in __init__.py
f05934d
@cmrfrd
Allow mcp client session to process/send experimental messages
da3e9c4
@cmrfrd
Allow server to send/process experimental messages
6d54581
@cmrfrd
sending method
bfab6df
@cmrfrd
example of adding a custom protocol
d956514
@cmrfrd
update with ttl example
53f4dc0
@cmrfrd
update capability example
c53a4e8
@cmrfrd
Merge branch 'main' into experimental_extensions
98a6eba
@cmrfrd
linting
f391675
@cmrfrd
rename to custom requests
91848c6
@cmrfrd
custom requests must be explicitly exanbled
4ba7aac
@cmrfrd
update example
7e59da9
@cmrfrd
add opt-in to customer requests for client and server to process cust…
0177efe 
…omer requests
@cmrfrd
rename to custom_requests
0a0b59b
@cmrfrd
lint + typefix
9abbadc
@cmrfrd
Change result to result wrapper
f055fa1
@cmrfrd
Update readme with how to define custom requests
1110adf
@cmrfrd
lint missing newline
bf77f42
@cmrfrd
update message
96dcdb2
@cmrfrd
Merge branch 'main' into experimental_extensions
ed2f38a
@cmrfrd cmrfrd changed the title Support custom MCP requests Custom MCP requests + hooks Apr 23, 2025
@ihrpr ihrpr added this to the r-05-25 milestone Apr 29, 2025
@jerome3o-anthropic
Copy link
Contributor

Hey @cmrfrd, love the work here - I think extending the spec is going to be super valuable, and we should make it easy to do in the sdks. However - with the current implementation here it looks like all custom requests will have the jsonrpc method custom/request. Ideally they would be able to have their own method defined at that root level, as opposed to in the params.

For example, in the listed version over the wire we get:

{
    "method": "custom/request",
    "params": {
        "meta": null,
        "inner": {
            "method": "ttl",
            "params": {
                "ttl": 7
            }
        }
    },
    "jsonrpc": "2.0",
    "id": 0
}

But ideally we'd have:

{
     "method": "ttl",
     "params": {
          "ttl": 7
     }
    "jsonrpc": "2.0",
    "id": 0
}

I think we'd need some significant work on this sdk to make this easy to do :/

@merlinarer
Copy link

hello, any progress here? This feature is really important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
r-05-25
Development

Successfully merging this pull request may close these issues.
4 participants
@cmrfrd @jerome3o-anthropic @merlinarer @ihrpr