feat: export method names as consts #192
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
commit: |
There was a problem hiding this comment.
Pull request overview
This PR exports method name constants to provide a type-safe, stable API for checking MCP UI protocol message methods, replacing the need for brittle Zod schema introspection patterns.
- Adds 14 method name constants (e.g.,
MCP_UI_OPEN_LINK_METHOD,MCP_UI_INITIALIZE_METHOD) for all MCP UI protocol messages - Exports all constants through the main types module for public API access
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/spec.types.ts | Defines 14 method name string constants with comprehensive JSDoc documentation explaining their purpose and usage |
| src/types.ts | Re-exports all method name constants from spec.types.ts to make them available in the public API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
External libraries that want to adhere to the spec (through the official bridge SDK) have to use brittle JS tricks like
event.data.method === McpUiSandboxProxyReadyNotificationSchema.shape.method._def.values[0]. Exporting the method names as constants makes it much easier to extend the spec without fragmentation.