Documentation Index
Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt
Use this file to discover all available pages before exploring further.
The Remote StreamNative MCP Server supports root and organization-level sessions in addition to fixed cluster sessions. Use a root or organization-level session when you want an MCP client to discover MCP-enabled clusters, switch cluster context during a session, or manage StreamNative Cloud control-plane resources.
Choose a root or organization endpoint
Use one of the following endpoints:
| Mode | Endpoint | Use case |
|---|
| Root | https://mcp.streamnative.cloud/mcp | Connect without putting the organization in the URL. The server resolves the organization from the AuthV2 audience in your token. For interactive OAuth flows, provide X-Organization or select the organization during sign-in. |
| Organization | https://mcp.streamnative.cloud/mcp/x/<organization> | Bind the session to one organization in the URL. Use this when your client or automation can store one endpoint per organization. |
sncloud_context_whoami is available for the session. Other organization tools are controlled by the organization feature set. Cluster-specific Pulsar, Kafka, and log tools become available only after you select a cluster with sncloud_context_use_cluster.
For a fixed cluster session, use https://mcp.streamnative.cloud/mcp/x/<organization>/<instance>/<cluster>. See Remote MCP Access. Discover and select clusters
Organization-level sessions expose context tools for finding and selecting MCP-enabled clusters.
| Tool | Description |
|---|
sncloud_context_whoami | Show the authenticated StreamNative Cloud identity and current organization context. This tool is global and is not controlled by sncloud_context. |
sncloud_context_available_clusters | List MCP-enabled Pulsar and Kafka clusters in the current organization, including instance name, cluster name, cluster type, access mode, and endpoint. |
sncloud_context_use_cluster | Select a Pulsar or Kafka cluster for the current MCP session. Parameters: instanceName and clusterName. |
sncloud_context_reset | Clear the selected cluster and return to organization-only context. |
sncloud_logs for logs from Functions, Sources, Sinks, and Kafka Connect connectors in the selected cluster. Dynamic tools such as functions-as-tools and agents-as-tools are available on fixed cluster endpoints, but not after in-session cluster switching.
Use StreamNative Cloud prompts
Organization-level sessions also expose StreamNative Cloud prompts that help clients discover and inspect enabled clusters.
| Prompt | Description |
|---|
list-sncloud-clusters | Lists MCP-enabled clusters in the current organization, including the cluster type and endpoint metadata. |
read-sncloud-cluster | Reads one cluster resource. Parameters: name and type. type must be PulsarCluster or KafkaCluster. |
clusterType returned by list-sncloud-clusters when you call read-sncloud-cluster. Disabled or non-exposed clusters aren’t returned.
Manage StreamNative Cloud resources
Organization-level sessions expose domain-scoped tools for StreamNative Cloud resources.
| Feature | Tools | Resources |
|---|
sncloud_byoc | sncloud_byoc_read, sncloud_byoc_write | CloudConnection, CloudEnvironment, Volume, PoolMember |
sncloud_identity | sncloud_identity_read, sncloud_identity_write | User, ServiceAccount, ServiceAccountBinding, Role, RoleBinding, OIDCProvider, IdentityPool |
sncloud_clusters | sncloud_clusters_read, sncloud_clusters_write | Instance, PulsarInstance, PulsarCluster, PulsarGateway, KafkaCluster |
sncloud_workspaces | sncloud_workspaces_read, sncloud_workspaces_write | Workspace |
list and get operations. Write tools support apply and delete operations. get and delete require name. apply requires manifest, a JSON string that contains one StreamNative Cloud resource.
After sncloud_context_use_cluster selects a cluster, the session also exposes sncloud_logs for Functions, Sources, Sinks, and Kafka Connect connectors in the selected cluster.
All domain tool families can use these schema helpers:
| Tool | Description |
|---|
sncloud_resource_catalog | List supported resource kinds for a domain: byoc, clusters, identity, or workspaces. |
sncloud_resource_schema | Return schema guidance for one resource kind. The default summary format is optimized for authoring manifests; example returns an example manifest; jsonschema returns runtime Kubernetes schema when available; all returns summary plus runtime metadata. Use paths such as spec.broker or spec.clusterRefs to keep runtime schema responses small. |
Write operations can change organization-level resources. Use dry_run=true
before applying changes, and keep the Remote MCP access mode set to
Read-Only unless mutation tools are required.
Use the recommended mutation workflow
When you create or update a StreamNative Cloud resource through MCP, use this workflow:
- Call
sncloud_resource_catalog for the resource domain, such as clusters or identity.
- Call
sncloud_resource_schema for the resource type, such as PulsarCluster, KafkaCluster, or ServiceAccount.
- Call the matching read tool to inspect existing resources.
- Compose the resource manifest as a JSON string.
- Call the matching write tool with
operation=apply and dry_run=true.
- Review the validation result.
- Repeat the apply operation with
dry_run=false only when the dry-run result is acceptable.
The manifest argument must be a JSON string. Do not pass YAML or a structured object. Omit status, metadata.managedFields, and other read-only fields copied from read responses. The schema summary is guidance, not a replacement for server-side validation. Runtime OpenAPI schemas do not encode every cross-field or cross-resource constraint.
Use X-MCP-Features to narrow the organization tool catalog. For example, X-MCP-Features: sncloud_context,sncloud_clusters exposes cluster discovery plus cluster-domain resources. If an administrator configured allowed tools for the organization MCP entry, the header can only request a subset of that allow list. If you omit X-MCP-Features, the server uses the configured organization feature set.
| Feature ID | Enables |
|---|
streamnative-cloud or cloud | All StreamNative Cloud organization tool families. |
sncloud_context or sncloud-context | Cluster discovery and context switch tools: sncloud_context_available_clusters, sncloud_context_use_cluster, and sncloud_context_reset. |
sncloud_byoc or sncloud-byoc | BYOC control-plane tools. |
sncloud_identity or sncloud-identity | Identity and RBAC resource tools. |
sncloud_clusters or sncloud-clusters | Instance and cluster resource tools. |
sncloud_workspaces or sncloud-workspaces | Workspace resource tools. |
Manage MCP settings in the Console
Use the StreamNative Cloud Console to manage MCP availability, access mode, and allowed tools for your organization and clusters. The organization settings control root and organization endpoints. Cluster settings control fixed cluster endpoints and cluster tools added after sncloud_context_use_cluster selects a cluster.
