-
Notifications
You must be signed in to change notification settings - Fork 37
[codex] Rename MCP catalog to integrations #266
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Migration Guide | ||
|
|
||
| ## MCP catalog to integration catalog | ||
|
|
||
| This package version is still `0.0.0`, and the MCP catalog was an experimental | ||
| pre-release API. This migration intentionally removes the old MCP-only export | ||
| paths and names instead of keeping deprecated aliases. | ||
|
|
||
| ### Import paths and symbols | ||
|
|
||
| Before: | ||
|
|
||
| ```js | ||
| import { MCP_CATALOG } from "@openhands/extensions/mcps"; | ||
| import { MCP_LOGOS } from "@openhands/extensions/mcps/logos"; | ||
| ``` | ||
|
|
||
| After: | ||
|
|
||
| ```js | ||
| import { INTEGRATION_CATALOG } from "@openhands/extensions/integrations"; | ||
| import { INTEGRATION_LOGOS } from "@openhands/extensions/integrations/logos"; | ||
| ``` | ||
|
|
||
| TypeScript consumers should replace `McpCatalogEntry` with | ||
| `IntegrationCatalogEntry`. | ||
|
|
||
| ### Catalog entries | ||
|
|
||
| Before, MCP entries exposed a single `template`: | ||
|
|
||
| ```js | ||
| const template = entry.template; | ||
| ``` | ||
|
|
||
| After, integrations expose one or more `connectionOptions`: | ||
|
|
||
| ```js | ||
| const option = | ||
| entry.connectionOptions.find( | ||
| (candidate) => candidate.id === entry.defaultConnectionOptionId, | ||
| ) ?? entry.connectionOptions[0]; | ||
| ``` | ||
|
|
||
| MCP-backed options use `provider: "mcp"` and include their transport details. | ||
| Other integration types can use the same catalog entry shape without pretending | ||
| to be MCP servers. | ||
|
|
||
| ### Automation entries | ||
|
|
||
| Automation templates now refer to integrations, not MCP-only records: | ||
|
|
||
| ```diff | ||
| - requiredMcpIds | ||
| + requiredIntegrationIds | ||
| ``` | ||
|
|
||
| ### Deprecation timeline | ||
|
|
||
| There is no deprecation window for the old `mcps` exports. They were removed in | ||
| this PR because downstream consumers are being updated in the same coordinated | ||
| change and the API had not been treated as stable. |
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
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
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,9 +1,17 @@ | ||
| export { MCP_CATALOG } from "./mcps/index.js"; | ||
| export type { | ||
| McpCatalogEntry, | ||
| MarketplaceField, | ||
| MarketplaceFieldType, | ||
| MarketplaceTemplate, | ||
| } from "./mcps/index.js"; | ||
| export { | ||
| INTEGRATION_CATALOG, | ||
| type IntegrationAuthConfig, | ||
| type IntegrationAuthStrategy, | ||
| type IntegrationCatalogEntry, | ||
| type IntegrationConnectionOption, | ||
| type IntegrationHttpConfig, | ||
| type IntegrationOAuthConfig, | ||
| type IntegrationProvider, | ||
| type IntegrationTransport, | ||
| type MarketplaceField, | ||
| type MarketplaceFieldType, | ||
| type OAuthProviderCatalogOption, | ||
| type OAuthProviderRegistrationDefaults, | ||
| } from "./integrations/index.js"; | ||
| export { AUTOMATION_CATALOG } from "./automations/index.js"; | ||
| export type { RecommendedAutomation } from "./automations/index.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 |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| export { MCP_CATALOG } from "./mcps/index.js"; | ||
| export { INTEGRATION_CATALOG } from "./integrations/index.js"; | ||
| export { AUTOMATION_CATALOG } from "./automations/index.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,39 @@ | ||
| # Integration catalog | ||
|
|
||
| This directory contains curated integration metadata for OpenHands clients. | ||
| Most current entries are MCP-backed, but the schema also supports HTTP/OpenAPI | ||
| integrations so clients can consume one source of truth. | ||
|
|
||
| - `catalog/*.json` contains one source file per direct integration entry. | ||
| - `index.js` assembles and exports the catalog for Node.js and bundlers. | ||
| - `index.d.ts` contains the public TypeScript shape. | ||
|
|
||
| Consumers can import the package export: | ||
|
|
||
| ```js | ||
| import { INTEGRATION_CATALOG } from "@openhands/extensions/integrations"; | ||
| ``` | ||
|
|
||
| ## Migration from the MCP catalog | ||
|
|
||
| This catalog replaces the experimental `@openhands/extensions/mcps` export. | ||
| The MCP-only `mcps/` directory has been renamed to `integrations/`, and the | ||
| old package exports were removed rather than kept as aliases. | ||
|
|
||
| - Import `INTEGRATION_CATALOG` from `@openhands/extensions/integrations` | ||
| instead of `MCP_CATALOG` from `@openhands/extensions/mcps`. | ||
| - Import logo mappings from `@openhands/extensions/integrations/logos` | ||
| instead of `@openhands/extensions/mcps/logos`. | ||
| - Use `IntegrationCatalogEntry` instead of `McpCatalogEntry`. | ||
| - Read MCP configuration from `entry.connectionOptions[]`. Direct MCP entries | ||
| have `provider: "mcp"` and a `transport`; entries may expose multiple | ||
| options such as `id: "oauth"` for a hosted OAuth MCP endpoint and `id: | ||
| "api"` for an API-key or stdio fallback. | ||
| - Use `entry.defaultConnectionOptionId` to choose the preferred option. | ||
| - Automation catalog entries now use `requiredIntegrationIds` instead of | ||
| `requiredMcpIds`. | ||
|
|
||
| The `mcps` API was intentionally broken because it was pre-release and had not | ||
| been adopted as a stable public surface. | ||
|
|
||
| The catalog intentionally stores only serializable data. Client applications are responsible for mapping entries to UI-specific icons or styling. |
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,42 @@ | ||
| { | ||
| "id": "airtable", | ||
| "name": "Airtable", | ||
| "description": "List bases, query records, and update fields across your Airtable workspace.", | ||
| "docsUrl": "https://github.com/domdomegg/airtable-mcp-server", | ||
| "iconBg": "#FCB400", | ||
| "iconColor": "var(--oh-surface-deep)", | ||
| "keywords": [ | ||
| "spreadsheet", | ||
| "database", | ||
| "records", | ||
| "bases" | ||
| ], | ||
| "kind": "mcp", | ||
| "defaultConnectionOptionId": "api", | ||
| "connectionOptions": [ | ||
| { | ||
| "id": "api", | ||
| "provider": "mcp", | ||
| "transport": { | ||
| "kind": "stdio", | ||
| "serverName": "airtable", | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "airtable-mcp-server" | ||
| ], | ||
| "envFields": [ | ||
| { | ||
| "key": "AIRTABLE_API_KEY", | ||
| "label": "Airtable personal access token", | ||
| "type": "password", | ||
| "required": true | ||
| } | ||
| ] | ||
| }, | ||
| "auth": { | ||
| "strategy": "api_key" | ||
| } | ||
| } | ||
| ] | ||
| } |
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,41 @@ | ||
| { | ||
| "id": "apify", | ||
| "name": "Apify Actors", | ||
| "description": "Run any of Apify's 5,000+ Actors (scrapers, automations) from the agent.", | ||
| "docsUrl": "https://docs.apify.com/platform/integrations/mcp", | ||
| "iconBg": "#10b981", | ||
| "keywords": [ | ||
| "scraping", | ||
| "automation", | ||
| "crawl", | ||
| "actors" | ||
| ], | ||
| "kind": "mcp", | ||
| "defaultConnectionOptionId": "api", | ||
| "connectionOptions": [ | ||
| { | ||
| "id": "api", | ||
| "provider": "mcp", | ||
| "transport": { | ||
| "kind": "stdio", | ||
| "serverName": "apify", | ||
| "command": "npx", | ||
| "args": [ | ||
| "-y", | ||
| "@apify/actors-mcp-server" | ||
| ], | ||
| "envFields": [ | ||
| { | ||
| "key": "APIFY_TOKEN", | ||
| "label": "Apify token", | ||
| "type": "password", | ||
| "required": true | ||
| } | ||
| ] | ||
| }, | ||
| "auth": { | ||
| "strategy": "api_key" | ||
| } | ||
| } | ||
| ] | ||
| } |
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,31 @@ | ||
| { | ||
| "id": "atlassian", | ||
| "name": "Atlassian (Jira & Confluence)", | ||
| "description": "Search Jira issues and Confluence pages via Atlassian's hosted MCP server.", | ||
| "docsUrl": "https://www.atlassian.com/platform/remote-mcp-server", | ||
| "iconBg": "#0052CC", | ||
| "keywords": [ | ||
| "jira", | ||
| "confluence", | ||
| "tickets", | ||
| "wiki", | ||
| "issues" | ||
| ], | ||
| "kind": "mcp", | ||
| "defaultConnectionOptionId": "none", | ||
| "connectionOptions": [ | ||
| { | ||
| "id": "none", | ||
| "provider": "mcp", | ||
| "transport": { | ||
| "kind": "sse", | ||
| "url": "https://mcp.atlassian.com/v1/sse", | ||
| "apiKeyOptional": true | ||
| }, | ||
| "auth": { | ||
| "strategy": "none", | ||
| "apiKeyOptional": true | ||
| } | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
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.
🟠 Important: Breaking change -
MCP_CATALOGrenamed toINTEGRATION_CATALOG.Downstream consumers using
import { MCP_CATALOG } from '@openhands/extensions'will break. Consider:Example migration:
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.
Uh oh! There was an unexpected error starting the job :(