Skip to content

Commit 1ebf96c

Browse files
authored
docs: update README (#9)
1 parent d2b56ee commit 1ebf96c

1 file changed

Lines changed: 5 additions & 12 deletions

File tree

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Agent skills that teach any skill-compatible AI agent how to manage StreamNative Cloud resources through StreamNative Cloud remote MCP tools or the `snctl` CLI. Distributed as the `streamnative-agent-skills` plugin. Built to the [agentskills](https://agentskills.io) spec; installable as a Claude Code plugin or as portable skill directories in Cursor, Gemini CLI, OpenCode, Goose, Codex, and more.
44

5-
**At a glance:** 8 domain skills · 55 guided workflows · 36 reference docs · 22 starter YAML manifests · 8 `snctl` smoke walkthroughs · 8 remote MCP smoke walkthroughs · 16 machine-readable smoke specs.
5+
**At a glance:** 7 domain skills · 48 guided workflows · 33 reference docs · 22 starter YAML manifests · 7 `snctl` smoke walkthroughs · 7 remote MCP smoke walkthroughs · 16 machine-readable smoke specs.
66

77
---
88

@@ -60,7 +60,7 @@ Remote MCP cannot cover every local credential flow yet; keep `snctl` available
6060
/plugin install streamnative-agent-skills
6161
```
6262

63-
Registers all eight skills at once. Plugin metadata: [.claude-plugin/plugin.json](./.claude-plugin/plugin.json).
63+
Registers all seven currently documented skills at once. Plugin metadata: [.claude-plugin/plugin.json](./.claude-plugin/plugin.json).
6464

6565
### Other skill-compatible agents
6666

@@ -77,7 +77,7 @@ Copy a single `skills/<skill-name>/` directory into the agent's skills directory
7777

7878
---
7979

80-
## What's inside (the 8 skills)
80+
## What's inside (the 7 skills)
8181

8282
| Skill | Workflows | Covers | Activates on |
8383
|---|---:|---|---|
@@ -88,15 +88,14 @@ Copy a single `skills/<skill-name>/` directory into the agent's skills directory
8888
| [identity](./skills/identity/) | 7 | Users, service accounts, roles, API keys, secrets, OIDC, identity pools | "grant access", "API key", "role binding", "OIDC", "federated login" |
8989
| [pulsar-admin](./skills/pulsar-admin/) | 8 | Tenants, namespaces, topics, subscriptions, Pulsar Functions | "tenant", "namespace", "topic", "produce/consume", "Pulsar function" |
9090
| [kafka-admin](./skills/kafka-admin/) | 7 | Kafka topics, groups, partitions, Schema Registry, Kafka Connect | "Kafka topic", "consumer group", "schema registry", "Kafka Connect" |
91-
| [workspaces](./skills/workspaces/) | 7 | Agent Functions, Pulsar IO sinks/sources, package upload/download | "agent function", "sink", "source", "Pulsar IO", "upload package" |
9291

9392
---
9493

9594
## Features
9695

9796
### Execution bases
9897

99-
- **Remote MCP:** first-class route when agent runtime exposes StreamNative Cloud remote MCP tools. Org-level control-plane uses domain tools such as `sncloud_byoc_read/write`, `sncloud_identity_read/write`, `sncloud_clusters_read/write`, `sncloud_workspaces_read/write`, plus `sncloud_resource_catalog` and `sncloud_resource_schema`. Data-plane admin uses feature-gated Pulsar/Kafka MCP tools after fixed cluster binding or `sncloud_context_use_cluster`; both require cluster-level MCP enabled for the target cluster in StreamNative Cloud UI.
98+
- **Remote MCP:** first-class route when agent runtime exposes StreamNative Cloud remote MCP tools. Org-level control-plane uses domain tools such as `sncloud_byoc_read/write`, `sncloud_identity_read/write`, `sncloud_clusters_read/write`, plus `sncloud_resource_catalog` and `sncloud_resource_schema`. Data-plane admin uses feature-gated Pulsar/Kafka MCP tools after fixed cluster binding or `sncloud_context_use_cluster`; both require cluster-level MCP enabled for the target cluster in StreamNative Cloud UI.
10099
- **`snctl`:** portable fallback route and baseline for local credential/config operations and workflows not exposed by remote MCP.
101100

102101
Remote MCP write tools expect JSON-string manifests and a dry-run-first workflow. Do not use generic `sncloud_resources_*` names; current public contract is domain-scoped.
@@ -120,12 +119,6 @@ Every manageable control-plane resource kind is owned by exactly one skill:
120119
- **Pulsar:** tenants, namespaces, topics (persistent + non-persistent, partitioned + non-partitioned), subscriptions (all 4 types), permissions, Pulsar Functions, produce/consume.
121120
- **Kafka:** topics, consumer groups, partitions, Schema Registry (AVRO / JSON / Protobuf), produce/consume. Kafka Connect is available for PulsarCluster/KSN contexts; direct KafkaCluster contexts may not expose Connect.
122121

123-
### Stream-processing compute
124-
125-
- **Agent Functions** (`snctl agents`) — LLM-backed streaming compute with tool-calling and schema-aware output.
126-
- **Pulsar IO sinks and sources** (`snctl pulsar admin sinks` / `sources`) — connector-based data movement to/from external systems (JDBC, Snowflake, Elasticsearch, S3, Kafka, Debezium CDC, and more).
127-
- **Package management** (`snctl pulsar admin packages`) — upload/list/download/delete archives via `function://<tenant>/<namespace>/<name>@<version>` URLs, referenced by Pulsar Functions, Agent Functions, and connectors.
128-
129122
### Tooling bundled with this repo
130123

131124
- `scripts/install-snctl.sh` — install a pinned `snctl` from the canonical GCS bucket.
@@ -201,7 +194,7 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
201194

202195
- **Plugin:** semver, bumped on any skill change (starts at `0.1.0`).
203196
- **Each skill:** its own `metadata.version` in frontmatter, bumped when that skill's content changes.
204-
- **snctl compatibility:** each skill pins `snctl-min-version` in frontmatter. The current floor is `1.5.0` — aligned with when `snctl context` and `snctl agents` stabilized.
197+
- **snctl compatibility:** each skill pins `snctl-min-version` in frontmatter. The current floor is `1.5.0` — aligned with when `snctl context` stabilized.
205198

206199
---
207200

0 commit comments

Comments
 (0)