Skip to content

docs(cli): add mcpservers reference and refresh the command list#5261

Open
ihopenre-eng wants to merge 2 commits into
dapr:v1.18from
ihopenre-eng:docs/cli-reference-mcpservers
Open

docs(cli): add mcpservers reference and refresh the command list#5261
ihopenre-eng wants to merge 2 commits into
dapr:v1.18from
ihopenre-eng:docs/cli-reference-mcpservers

Conversation

@ihopenre-eng

Copy link
Copy Markdown

Description

dapr mcpservers ships in CLI v1.18.0, but the CLI reference has no page for it, while every other command has one. The overview page's pasted dapr --help output also predates several v1.18 changes, and scheduler and workflow have pages that the overview never links to.

Verified against a dapr binary built from the v1.18.0 tag of dapr/cli:

$ dapr --help
...
  mcpservers     List all Dapr MCPServer resources. Supported platforms: Kubernetes and self-hosted
...
  scheduler      Scheduler management commands. Use -k to target a Kubernetes Dapr cluster.
...
  upgrade        Upgrades or downgrades a Dapr control plane installation in a cluster. Supported platforms: Kubernetes
  version        Print the Dapr runtime and CLI version
  workflow       Workflow management commands. Use -k to target a Kubernetes Dapr cluster.

Flags:
  -h, --help                  help for dapr
      --log-as-json           Log output in JSON format
      --runtime-path string   The path to the dapr runtime installation directory
  -v, --version               version for dapr

This PR:

  • adds dapr-mcpservers.md, following the layout of the other command pages. Flags, defaults and examples come from dapr mcpservers --help on v1.18.0, with the defaults cross-checked against the flag registrations in cmd/mcpservers.go.
  • updates cli-overview.md: the mcpservers, scheduler and workflow entries, the --runtime-path global flag, the dapr [flags] usage line, and the reworded upgrade description.
  • links mcpservers, scheduler and workflow from the command reference list.

The new page links to the existing [MCPServer spec]({{% ref mcpserver-schema.md %}}) and [MCP how-to]({{% ref howto-use-mcpserver.md %}}) pages; both ref targets resolve to a single file.

Issue reference

N/A, documentation gap found by diffing the CLI reference against dapr --help on v1.18.0.

Checklist

  • Docs
  • Verified against the released CLI

`dapr mcpservers` ships in CLI v1.18.0 but has no page under the CLI
reference, and the overview's pasted `dapr --help` output predates it.
`scheduler` and `workflow` have pages that the overview never links to
either.

Add the mcpservers page in the shape the other command pages use, with
the flags, defaults and examples taken from `dapr mcpservers --help` on
v1.18.0, and bring the overview back in sync with that release: the
three missing commands, the `--runtime-path` global flag, the `dapr
[flags]` usage line, and the reworded `upgrade` description.

Signed-off-by: ihopenre-eng <247072151+ihopenre-eng@users.noreply.github.com>
@ihopenre-eng
ihopenre-eng requested review from a team as code owners July 21, 2026 16:23
@ihopenre-eng

Copy link
Copy Markdown
Author

The CI workflows on this PR are queued at action_required and haven't started, so there are no check results to review yet. This is the first-time contributor approval gate for this repository.

Could a maintainer approve the workflow runs when convenient? Happy to rebase if anything has drifted in the meantime.

@sicoyle sicoyle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants