diff --git a/apps/docs/content/docs/mcp-server.mdx b/apps/docs/content/docs/mcp-server.mdx index a4a5ab1fafb..2f49adf0578 100644 --- a/apps/docs/content/docs/mcp-server.mdx +++ b/apps/docs/content/docs/mcp-server.mdx @@ -17,6 +17,8 @@ Superset provides an [MCP (Model Context Protocol)](https://modelcontextprotocol |----------|------------| | **Tasks** | list, get (by id or slug), create, update, delete, list statuses | | **Workspaces** | list (per host), create on a host, update, delete | +| **Agents** | list agents on a host, launch an agent session in a workspace | +| **Terminals** | create in a workspace, list, send input, read screen, close | | **Automations** | list, get metadata, get/set prompt body, create, update metadata, pause, resume, run on demand, list runs, delete | | **Projects** | list projects on a host | | **Hosts** | list hosts (registered machines) you have access to | @@ -318,6 +320,10 @@ API keys grant full access to your organization. Keep them secret and never comm | Tool | Description | |------|-------------| | `terminals_create` | Create a terminal session in a workspace, optionally running a command | +| `terminals_list` | List terminal sessions in a workspace | +| `terminals_send` | Write text into a running terminal (presses Enter by default) | +| `terminals_read` | Read the terminal screen as plain text (current screen plus recent scrollback) | +| `terminals_close` | Close a terminal session and kill its process | ### Automations diff --git a/apps/marketing/src/lib/llms.ts b/apps/marketing/src/lib/llms.ts index bff89c5d277..66ee01ca765 100644 --- a/apps/marketing/src/lib/llms.ts +++ b/apps/marketing/src/lib/llms.ts @@ -53,7 +53,7 @@ export function buildDeveloperResourcesSection(): string[] { "", `- [API docs](${docsUrl}/mcp-server): Superset MCP server documentation`, `- [OpenAPI spec](${API_URL}/openapi.json): OpenAPI 3.1 description of the Superset API surface`, - `- [MCP server](${MCP_SERVER_URL}): Model Context Protocol server (Streamable HTTP transport) — 27 tools for tasks, workspaces, agents, automations, terminals, hosts, and projects. Alias: ${API_URL}/mcp`, + `- [MCP server](${MCP_SERVER_URL}): Model Context Protocol server (Streamable HTTP transport) — tools for tasks, workspaces, agents, automations, terminals, hosts, and projects; full catalog in the server card. Alias: ${API_URL}/mcp`, `- [Docs MCP server](${docsUrl}/mcp): search and read the Superset documentation over MCP (Streamable HTTP, no auth)`, `- [MCP server card](${baseUrl}/.well-known/mcp/server-card.json): machine-readable MCP server description`, `- [A2A agent card](${baseUrl}/.well-known/agent-card.json): Agent-to-Agent capability card`, diff --git a/packages/sdk/api.md b/packages/sdk/api.md index d39afbd3425..d6dd308f4f8 100644 --- a/packages/sdk/api.md +++ b/packages/sdk/api.md @@ -96,10 +96,23 @@ Types: - TerminalCreateParams - TerminalCreateResult +- TerminalListParams +- TerminalListResult +- TerminalSummary +- TerminalSendParams +- TerminalSendResult +- TerminalReadParams +- TerminalReadResult +- TerminalCloseParams +- TerminalCloseResult Methods: - client.terminals.create({ hostId, workspaceId, command?, cwd? }) -> TerminalCreateResult +- client.terminals.list({ hostId, workspaceId }) -> TerminalListResult +- client.terminals.send({ hostId, workspaceId, terminalId, text, submit? }) -> TerminalSendResult +- client.terminals.read({ hostId, workspaceId, terminalId, maxLines? }) -> TerminalReadResult +- client.terminals.close({ hostId, workspaceId, terminalId }) -> TerminalCloseResult # Automations