diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc new file mode 100644 index 0000000000..9318d5dc09 --- /dev/null +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc @@ -0,0 +1,53 @@ += rpk cloud mcp install +:description: Install the local MCP server for Redpanda Cloud configuration. + +// tag::single-source[] +Install the MCP client configuration to connect your AI assistant to the local MCP server for Redpanda Cloud. + +This command generates and installs the necessary configuration files for your MCP client (like Claude Code) to automatically connect to the local MCP server for Redpanda Cloud. The local MCP server provides your AI assistant with tools to manage your Redpanda Cloud account and clusters. + +Supports Claude Desktop and Claude Code. + +== Usage + +[,bash] +---- +rpk cloud mcp install [flags] +---- + +== Examples + +Install configuration for Claude Code: + +[,bash] +---- +rpk cloud mcp install --client claude-code +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--allow-delete |- |Allow delete operations (RPCs). Off by default. + +|--client |string |Name of the MCP client to configure. Supported values: `claude` or `claude-code`. + +|-h, --help |- |Help for install. + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +== Suggested reading + +* xref:ai-agents:mcp/local/quickstart.adoc[] +* xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[] + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc new file mode 100644 index 0000000000..64a0d5ed39 --- /dev/null +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-stdio.adoc @@ -0,0 +1,51 @@ += rpk cloud mcp stdio +:description: Communicate with local MCP server for Redpanda Cloud using the stdio protocol. +// tag::single-source[] + +Communicate with the local MCP server for Redpanda Cloud using the stdio protocol. + +This command provides a direct stdio interface for communicating with the local MCP server for Redpanda Cloud. The local MCP server runs on your machine and provides tools for managing your Redpanda Cloud account and clusters. It's typically used as the transport mechanism when your MCP client is configured to use `rpk` as the stdio server process. + +Most users should use xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[`rpk cloud mcp install`] instead, which automatically configures your MCP client. + +== Usage + +[,bash] +---- +rpk cloud mcp stdio [flags] +---- + +== Examples + +Start the local MCP server for Redpanda Cloud using the stdio protocol: + +[,bash] +---- +rpk cloud mcp stdio +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|--allow-delete |- |Allow delete operations (RPCs). Off by default. + +|-h, --help |- |Help for stdio. + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +== Suggested reading + +* xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[] +* xref:ai-agents:mcp/local/overview.adoc[] + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-mcp.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp.adoc new file mode 100644 index 0000000000..04998de61c --- /dev/null +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp.adoc @@ -0,0 +1,50 @@ += rpk cloud mcp +:description: Manage connections to MCP servers in Redpanda Cloud. +// tag::single-source[] + +Manage connections to the local MCP server for Redpanda Cloud. + +These commands help you connect AI assistants like Claude to the local MCP server for Redpanda Cloud, which runs on your local machine and provides access to your Redpanda Cloud account and clusters. + +== Usage + +[,bash] +---- +rpk cloud mcp [flags] + rpk cloud mcp [command] +---- + +== Subcommands + +[cols="1m,2a"] +|=== +|Command |Description + +|xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-install.adoc[install] |Install the local MCP server for Redpanda Cloud configuration. + +|xref:reference:rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc[stdio] |Communicate with the local MCP server for Redpanda Cloud using the stdio protocol. +|=== + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for mcp. + +|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`. + +|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +== Suggested reading + +* xref:ai-agents:mcp/local/quickstart.adoc[] +* xref:ai-agents:mcp/local/overview.adoc[] + +// end::single-source[]