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 Remote StreamNative MCP Server exposes a wide catalog of tools. Clients can use HTTP headers to authenticate, bind root sessions to an organization, request read-only behavior, and narrow the tool catalog. Administrators can use the StreamNative Cloud Console to enable MCP access and set the maximum tool catalog.
Send these headers to a root, organization, or cluster endpoint. See Remote MCP Access for endpoint construction details.

Header reference

HeaderDescription
AuthorizationSet to Bearer <token> for authenticated MCP requests. The token can be an OAuth 2.1 access token or a service account API key. For non-interactive clients, use an API Key v2.
X-OrganizationOptional organization hint for the root /mcp endpoint and root OAuth discovery. Use it when the organization is not present in the URL. The value must be a single organization path segment. If both the token and header provide an organization, they must match. If no header is supplied for an interactive root OAuth flow, the sign-in flow can prompt the user to select an organization.
X-MCP-ReadonlyRequests read-only behavior. Accepted true values are true, 1, and yes. If the server access mode is Read-Only, mutations are blocked even when this header is omitted. False or omitted values cannot bypass a Read-Only server access mode.
X-MCP-FeaturesComma-separated list of feature identifiers that narrows the tool catalog. Values are trimmed and case-insensitive. The header also controls MCP resources, such as Pulsar resource paths, when the selected features expose resources.

How feature selection works

  • When X-MCP-Features is omitted, the server uses the configured default tool set. Pulsar and organization sessions default broadly; Kafka sessions default to Kafka-compatible tools.
  • If an administrator configured an allowed-tools list in the Console, the list acts as an allow list. X-MCP-Features can request only a subset of that allow list.
  • Unsupported feature IDs cause the request to fail when the endpoint has an explicit allow list. Without an allow list, the server falls back to defaults.
  • Kafka cluster sessions normalize broad requests such as all to Kafka-compatible features. Pulsar-only features requested on Kafka cluster endpoints are ignored; if none of the requested features apply, the request fails.
  • Organization-level sessions use StreamNative Cloud features such as streamnative-cloud, sncloud_context, sncloud_clusters, and sncloud_identity. Pulsar or Kafka tools are added only after sncloud_context_use_cluster selects a cluster.
  • Dynamic functions-as-tools and agents-as-tools run only on fixed Pulsar cluster endpoints. They are not added after a root or organization session selects a cluster with sncloud_context_use_cluster.
  • Start with a minimal feature list to reduce token usage and improve tool selection accuracy.

Available feature identifiers

Use these values inside the X-MCP-Features header. Separate multiple values with commas.

Combination feature sets

Feature IDDescription
allEnables every available capability across StreamNative Cloud, Pulsar, and Kafka.
all-pulsarIncludes Pulsar tooling features.
pulsarAlias for all-pulsar.
all-kafkaIncludes Kafka tooling features.
kafkaAlias for all-kafka.

Kafka tooling

Feature IDDescription
kafka-adminKafka administration tools, including topics, partitions, and consumer groups.
kafka-clientKafka produce and consume tools.
kafka-admin-schema-registrySchema Registry tools.
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.

Pulsar tooling

Feature IDAliasDescription
pulsar-adminPulsar administration tools.
pulsar-clientPulsar produce and consume tools.
pulsar-admin-topicstopicsTopic administration.
pulsar-admin-namespacesnamespacesNamespace administration.
pulsar-admin-tenantstenantsTenant administration.
pulsar-admin-brokersbrokersBroker information.
pulsar-admin-brokers-statusbrokers-statusBroker status.
pulsar-admin-broker-statsbroker-statsBroker statistics.
pulsar-admin-clustersclustersPulsar cluster metadata.
pulsar-admin-functionsfunctionsPulsar Functions administration.
pulsar-admin-functions-workerfunctions-workerFunctions worker status.
pulsar-admin-sinkssinksPulsar IO sinks.
pulsar-admin-sourcessourcesPulsar IO sources.
pulsar-admin-namespace-policynamespace-policyNamespace policies.
pulsar-admin-ns-isolation-policyns-isolationNamespace isolation policies.
pulsar-admin-packagespackagesPulsar packages.
pulsar-admin-resource-quotasresource-quotasResource quotas.
pulsar-admin-schemasschemasTopic schemas.
pulsar-admin-subscriptionssubscriptionsTopic subscriptions.
pulsar-admin-topic-policytopic-policyTopic-level policies.

StreamNative Cloud tooling

Feature IDAliasDescription
streamnative-cloudcloudAll StreamNative Cloud organization tool families.
sncloud_contextsncloud-contextOrganization context, cluster discovery, and in-session cluster switching.
sncloud_byocsncloud-byocBYOC resources, including CloudConnection, CloudEnvironment, Volume, and PoolMember.
sncloud_identitysncloud-identityIdentity and RBAC resources, including User, ServiceAccount, ServiceAccountBinding, Role, RoleBinding, OIDCProvider, and IdentityPool.
sncloud_clusterssncloud-clustersInstance and cluster resources, including Instance, PulsarInstance, PulsarCluster, PulsarGateway, and KafkaCluster.
sncloud_workspacessncloud-workspacesWorkspace resources.
sncloud_resource_catalog and sncloud_resource_schema are helper tools for the BYOC, identity, clusters, and workspaces feature families. They are included when you enable a domain feature that needs schema-guided manifest authoring. For root and organization-level tool workflows, see Root and Organization-Level Tools.

Dynamic tooling

Feature IDAliasDescription
functions-as-toolsExposes eligible Pulsar Functions as callable MCP tools on fixed Pulsar cluster sessions.
agents-as-toolsagents, agent-functionsAccepted 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.

Examples

Bind root OAuth discovery to an organization:
X-Organization: o-sndev
Enable only StreamNative Cloud context tools on a root or organization endpoint:
X-MCP-Features: sncloud_context
Enable Pulsar topic administration and Pulsar client tools on a fixed Pulsar cluster endpoint:
X-MCP-Features: pulsar-admin-topics,pulsar-client
Enable dynamic Pulsar Function and Orca agent tools on a fixed Pulsar cluster endpoint:
X-MCP-Features: pulsar-admin-functions,functions-as-tools
Request read-only behavior from a read/write-enabled endpoint:
X-MCP-Readonly: true
Use API Key v2 for a non-interactive organization session:
Authorization: Bearer <api-key-v2>
X-MCP-Features: sncloud_context,sncloud_clusters