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

Fix example for implementing SSE Server in TypeScript #112

Merged

Conversation

tadasant
Copy link
Contributor

@tadasant tadasant commented Jan 16, 2025

Motivation and Context

I was working through implementing an SSE server in TypeScript, and this is the current example:

const server = new Server({
  name: "example-server",
  version: "1.0.0"
}, {
  capabilities: {}
});

const transport = new SSEServerTransport("/message", response);
await server.connect(transport);

It is unclear what response is meant to be here, and this seems to be just the definition for the GET part of the connection (there no mention of transport.handlePostMessage).

The example I've created has close parity with the equivalent Python example (using express as an analog to Starlette).

How Has This Been Tested?

I tested the code while working on my server here by connecting to it with wong2's CLI tool, and trying a request/response successfully.

I've run the docs UI locally with mintlify and it looks well-formatted:

CleanShot 2025-01-16 at 00 55 40@2x

Breaking Changes

None.

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

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.

Thank you very much! This is a great fix. ✨

@jspahrsummers jspahrsummers merged commit 6c610ba into modelcontextprotocol:main Jan 21, 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