Skip to content

Commit 2ece9d5

Browse files
fix: update MCP CLI commands in documentation (#1976)
* fix: update MCP CLI commands in documentation Replace list-tools with tools command in README and examples Update cli_tools_example.sh with correct CLI commands Update test file comments to reflect actual CLI commands Remove references to non-existent pagination flags and search subcommands Fixes #1970 Co-authored-by: praisonai-triage-agent[bot] <praisonai-triage-agent[bot]@users.noreply.github.com> * fix: correct MCP CLI commands in documentation to match actual implementation - Replace non-existent commands (describe, sync, list) with actual working commands (list-tools, tools search/info/schema) - Fix README.md to document commands that exist in MCPServerCLI.handle() - Fix cli_tools_example.sh to use working CLI commands - Fix test docstrings to accurately describe what is being tested Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com> --------- Co-authored-by: praisonai-triage-agent[bot] <272766704+praisonai-triage-agent[bot]@users.noreply.github.com> Co-authored-by: praisonai-triage-agent[bot] <praisonai-triage-agent[bot]@users.noreply.github.com> Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
1 parent b025d19 commit 2ece9d5

3 files changed

Lines changed: 42 additions & 42 deletions

File tree

src/praisonai/examples/mcp/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,25 @@ python tool_annotations_example.py
3232

3333
### 3. CLI Tools (`cli_tools_example.sh`)
3434

35-
Demonstrates the new CLI commands:
35+
Demonstrates the CLI commands:
3636

3737
```bash
38-
# List tools with pagination
39-
praisonai mcp list-tools --limit 10
40-
praisonai mcp list-tools --cursor <cursor> --json
38+
# List all available MCP tools
39+
praisonai mcp list-tools
40+
praisonai mcp list-tools --json
4141

42-
# Search tools
43-
praisonai mcp tools search "query"
44-
praisonai mcp tools search --category memory
45-
praisonai mcp tools search --read-only
46-
praisonai mcp tools search --json
42+
# Search for specific tools
43+
praisonai mcp tools search "memory"
44+
praisonai mcp tools search --category file
4745

48-
# Get tool info
46+
# Get detailed tool information
4947
praisonai mcp tools info <tool-name>
50-
praisonai mcp tools info <tool-name> --json
5148

52-
# Get tool schema
49+
# Get tool JSON schema
5350
praisonai mcp tools schema <tool-name>
51+
52+
# List all tools (alias)
53+
praisonai mcp tools list
5454
```
5555

5656
## API Reference

src/praisonai/examples/mcp/cli_tools_example.sh

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#!/bin/bash
22
# MCP CLI Tools Examples
33
#
4-
# Demonstrates the new CLI commands for MCP tool management:
5-
# - praisonai mcp tools search
6-
# - praisonai mcp tools info
7-
# - praisonai mcp tools schema
8-
# - praisonai mcp list-tools (with pagination)
4+
# Demonstrates the CLI commands for MCP tool management:
5+
# - praisonai mcp list-tools (list all tools)
6+
# - praisonai mcp tools search (search tools)
7+
# - praisonai mcp tools info (show tool details)
8+
# - praisonai mcp tools schema (show tool schema)
99
#
1010
# Usage:
1111
# chmod +x cli_tools_example.sh
@@ -17,34 +17,34 @@ echo "MCP Protocol Version: 2025-11-25"
1717
echo "========================================"
1818

1919
echo ""
20-
echo "--- List Tools (with pagination) ---"
21-
echo "Command: praisonai mcp list-tools --limit 5"
22-
praisonai mcp list-tools --limit 5
20+
echo "--- List All Tools ---"
21+
echo "Command: praisonai mcp list-tools"
22+
praisonai mcp list-tools
2323

2424
echo ""
2525
echo "--- List Tools (JSON output) ---"
26-
echo "Command: praisonai mcp list-tools --json --limit 3"
27-
praisonai mcp list-tools --json --limit 3
26+
echo "Command: praisonai mcp list-tools --json"
27+
praisonai mcp list-tools --json
2828

2929
echo ""
30-
echo "--- Tools Help ---"
31-
echo "Command: praisonai mcp tools --help"
32-
praisonai mcp tools --help
30+
echo "--- Search Tools ---"
31+
echo "Command: praisonai mcp tools search 'memory'"
32+
praisonai mcp tools search "memory"
3333

3434
echo ""
35-
echo "--- Search Tools ---"
36-
echo "Command: praisonai mcp tools search 'workflow'"
37-
praisonai mcp tools search "workflow"
35+
echo "--- List Tools via tools command ---"
36+
echo "Command: praisonai mcp tools list"
37+
praisonai mcp tools list
3838

3939
echo ""
40-
echo "--- Search Read-Only Tools ---"
41-
echo "Command: praisonai mcp tools search --read-only"
42-
praisonai mcp tools search --read-only
40+
echo "--- Tools Help ---"
41+
echo "Command: praisonai mcp tools help"
42+
praisonai mcp tools help
4343

4444
echo ""
45-
echo "--- Search with JSON Output ---"
46-
echo "Command: praisonai mcp tools search 'memory' --json"
47-
praisonai mcp tools search "memory" --json
45+
echo "--- MCP Help ---"
46+
echo "Command: praisonai mcp --help"
47+
praisonai mcp --help
4848

4949
echo ""
5050
echo "========================================"

src/praisonai/tests/unit/mcp/test_mcp_cli.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
"""
22
Unit tests for MCP CLI commands.
33
4-
Tests the new CLI commands:
5-
- praisonai mcp tools search
6-
- praisonai mcp tools info
7-
- praisonai mcp tools schema
8-
- praisonai mcp list-tools (with pagination)
4+
Tests the CLI commands:
5+
- praisonai mcp list-tools (list tools)
6+
- praisonai mcp tools search (search tools)
7+
- praisonai mcp tools info (show tool details)
8+
- praisonai mcp tools schema (show tool schema)
99
"""
1010

1111
import json
@@ -203,12 +203,12 @@ def test_schema_tool_not_found(self, mock_get_registry, mock_register, capsys):
203203

204204

205205
class TestListToolsCLI:
206-
"""Test list-tools CLI command with pagination."""
206+
"""Test mcp list-tools CLI command."""
207207

208208
@patch("praisonai.mcp_server.adapters.register_all_tools")
209209
@patch("praisonai.mcp_server.registry.get_tool_registry")
210210
def test_list_tools_json(self, mock_get_registry, mock_register, capsys):
211-
"""Test list-tools with JSON output."""
211+
"""Test mcp list-tools with JSON output."""
212212
mock_registry = MagicMock()
213213
mock_registry.list_paginated.return_value = (
214214
[{"name": "tool1"}, {"name": "tool2"}],
@@ -228,7 +228,7 @@ def test_list_tools_json(self, mock_get_registry, mock_register, capsys):
228228
@patch("praisonai.mcp_server.adapters.register_all_tools")
229229
@patch("praisonai.mcp_server.registry.get_tool_registry")
230230
def test_list_tools_with_cursor(self, mock_get_registry, mock_register):
231-
"""Test list-tools with pagination cursor."""
231+
"""Test mcp list-tools with pagination cursor."""
232232
mock_registry = MagicMock()
233233
mock_registry.list_paginated.return_value = ([], None)
234234
mock_registry.list_all.return_value = []

0 commit comments

Comments
 (0)