You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -197,25 +198,31 @@ This server can be used with any MCP-compatible client, such as:
197
198
- Other AI assistants supporting the MCP protocol
198
199
- Custom applications built with MCP client libraries
199
200
201
+
> ⚠️ Reminder: Please ensure you have an active paid plan with your LLM provider to fully utilize the MCP server.
202
+
Without it, you may encounter the error: `message will exceed the length limit for this chat`.
203
+
204
+
200
205
### Usage with Claude Desktop
201
206
202
207
```json
203
208
{
204
209
"mcpServers": {
205
-
"github": {
206
-
"command": "snmcp",
210
+
"snmcp": {
211
+
"command": "${PATH_TO_SNMCP}/bin/snmcp",
207
212
"args": [
208
213
"stdio",
209
214
"--organization",
210
-
"my-org",
215
+
"${STREAMNATIVE_CLOUD_ORGANIZATION_ID}",
211
216
"--key-file",
212
-
"/path/to/key-file.json"
213
-
],
217
+
"${STREAMNATIVE_CLOUD_KEY_FILE}"
218
+
]
214
219
}
215
220
}
216
221
}
217
222
```
218
223
224
+
Please remember to replace `${PATH_TO_SNMCP}` with the actual path to the `snmcp` binary and `${STREAMNATIVE_CLOUD_ORGANIZATION_ID}` and `${STREAMNATIVE_CLOUD_KEY_FILE}` with your StreamNative Cloud organization ID and key file path, respectively.
225
+
219
226
## About Model Context Protocol (MCP)
220
227
221
228
The Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to LLMs. MCP helps build agents and complex workflows on top of LLMs by providing:
contextInformation=`No context is set, use 'sncloud_context_available_clusters' to list the available clusters and 'sncloud_context_use_cluster' to set the context to a specific cluster.
36
+
`
37
+
}
25
38
returnfmt.Sprintf(`StreamNative Cloud MCP Server provides resources and tools for AI agents to interact with StreamNative Cloud resources and services.
- **Concept**: The Data Streaming Engine is the core technology that runs StreamNative Cloud clusters. There are two options: Classic Engine and Ursa Engine.
57
70
- **Classic Engine**: The default engine, based on ZooKeeper and BookKeeper, offering low-latency storage suitable for latency-sensitive workloads. It supports Pulsar, Kafka, and MQTT protocols. For Classic Engine, Pulsar protocol will be the default protocol.
58
-
- **Ursa Engine**: A next-generation engine based on Oxia and object storage (like S3), providing cost-optimized storage for latency-relaxed scenarios. It currently focuses on Kafka protocol support. For Ursa Engine, you can only uses 'kafka-client-*' or 'kafka-admin-*' tools, do not use 'pulsar-client-*' or 'pulsar-admin-*' tools.
71
+
- **Ursa Engine**: A next-generation engine based on Oxia and object storage (like S3), providing cost-optimized storage for latency-relaxed scenarios. It currently focuses on Kafka protocol support. For Ursa Engine, you can only uses 'kafka-client-*' or 'kafka-admin-*' tools, do not use 'pulsar-client-*' or 'pulsar-admin-*' tools on Ursa Engine clusters.
59
72
- **Relationship**: The Data Streaming Engine is associated with an instance, determining how clusters within that instance operate and what features they support.
60
73
61
74
### Protocol-Specific Tools
62
75
- When working with **Pulsar protocol resources**, you should only use 'pulsar-admin-*' or 'pulsar-client-*' tools. Do not use 'kafka-client-*' or 'kafka-admin-*' tools for Pulsar protocol operations.
63
76
- When working with **Kafka protocol resources**, you should only use 'kafka-client-*' or 'kafka-admin-*' tools. Do not use 'pulsar-admin-*' or 'pulsar-client-*' tools for Kafka protocol operations.
64
77
- Using the appropriate protocol-specific tools ensures correct functionality and prevents errors when interacting with different protocol resources.
78
+
- Avoid mixing different protocol tools: When working with a specific protocol (Pulsar or Kafka), consistently use only the tools designated for that protocol throughout your entire workflow. Mixing different protocol tools in the same operation sequence may lead to inconsistent behavior, data format incompatibilities, or authentication issues. Always maintain protocol consistency for reliable and predictable results.
65
79
66
80
### Hierarchical Relationship Summary of Resources
67
81
- **Organization** is the top level, containing all other resources.
0 commit comments