-
Notifications
You must be signed in to change notification settings - Fork 2.2k
fix: correct mcp-cli skill command syntax and add installation guide #617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AungMyoKyaw
wants to merge
1
commit into
github:main
Choose a base branch
from
AungMyoKyaw:fix/mcp-cli-skill-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−19
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,30 +1,71 @@ | ||||||||
| --- | ||||||||
| name: mcp-cli | ||||||||
| description: Interface for MCP (Model Context Protocol) servers via CLI. Use when you need to interact with external tools, APIs, or data sources through MCP servers, list available MCP servers/tools, or call MCP tools from command line. | ||||||||
| homepage: https://github.com/philschmid/mcp-cli | ||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For this we should use the
Suggested change
|
||||||||
| --- | ||||||||
|
|
||||||||
| # MCP-CLI | ||||||||
|
|
||||||||
| Access MCP servers through the command line. MCP enables interaction with external systems like GitHub, filesystems, databases, and APIs. | ||||||||
|
|
||||||||
| **Homepage:** https://github.com/philschmid/mcp-cli | ||||||||
|
|
||||||||
| ## Prerequisites | ||||||||
|
|
||||||||
| ### Installation | ||||||||
|
|
||||||||
| ```bash | ||||||||
| # Quick install (recommended) | ||||||||
| curl -fsSL https://raw.githubusercontent.com/philschmid/mcp-cli/main/install.sh | bash | ||||||||
|
|
||||||||
| # Or install with Bun (requires Bun) | ||||||||
| bun install -g https://github.com/philschmid/mcp-cli | ||||||||
|
|
||||||||
| # Verify installation | ||||||||
| mcp-cli --version | ||||||||
| ``` | ||||||||
|
|
||||||||
| ### Configuration | ||||||||
|
|
||||||||
| Create `mcp_servers.json` in your current directory or `~/.config/mcp/`: | ||||||||
|
|
||||||||
| ```json | ||||||||
| { | ||||||||
| "mcpServers": { | ||||||||
| "filesystem": { | ||||||||
| "command": "npx", | ||||||||
| "args": ["-y", "@modelcontextprotocol/server-filesystem", "."] | ||||||||
| }, | ||||||||
| "github": { | ||||||||
| "command": "npx", | ||||||||
| "args": ["-y", "@modelcontextprotocol/server-github"] | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
| ``` | ||||||||
|
|
||||||||
| **Documentation:** https://github.com/philschmid/mcp-cli | ||||||||
|
|
||||||||
| ## Commands | ||||||||
|
|
||||||||
| | Command | Output | | ||||||||
| | ---------------------------------- | ------------------------------- | | ||||||||
| | `mcp-cli` | List all servers and tool names | | ||||||||
| | `mcp-cli <server>` | Show tools with parameters | | ||||||||
| | `mcp-cli <server>/<tool>` | Get tool JSON schema | | ||||||||
| | `mcp-cli <server>/<tool> '<json>'` | Call tool with arguments | | ||||||||
| | `mcp-cli grep "<glob>"` | Search tools by name | | ||||||||
| | Command | Output | | ||||||||
| | --------------------------------------- | ------------------------------- | | ||||||||
| | `mcp-cli` | List all servers and tool names | | ||||||||
| | `mcp-cli info <server>` | Show tools with parameters | | ||||||||
| | `mcp-cli info <server> <tool>` | Get tool JSON schema | | ||||||||
| | `mcp-cli call <server> <tool> '<json>'` | Call tool with arguments | | ||||||||
| | `mcp-cli grep "<glob>"` | Search tools by name | | ||||||||
|
|
||||||||
| **Both formats work:** `info <server> <tool>` or `info <server>/<tool>` | ||||||||
|
|
||||||||
| **Add `-d` to include descriptions** (e.g., `mcp-cli filesystem -d`) | ||||||||
| **Add `-d` to include descriptions** (e.g., `mcp-cli info filesystem -d`) | ||||||||
|
|
||||||||
| ## Workflow | ||||||||
|
|
||||||||
| 1. **Discover**: `mcp-cli` → see available servers and tools | ||||||||
| 2. **Explore**: `mcp-cli <server>` → see tools with parameters | ||||||||
| 3. **Inspect**: `mcp-cli <server>/<tool>` → get full JSON input schema | ||||||||
| 4. **Execute**: `mcp-cli <server>/<tool> '<json>'` → run with arguments | ||||||||
| 2. **Explore**: `mcp-cli info <server>` → see tools with parameters | ||||||||
| 3. **Inspect**: `mcp-cli info <server> <tool>` → get full JSON input schema | ||||||||
| 4. **Execute**: `mcp-cli call <server> <tool> '<json>'` → run with arguments | ||||||||
|
|
||||||||
| ## Examples | ||||||||
|
|
||||||||
|
|
@@ -33,33 +74,33 @@ Access MCP servers through the command line. MCP enables interaction with extern | |||||||
| mcp-cli | ||||||||
|
|
||||||||
| # See all tools with parameters | ||||||||
| mcp-cli filesystem | ||||||||
| mcp-cli info filesystem | ||||||||
|
|
||||||||
| # With descriptions (more verbose) | ||||||||
| mcp-cli filesystem -d | ||||||||
| mcp-cli info filesystem -d | ||||||||
|
|
||||||||
| # Get JSON schema for specific tool | ||||||||
| mcp-cli filesystem/read_file | ||||||||
| mcp-cli info filesystem read_file | ||||||||
|
|
||||||||
| # Call the tool | ||||||||
| mcp-cli filesystem/read_file '{"path": "./README.md"}' | ||||||||
| mcp-cli call filesystem read_file '{"path": "./README.md"}' | ||||||||
|
|
||||||||
| # Search for tools | ||||||||
| mcp-cli grep "*file*" | ||||||||
|
|
||||||||
| # JSON output for parsing | ||||||||
| mcp-cli filesystem/read_file '{"path": "./README.md"}' --json | ||||||||
| mcp-cli call filesystem read_file '{"path": "./README.md"}' -j | ||||||||
|
|
||||||||
| # Complex JSON with quotes (use heredoc or stdin) | ||||||||
| mcp-cli server/tool <<EOF | ||||||||
| mcp-cli call server tool <<EOF | ||||||||
| {"content": "Text with 'quotes' inside"} | ||||||||
| EOF | ||||||||
|
|
||||||||
| # Or pipe from a file/command | ||||||||
| cat args.json | mcp-cli server/tool | ||||||||
| cat args.json | mcp-cli call server tool | ||||||||
|
|
||||||||
| # Find all TypeScript files and read the first one | ||||||||
| mcp-cli filesystem/search_files '{"path": "src/", "pattern": "*.ts"}' --json | jq -r '.content[0].text' | head -1 | xargs -I {} sh -c 'mcp-cli filesystem/read_file "{\"path\": \"{}\"}"' | ||||||||
| mcp-cli call filesystem search_files '{"path": "src/", "pattern": "*.ts"}' -j | jq -r '.content[0].text' | head -1 | xargs -I {} sh -c 'mcp-cli call filesystem read_file "{\"path\": \"{}\"}"' | ||||||||
| ``` | ||||||||
|
|
||||||||
| ## Options | ||||||||
|
|
||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.