-
Notifications
You must be signed in to change notification settings - Fork 4.6k
docs: standalone mcp apps and apps extension #6791
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3dc32dd
standalone mcp apps
dianed-square 9a4b415
Merge remote-tracking branch 'origin/main' into docs/standalone-mcp-apps
dianed-square f07599c
apps sidebar and extension
dianed-square 7b4cfb8
Update documentation/docs/mcp/apps-mcp.md
dianed-square 0256c08
Update documentation/docs/mcp/apps-mcp.md
dianed-square 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
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
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
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
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,99 @@ | ||
| --- | ||
| title: Apps Extension | ||
| description: Create, manage, and launch custom HTML apps in standalone windows | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import { PlatformExtensionNote } from '@site/src/components/PlatformExtensionNote'; | ||
| import GooseBuiltinInstaller from '@site/src/components/GooseBuiltinInstaller'; | ||
|
|
||
| The Apps extension lets you create, manage, and launch simple custom apps through chat. This feature is ideal for: | ||
| - Quick utilities and tools like calculators and converters | ||
| - Data visualizations like graphs and dashboards | ||
| - Simple games and interactive widgets | ||
|
|
||
| Custom apps are single-file HTML applications with JavaScript, CSS, and HTML (no external dependencies or npm packages). They're exposed as [MCP App resources](/docs/guides/interactive-chat/mcp-ui) that run in standalone, sandboxed windows that you can launch from the `Apps` page or by asking goose in chat. | ||
|
|
||
| You can create, modify, and delete apps through chat without needing to edit files directly. Behind the scenes, the Apps extension stores each app as an HTML file in: | ||
|
|
||
| - **macOS/Linux:** `~/.local/share/goose/apps/` | ||
| - **Windows:** `%APPDATA%\Block\goose\data\apps\` | ||
|
|
||
| ## Configuration | ||
|
|
||
| <PlatformExtensionNote/> | ||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="ui" label="goose Desktop" default> | ||
| <GooseBuiltinInstaller | ||
| extensionName="Apps" | ||
| description="Create and manage custom goose apps through chat. Apps are HTML/CSS/JavaScript and run in sandboxed windows." | ||
| /> | ||
| </TabItem> | ||
| <TabItem value="cli" label="goose CLI"> | ||
|
|
||
| 1. Run the `configure` command: | ||
| ```sh | ||
| goose configure | ||
| ``` | ||
|
|
||
| 2. Choose to `Toggle Extensions` | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Toggle Extensions | ||
| │ | ||
| ◆ Enable extensions: (use "space" to toggle and "enter" to submit) | ||
| // highlight-start | ||
| │ ● apps | ||
| // highlight-end | ||
| └ Extension settings updated successfully | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Example Usage | ||
|
|
||
| Let's ask goose to create a utility app. | ||
|
|
||
| :::info LLM | ||
| Anthropic's Claude Sonnet 4.5 was used for this example. | ||
| ::: | ||
|
|
||
| ### goose Prompt | ||
|
|
||
| > _Create a JSON formatter app_ | ||
|
|
||
| ### goose Output | ||
|
|
||
| :::note Desktop | ||
| I'll create a JSON formatter app for you. This will be a useful tool for formatting, validating, and beautifying JSON data. | ||
|
|
||
| Perfect! I've created a JSON formatter app called "json-beautifier" that should have opened in a new window. | ||
|
|
||
| The app includes: | ||
|
|
||
| ✅ **Input & Output Areas**: Split view with input on the left and formatted output on the right | ||
| ✅ **Format Button**: Prettifies JSON with proper indentation | ||
| ✅ **Minify Button**: Compresses JSON to a single line | ||
| ✅ **Validate Button**: Checks JSON validity and shows errors | ||
| ✅ **Copy Button**: Copies the formatted JSON to clipboard | ||
| ✅ **Clear Button**: Resets everything | ||
| ✅ **Syntax Highlighting**: Color-coded keys, strings, numbers, and booleans | ||
| ✅ **Indentation Options**: Choose between 2 or 4 spaces | ||
| ✅ **Error Display**: Clear error messages in red | ||
| ✅ **Character/Line Count**: Shows statistics about your JSON | ||
| ✅ **Dark Theme**: Modern, easy-on-the-eyes design | ||
|
|
||
| You can paste JSON into the left panel and use the buttons to format, minify, validate, or copy it. The app should be ready to use right away! | ||
| ::: | ||
|
|
||
| ### Results | ||
|
|
||
| Here's what the JSON formatter looks like: | ||
|
|
||
| [](/img/apps-extension-results.png) | ||
|
|
||
| The first iteration of my app looks and works great, but you can just ask goose to add features, change the styling, and more! |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.