Skip to content
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

Add a parsedBody optional parameter #81

Merged
merged 3 commits into from
Dec 9, 2024

Conversation

brn
Copy link
Contributor

@brn brn commented Dec 2, 2024

Motivation and Context

SSEServerTransport requires nodejs IncomingMessage as a first parameter,
but this IncomingMessage need not to be consumed by other body parser middlewares,
because in body-parser, _readableState will be checked and if you already consumed request body, body-parser will be thrown an error.
If you use server framework like fastify, body parser is installed at an initialization timing.

So I'd like to add a third and forth parameter to handlePostMessage to use an already parsed raw body.

How Has This Been Tested?

Yes, link library to real application.

Breaking Changes

No.

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

@brn brn changed the title feat: Add a rawBody optional parameter Add a rawBody optional parameter Dec 3, 2024
Copy link
Member

@jspahrsummers jspahrsummers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Unfortunately, this introduces a fair bit of complexity to the code.

I think a better solution is to exclude the body parsing middleware on the route used for an MCP SSE server. Most frameworks provide a way to do this opt-out—if yours doesn't, it seems like that might a better feature request there, versus trying to reverse the middleware here.

@brn
Copy link
Contributor Author

brn commented Dec 5, 2024

@jspahrsummers

Thanks for review!

I think a better solution is to exclude the body parsing middleware on the route used for an MCP SSE server

I think this is better solution too. But if we try to introduce mcp to already running applications, this makes things complex and I think it's hard to understand why getRawBody throws an error for many users.

this introduces a fair bit of complexity to the code.

I'v made code more simpler by using parsed json body.

@brn brn changed the title Add a rawBody optional parameter Add a rawOrParsedBody optional parameter Dec 5, 2024
@brn brn changed the title Add a rawOrParsedBody optional parameter Add a parsedBody optional parameter Dec 5, 2024
 Please enter the commit message for your changes. Lines starting
Copy link
Member

@jspahrsummers jspahrsummers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems much simpler, thanks!

@jspahrsummers jspahrsummers merged commit 22370be into modelcontextprotocol:main Dec 9, 2024
2 checks passed
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