Skip to content

Commit 25e8020

Browse files
authored
update README (#21)
Update the README for easier rampup
1 parent 1168783 commit 25e8020

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you want to access to your StreamNative Cloud, you will need to have followin
5656

5757
```bash
5858
# Start MCP server with StreamNative Cloud authentication
59-
snmcp stdio --organization my-org --key-file /path/to/key-file.json
59+
bin/snmcp stdio --organization my-org --key-file /path/to/key-file.json
6060

6161
# Start MCP server with external Kafka
6262
bin/snmcp stdio --use-external-kafka --kafka-bootstrap-servers localhost:9092 --kafka-auth-type SASL_SSL --kafka-auth-mechanism PLAIN --kafka-auth-user user --kafka-auth-pass pass --kafka-use-tls --kafka-schema-registry-url https://sr.local --kafka-schema-registry-auth-user user --kafka-schema-registry-auth-pass pass
@@ -165,7 +165,7 @@ To enable only specific feature sets:
165165

166166
```bash
167167
# Enable only Pulsar client features
168-
snmcp stdio --organization my-org --key-file /path/to/key-file.json --features pulsar-client
168+
bin/snmcp stdio --organization my-org --key-file /path/to/key-file.json --features pulsar-client
169169
```
170170

171171
## Integration with MCP Clients
@@ -176,25 +176,31 @@ This server can be used with any MCP-compatible client, such as:
176176
- Other AI assistants supporting the MCP protocol
177177
- Custom applications built with MCP client libraries
178178

179+
> ⚠️ Reminder: Please ensure you have an active paid plan with your LLM provider to fully utilize the MCP server.
180+
Without it, you may encounter the error: `message will exceed the length limit for this chat`.
181+
182+
179183
### Usage with Claude Desktop
180184

181185
```json
182186
{
183187
"mcpServers": {
184-
"github": {
185-
"command": "snmcp",
188+
"snmcp": {
189+
"command": "${PATH_TO_SNMCP}/bin/snmcp",
186190
"args": [
187191
"stdio",
188192
"--organization",
189-
"my-org",
193+
"${STREAMNATIVE_CLOUD_ORGANIZATION_ID}",
190194
"--key-file",
191-
"/path/to/key-file.json"
192-
],
195+
"${STREAMNATIVE_CLOUD_KEY_FILE}"
196+
]
193197
}
194198
}
195199
}
196200
```
197201

202+
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.
203+
198204
## About Model Context Protocol (MCP)
199205

200206
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:

0 commit comments

Comments
 (0)