Skip to main content

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 StreamNative MCP Server organizes tools into tool groups. Each group contains related operations that you can enable or disable together. Pulsar, Kafka, and dynamic feature IDs apply to both the Remote MCP Server and the local MCP Server, unless a note states otherwise. StreamNative Cloud organization feature IDs apply to Remote MCP organization-level sessions.

StreamNative Cloud tool groups

Organization-level sessions expose StreamNative Cloud tools for cluster discovery and control-plane resources. For workflow details, see Organization-Level Tools.
Feature IDToolsDescription
streamnative-cloud or cloudAll sncloud_* toolsEnable all StreamNative Cloud organization tool families.
sncloud_context or sncloud-contextsncloud_context_available_clusters, sncloud_context_use_cluster, sncloud_context_resetList MCP-enabled clusters, select a cluster, or reset cluster context. The global identity tool sncloud_context_whoami is always available.
sncloud_byoc or sncloud-byocsncloud_resource_catalog, sncloud_resource_schema, sncloud_byoc_read, sncloud_byoc_writeRead or manage BYOC resources such as CloudConnection, CloudEnvironment, Volume, and PoolMember.
sncloud_identity or sncloud-identitysncloud_resource_catalog, sncloud_resource_schema, sncloud_identity_read, sncloud_identity_writeRead or manage identity and RBAC resources such as User, ServiceAccount, ServiceAccountBinding, Role, RoleBinding, OIDCProvider, and IdentityPool.
sncloud_clusters or sncloud-clusterssncloud_resource_catalog, sncloud_resource_schema, sncloud_clusters_read, sncloud_clusters_writeRead or manage cluster resources such as Instance, PulsarInstance, PulsarCluster, PulsarGateway, and KafkaCluster.
sncloud_workspaces or sncloud-workspacessncloud_resource_catalog, sncloud_resource_schema, sncloud_workspaces_read, sncloud_workspaces_writeRead or manage Workspace resources.
Read tools support list and get. Write tools support apply and delete. Write tools accept manifests as JSON strings and support dry_run=true for validation. Use sncloud_resource_catalog to discover supported kinds, then use sncloud_resource_schema to get summary, example, runtime JSON schema, or selected schema paths before writing manifests. After sncloud_context_use_cluster selects a cluster in a root or organization-level session, sncloud_logs is also available for logs from Functions, Sources, Sinks, and Kafka Connect connectors in the selected cluster. sncloud_logs is cluster-scoped and appears only after cluster selection.

Pulsar tool groups

Pulsar clusters support the following tool groups.
Feature IDAliasDescription
pulsar-adminAll Pulsar administration tool groups.
pulsar-admin-topicstopicsList, create, delete, and inspect Pulsar topics.
pulsar-admin-namespacesnamespacesList and manage Pulsar namespaces.
pulsar-admin-namespace-policynamespace-policyGet and set namespace-level policies such as retention, TTL, backlog, and anti-affinity namespace lists.
pulsar-admin-tenantstenantsList and manage Pulsar tenants.
pulsar-admin-schemasschemasView and manage topic schemas.
pulsar-admin-subscriptionssubscriptionsList and manage topic subscriptions.
pulsar-admin-brokersbrokersList and inspect broker nodes.
pulsar-admin-brokers-statusbrokers-statusRetrieve broker status.
pulsar-admin-broker-statsbroker-statsRetrieve broker-level statistics and metrics.
pulsar-admin-clustersclustersList and inspect Pulsar clusters.
pulsar-admin-functionsfunctionsList, inspect, and manage Pulsar Functions.
pulsar-admin-functions-workerfunctions-workerInspect Functions worker status.
pulsar-admin-ns-isolation-policyns-isolationManage namespace isolation policies.
pulsar-admin-packagespackagesManage Pulsar packages.
pulsar-admin-resource-quotasresource-quotasView and manage resource quotas.
pulsar-admin-sinkssinksList and manage Pulsar IO sinks.
pulsar-admin-sourcessourcesList and manage Pulsar IO sources.
pulsar-admin-topic-policytopic-policyGet and set topic-level policies.
pulsar-clientProduce and consume messages on Pulsar topics.

Kafka tool groups

Kafka clusters support the following tool groups.
Feature IDDescription
kafka-adminManage Kafka topics, partitions, and consumer groups.
kafka-admin-schema-registryManage Schema Registry subjects and schemas.
kafka-clientProduce and consume messages on Kafka topics.
kafka-admin-kafka-connectKafka Connect tools. This feature ID is accepted, but Kafka Connect tools are not exposed on Remote MCP Kafka cluster sessions in the current preview.
Kafka topic, partition, and consumer-group tools are enabled by kafka-admin. There are no separate Remote MCP feature IDs named kafka-admin-topics, kafka-admin-partitions, or kafka-admin-groups.

Combination shortcuts

Use these shortcut IDs to enable multiple tool groups at once.
ShortcutIncludes
allEvery available tool group across Pulsar, Kafka, StreamNative Cloud, and dynamic tools.
all-pulsarPulsar tooling features.
pulsarAlias for all-pulsar.
all-kafkaKafka tooling features.
kafkaAlias for all-kafka.
pulsar-adminAll pulsar-admin-* tool groups.
kafka-adminKafka topic, partition, consumer group, and compatible admin tools.
cloudAlias for streamnative-cloud.
streamnative-cloudStreamNative Cloud organization tool families.

Dynamic tools

In addition to static tool groups, the Remote MCP Server supports dynamic tools that expose your own workloads as MCP tools.
Feature IDDescription
functions-as-toolsExpose Pulsar Functions as callable MCP tools on fixed Pulsar cluster sessions. See Functions as Tools.
agents-as-toolsAccepted dynamic agent-tool feature ID. In the current preview, include functions-as-tools or pulsar-admin-functions when you want to expose eligible Orca agents on fixed Pulsar cluster sessions. See Agents as Tools.
Dynamic tools are available on fixed cluster endpoints. They are not added after selecting a cluster inside an organization-level session with sncloud_context_use_cluster.

Client tool parameter notes

  • Kafka consume tools use group for the Kafka consumer group ID. When group is omitted, the server uses an ephemeral group and cannot read committed offsets.
  • Pulsar consume tools use subscription-name for the subscription. This is the Pulsar equivalent of a durable cursor; do not pass a Kafka group parameter to Pulsar tools.
  • StreamNative Cloud domain read tools use operation=list|get, resource, and optional name. name is required for get.
  • StreamNative Cloud domain write tools use operation=apply|delete, resource, and either manifest for apply or name for delete.
  • StreamNative Cloud write tools use manifest as a JSON string. Do not pass YAML or an object. Use dry_run=true for apply before applying changes.
  • sncloud_logs requires a selected cluster in a root or organization-level session. Use it for logs from Functions, Sources, Sinks, and Kafka Connect connectors.
  • StreamNative Cloud read tools omit status and metadata.managedFields unless you set includeStatus=true or includeManagedFields=true.
  • sncloud_resource_schema defaults to format=summary. Use format=example for an example manifest, format=jsonschema for runtime Kubernetes schema when available, and paths such as spec.broker or spec.clusterRefs to reduce schema size.

Usage tips

  • Start minimal. Enable only the tool groups you need. Fewer tools reduce token usage and help AI agents select the right tool more reliably.
  • Use shortcuts for broad access. If you need all Pulsar tools, use all-pulsar instead of listing each group individually.
  • Match groups to your cluster type. Pulsar tool groups only work on Pulsar clusters, and Kafka tool groups only work on Kafka clusters. Enabling mismatched groups has no effect.
  • Combine groups freely. You can mix StreamNative Cloud, Pulsar, Kafka, and dynamic tool groups. For example, sncloud_context,pulsar-admin-topics,pulsar-client enables cluster discovery, Pulsar topic administration, and Pulsar message operations.
  • Use StreamNative Cloud schema helpers before writes. Call sncloud_resource_catalog, then sncloud_resource_schema, then a read tool, then a write tool with dry_run=true before applying changes.