docs(cli): add CLI client details and configuration instructions
Some checks failed
CI / build-and-test (push) Failing after -30m35s
Some checks failed
CI / build-and-test (push) Failing after -30m35s
This commit is contained in:
47
README.md
47
README.md
@@ -525,6 +525,53 @@ Recommended Apache settings:
|
||||
- `ProxyTimeout 600` and `ProxyPass ... timeout=600` give Apache enough time to wait for the Go backend.
|
||||
- If another proxy or load balancer sits in front of Apache, align its size and timeout settings too.
|
||||
|
||||
## CLI
|
||||
|
||||
`amcs-cli` is a pre-built CLI client for the AMCS MCP server. Download it from https://git.warky.dev/wdevs/amcs/releases
|
||||
|
||||
The primary purpose is to give agents and MCP clients a ready-made bridge to the AMCS server so they do not need to implement their own HTTP MCP client. Configure it once and any stdio-based MCP client can use AMCS immediately.
|
||||
|
||||
### Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|---|---|
|
||||
| `amcs-cli tools` | List all tools available on the remote server |
|
||||
| `amcs-cli call <tool>` | Call a tool by name with `--arg key=value` flags |
|
||||
| `amcs-cli stdio` | Start a stdio MCP bridge backed by the remote server |
|
||||
|
||||
`stdio` is the main integration point. It connects to the remote HTTP MCP server, discovers all its tools, and re-exposes them over stdio. Register it as a stdio MCP server in your agent config and it proxies every tool call through to AMCS.
|
||||
|
||||
### Configuration
|
||||
|
||||
Config file: `~/.config/amcs/config.yaml`
|
||||
|
||||
```yaml
|
||||
server: https://your-amcs-server
|
||||
token: your-bearer-token
|
||||
```
|
||||
|
||||
Env vars override the config file: `AMCS_URL`, `AMCS_TOKEN`. Flags `--server` and `--token` override env vars.
|
||||
|
||||
### stdio MCP client setup
|
||||
|
||||
#### Claude Code
|
||||
|
||||
```bash
|
||||
claude mcp add --transport stdio amcs amcs-cli stdio
|
||||
```
|
||||
|
||||
With inline credentials (no config file):
|
||||
|
||||
```bash
|
||||
claude mcp add --transport stdio amcs amcs-cli stdio \
|
||||
--env AMCS_URL=https://your-amcs-server \
|
||||
--env AMCS_TOKEN=your-bearer-token
|
||||
```
|
||||
|
||||
#### Output format
|
||||
|
||||
`call` outputs JSON by default. Pass `--output yaml` for YAML.
|
||||
|
||||
## Development
|
||||
|
||||
Run the SQL migrations against a local database with:
|
||||
|
||||
Reference in New Issue
Block a user