Skip to content

Commit 4a85ba2

Browse files
committed
Fix CLI help text formatting with newlines
- Add \\b markers in query command docstring for proper list formatting - Add \\b markers in mcp serve command docstring for tools list and examples - Regenerate CLI reference docs
1 parent 2cd2d31 commit 4a85ba2

File tree

3 files changed

+52
-42
lines changed

3 files changed

+52
-42
lines changed

docs/reference/cli.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -72,37 +72,42 @@ Generated from the Click command tree.
7272
Supports conversation threads for multi-turn interactions. Use --thread-id
7373
to continue an existing conversation, or omit it to start a new one.
7474

75+

7576
The agent is automatically selected based on the query:
76-
- Knowledge agent: General Redis questions (no instance)
77-
- Chat agent: Quick questions with a Redis instance
78-
- Triage agent: Full health checks or --triage flag
77+
- Knowledge agent: General Redis questions (no instance)
78+
- Chat agent: Quick questions with a Redis instance
79+
- Triage agent: Full health checks or --triage flag
7980
- worker — Start the background worker.
8081
- mcp — MCP server commands - expose agent capabilities via Model Context Protocol.
8182
- mcp list-tools — List available MCP tools.
8283
- mcp serve — Start the MCP server.
8384

8485
The MCP server exposes the Redis SRE Agent's capabilities to other
85-
MCP-compatible AI agents. Available tools:
86-
87-
- triage: Start a Redis troubleshooting session
88-
- get_task_status: Check if a triage task is complete
89-
- get_thread: Get the full results from a triage
90-
- knowledge_search: Search Redis documentation and runbooks
91-
- list_instances: List configured Redis instances
92-
- create_instance: Register a new Redis instance
93-
86+
MCP-compatible AI agents.
87+
88+

89+
Available tools:
90+
- triage: Start a Redis troubleshooting session
91+
- get_task_status: Check if a triage task is complete
92+
- get_thread: Get the full results from a triage
93+
- knowledge_search: Search Redis documentation and runbooks
94+
- list_instances: List configured Redis instances
95+
- create_instance: Register a new Redis instance
96+
97+

9498
Examples:
95-
96-
# Run in stdio mode (for Claude Desktop local config)
97-
redis-sre-agent mcp serve
98-
99-
# Run in HTTP mode (for Claude remote connector - RECOMMENDED)
100-
redis-sre-agent mcp serve --transport http --port 8081
101-
# Then add in Claude: Settings > Connectors > Add Custom Connector
102-
# URL: http://your-host:8081/mcp
103-
104-
# Run in SSE mode (legacy, for older clients)
105-
redis-sre-agent mcp serve --transport sse --port 8081
99+
# Run in stdio mode (for Claude Desktop local config)
100+
redis-sre-agent mcp serve
101+
102+

103+
# Run in HTTP mode (for Claude remote connector - RECOMMENDED)
104+
redis-sre-agent mcp serve --transport http --port 8081
105+
# Then add in Claude: Settings > Connectors > Add Custom Connector
106+
# URL: http://your-host:8081/mcp
107+
108+

109+
# Run in SSE mode (legacy, for older clients)
110+
redis-sre-agent mcp serve --transport sse --port 8081
106111
- index — RediSearch index management commands.
107112
- index list — List all SRE agent indices and their status.
108113
- index recreate — Drop and recreate RediSearch indices.

redis_sre_agent/cli/mcp.py

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,31 @@ def serve(transport: str, host: str, port: int):
3131
"""Start the MCP server.
3232
3333
The MCP server exposes the Redis SRE Agent's capabilities to other
34-
MCP-compatible AI agents. Available tools:
34+
MCP-compatible AI agents.
3535
36-
- triage: Start a Redis troubleshooting session
37-
- get_task_status: Check if a triage task is complete
38-
- get_thread: Get the full results from a triage
39-
- knowledge_search: Search Redis documentation and runbooks
40-
- list_instances: List configured Redis instances
41-
- create_instance: Register a new Redis instance
36+
\b
37+
Available tools:
38+
- triage: Start a Redis troubleshooting session
39+
- get_task_status: Check if a triage task is complete
40+
- get_thread: Get the full results from a triage
41+
- knowledge_search: Search Redis documentation and runbooks
42+
- list_instances: List configured Redis instances
43+
- create_instance: Register a new Redis instance
4244
45+
\b
4346
Examples:
47+
# Run in stdio mode (for Claude Desktop local config)
48+
redis-sre-agent mcp serve
4449
45-
# Run in stdio mode (for Claude Desktop local config)
46-
redis-sre-agent mcp serve
50+
\b
51+
# Run in HTTP mode (for Claude remote connector - RECOMMENDED)
52+
redis-sre-agent mcp serve --transport http --port 8081
53+
# Then add in Claude: Settings > Connectors > Add Custom Connector
54+
# URL: http://your-host:8081/mcp
4755
48-
# Run in HTTP mode (for Claude remote connector - RECOMMENDED)
49-
redis-sre-agent mcp serve --transport http --port 8081
50-
# Then add in Claude: Settings > Connectors > Add Custom Connector
51-
# URL: http://your-host:8081/mcp
52-
53-
# Run in SSE mode (legacy, for older clients)
54-
redis-sre-agent mcp serve --transport sse --port 8081
56+
\b
57+
# Run in SSE mode (legacy, for older clients)
58+
redis-sre-agent mcp serve --transport sse --port 8081
5559
"""
5660
from redis_sre_agent.mcp_server.server import run_http, run_sse, run_stdio
5761

redis_sre_agent/cli/query.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ def query(query: str, redis_instance_id: Optional[str], thread_id: Optional[str]
3131
Supports conversation threads for multi-turn interactions. Use --thread-id
3232
to continue an existing conversation, or omit it to start a new one.
3333
34+
\b
3435
The agent is automatically selected based on the query:
35-
- Knowledge agent: General Redis questions (no instance)
36-
- Chat agent: Quick questions with a Redis instance
37-
- Triage agent: Full health checks or --triage flag
36+
- Knowledge agent: General Redis questions (no instance)
37+
- Chat agent: Quick questions with a Redis instance
38+
- Triage agent: Full health checks or --triage flag
3839
"""
3940

4041
async def _query():

0 commit comments

Comments
 (0)