-
Notifications
You must be signed in to change notification settings - Fork 176
feat(mcp-ui): add hook for posting data back to MCP client #812
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
Open
tsck
wants to merge
6
commits into
main
Choose a base branch
from
feat/mcp-ui-data-hook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+473
−2
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
45abd21
feat: add hook for sending data to client
tsck 1ded598
chore: deslop
tsck 4ceaf2b
test: add tests for useUIActions
tsck 7bf7edb
feat: capture parent origin when possible
tsck fad293f
refactor: update host comm hook naming
tsck eb4138d
chore: fix check
tsck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export { useRenderData } from "./useRenderData.js"; | ||
| export { useHostCommunication } from "./useHostCommunication.js"; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import { useCallback, useMemo } from "react"; | ||
|
|
||
| interface SendMessageOptions { | ||
| targetOrigin?: string; | ||
| } | ||
|
|
||
| /** Return type for the useHostCommunication hook */ | ||
| interface UseHostCommunicationResult { | ||
| /** Sends an intent message for the host to act on */ | ||
| intent: <T = unknown>(intent: string, params?: T) => void; | ||
| /** Notifies the host of something that happened */ | ||
| notify: (message: string) => void; | ||
| /** Asks the host to run a prompt */ | ||
| prompt: (prompt: string) => void; | ||
| /** Asks the host to execute a tool */ | ||
| tool: <T = unknown>(toolName: string, params?: T) => void; | ||
| /** Asks the host to navigate to a URL */ | ||
| link: (url: string) => void; | ||
| /** Reports iframe size changes to the host */ | ||
| reportSizeChange: (dimensions: { width?: number; height?: number }) => void; | ||
| } | ||
|
|
||
| /** | ||
| * Hook for sending UI actions to the parent window via postMessage | ||
| * This is used by iframe-based UI components to communicate back to an MCP client | ||
| * | ||
| * @example | ||
| * ```tsx | ||
| * function MyComponent() { | ||
| * const { intent, tool, link } = useHostCommunication(); | ||
| * | ||
| * return <button onClick={() => intent("create-task", { title: "Buy groceries" })}>Create Task</button>; | ||
| * } | ||
| * ``` | ||
| */ | ||
| export function useHostCommunication(defaultOptions?: SendMessageOptions): UseHostCommunicationResult { | ||
| const targetOrigin = defaultOptions?.targetOrigin ?? "*"; | ||
|
|
||
| const intent = useCallback( | ||
| <T = unknown>(intentName: string, params?: T): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "intent", | ||
| payload: { | ||
| intent: intentName, | ||
| params, | ||
| }, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| const notify = useCallback( | ||
| (message: string): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "notify", | ||
| payload: { | ||
| message, | ||
| }, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| const prompt = useCallback( | ||
| (promptText: string): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "prompt", | ||
| payload: { | ||
| prompt: promptText, | ||
| }, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| const tool = useCallback( | ||
| <T = unknown>(toolName: string, params?: T): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "tool", | ||
| payload: { | ||
| toolName, | ||
| params, | ||
| }, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| const link = useCallback( | ||
| (url: string): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "link", | ||
| payload: { | ||
| url, | ||
| }, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| const reportSizeChange = useCallback( | ||
| (dimensions: { width?: number; height?: number }): void => { | ||
| window.parent.postMessage( | ||
| { | ||
| type: "ui-size-change", | ||
| payload: dimensions, | ||
| }, | ||
| targetOrigin | ||
| ); | ||
| }, | ||
| [targetOrigin] | ||
| ); | ||
|
|
||
| return useMemo( | ||
| () => ({ | ||
| intent, | ||
| notify, | ||
| prompt, | ||
| tool, | ||
| link, | ||
| reportSizeChange, | ||
| }), | ||
| [intent, notify, prompt, tool, link, reportSizeChange] | ||
| ); | ||
|
Comment on lines
+129
to
+139
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure this |
||
| } | ||
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
Oops, something went wrong.
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.
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.
are any of these types available from
mcp-ui/server?