Skip to content

Commit bc2662f

Browse files
WilliamK112danielmeppielCopilot
authored
fix(mcp): clarify install help forwarded options (#2018)
* fix(mcp): clarify install help forwarded options * docs(mcp): sync reference page label to 'Forwarded install options' Align docs/reference/cli/mcp.md terminology with the CLI help text changed in the parent commit. The CLI now says 'Forwarded install options'; the reference page still said 'Common forwarded options'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Ching Wei Kang <WilliamK112@users.noreply.github.com> Co-authored-by: danielmeppiel <danielmeppiel@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 1228716 commit bc2662f

4 files changed

Lines changed: 16 additions & 6 deletions

File tree

‎docs/src/content/docs/reference/cli/mcp.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ apm mcp install fetch -- npx -y @modelcontextprotocol/server-fetch
8989
apm mcp install api --transport http --url https://example.com/mcp
9090
```
9191

92-
Common forwarded options (see `apm install --help` for the full
92+
Forwarded install options (see `apm install --help` for the full
9393
list):
9494

9595
| Flag | Description |

‎src/apm_cli/commands/mcp.py‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,16 @@ def mcp():
8989
"Add an MCP server to apm.yml. Alias for 'apm install --mcp'.\n\n"
9090
"Examples:\n\n"
9191
" apm mcp install fetch -- npx -y @modelcontextprotocol/server-fetch\n\n"
92-
" apm mcp install api --transport http --url https://example.com/mcp"
93-
),
94-
epilog=(
92+
" apm mcp install api --transport http --url https://example.com/mcp\n\n"
9593
"\b\n"
96-
"Common options (see 'apm install --help' for full list):\n"
94+
"Forwarded install options (see 'apm install --help' for the full list):\n"
9795
" --transport [stdio|http|sse|streamable-http]\n"
9896
" --url URL Server URL for remote transports\n"
9997
" --env KEY=VALUE Environment variable (repeatable)\n"
10098
" --header KEY=VALUE HTTP header (repeatable)\n"
10199
" --registry URL Custom registry URL\n"
102100
" --mcp-version VER Pin registry entry to a specific version\n"
103-
" --dev / --dry-run / --force / --verbose / --no-policy\n"
101+
" --dev / --dry-run / --force / --verbose / --no-policy"
104102
),
105103
)
106104
@click.argument("name", required=True)

‎tests/integration/test_commands_mcp_flow.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,12 @@ def test_mcp_install_help(self) -> None:
121121
runner = CliRunner()
122122
result = runner.invoke(mcp, ["install", "--help"])
123123
assert result.exit_code == 0
124+
description, options = result.output.split("Options:", 1)
125+
assert "Forwarded install options" in description
126+
assert "--transport [stdio|http|sse|streamable-http]" in description
127+
assert "--mcp-version VER" in description
128+
assert "Common options" not in options
129+
assert "--transport [stdio|http|sse|streamable-http]" not in options
124130

125131

126132
class TestMcpSearch:

‎tests/integration/test_commands_mcp_phase3c.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,12 @@ def test_mcp_install_help(self) -> None:
121121
runner = CliRunner()
122122
result = runner.invoke(mcp, ["install", "--help"])
123123
assert result.exit_code == 0
124+
description, options = result.output.split("Options:", 1)
125+
assert "Forwarded install options" in description
126+
assert "--transport [stdio|http|sse|streamable-http]" in description
127+
assert "--mcp-version VER" in description
128+
assert "Common options" not in options
129+
assert "--transport [stdio|http|sse|streamable-http]" not in options
124130

125131

126132
class TestMcpSearch:

0 commit comments

Comments
 (0)