Skip to content

Commit fc38445

Browse files
committed
add better docs
1 parent 2b5d6c5 commit fc38445

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

docs/commands/mcp-server.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: mkdocs-click
2+
:module: rsconnect.main
3+
:command: mcp_server

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ nav:
5050
- system: commands/system.md
5151
- version: commands/version.md
5252
- write-manifest: commands/write-manifest.md
53+
- mcp-server: commands/mcp-server.md
5354

5455

5556
theme:

rsconnect/main.py

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,32 @@ def version():
402402
click.echo(VERSION)
403403

404404

405-
@cli.command(help="Start the MCP server")
405+
@cli.command(
406+
short_help="Start the Model Context Protocol (MCP) server.",
407+
help=(
408+
"Start a Model Context Protocol (MCP) server to expose rsconnect-python capabilities to AI applications "
409+
"through a standardized protocol interface."
410+
"\n\n"
411+
"The MCP server exposes a single tool:\n\n"
412+
"`get_command_info`:\n\n"
413+
" - Provides detailed parameter schemas for any rsconnect command. "
414+
"This provides context for an LLM to understand how to construct valid rsconnect "
415+
"commands dynamically without hard-coded knowledge of the CLI."
416+
"\n\n"
417+
"System Requirements:\n\n"
418+
" - Python>=3.10\n"
419+
" - fastmcp"
420+
"\n\n"
421+
"The server runs in stdio mode, communicating via standard input/output streams."
422+
"\n\n"
423+
"Usage with popular LLM clients:\n\n"
424+
" - [codex](https://developers.openai.com/codex/mcp/#configuration---cli)\n"
425+
" - [claude code](https://docs.claude.com/en/docs/claude-code/mcp#option-3%3A-add-a-local-stdio-server)\n"
426+
" - [VS Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server)\n\n"
427+
"The command `uvx --from rsconnect-python rsconnect mcp-server` is a simple option for use in each of "
428+
"the above options."
429+
),
430+
)
406431
def mcp_server():
407432
try:
408433
from fastmcp import FastMCP

0 commit comments

Comments
 (0)