Skip to content

fix: cli reference format in MCP server configuration page - #774

Closed
pratik-naik003 wants to merge 1 commit into
kubeflow:mainfrom
pratik-naik003:fix/cli-reference-docs-format
Closed

fix: cli reference format in MCP server configuration page#774
pratik-naik003 wants to merge 1 commit into
kubeflow:mainfrom
pratik-naik003:fix/cli-reference-docs-format

Conversation

@pratik-naik003

@pratik-naik003 pratik-naik003 commented Aug 25, 2026

Copy link
Copy Markdown

What this PR does

Fixes the CLI reference code block in docs/source/mcp-server/configuration.rst to match the format used in the upstream MCP server README.

Before (inline comments on each flag)

kubeflow-mcp serve \
  --clients trainer \             # modules: trainer, optimizer (stub), hub (stub)
  --persona ml-engineer \         # readonly | data-scientist | ml-engineer | platform-admin
  --mode full \                   # full | progressive | semantic

After (descriptive comment block above the command)

# Modules: trainer, optimizer (stub), hub (stub)
# Persona: readonly | data-scientist | ml-engineer | platform-admin
# Mode: full | progressive | semantic
...
kubeflow-mcp serve \
  --clients trainer \
  --persona ml-engineer \
  --mode full \
  ...

Why

The website and the README should present the CLI reference consistently. The inline-comment format made lines unnecessarily long and differed from the upstream source of truth.

Fixes #773

@google-oss-prow

Copy link
Copy Markdown
Contributor

@pratik-naik003: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

What this PR does

Fixes the CLI reference code block in docs/source/mcp-server/configuration.rst to match the format used in the upstream MCP server README.

Before (inline comments on each flag)

kubeflow-mcp serve \
 --clients trainer \             # modules: trainer, optimizer (stub), hub (stub)
 --persona ml-engineer \         # readonly | data-scientist | ml-engineer | platform-admin
 --mode full \                   # full | progressive | semantic

After (descriptive comment block above the command)

# Modules: trainer, optimizer (stub), hub (stub)
# Persona: readonly | data-scientist | ml-engineer | platform-admin
# Mode: full | progressive | semantic
...
kubeflow-mcp serve \
 --clients trainer \
 --persona ml-engineer \
 --mode full \
 ...

Why

The website and the README should present the CLI reference consistently. The inline-comment format made lines unnecessarily long and differed from the upstream source of truth.

Fixes #773

/kind documentation

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@google-oss-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign andreyvelich for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@pratik-naik003 pratik-naik003 changed the title docs: fix CLI reference format in MCP server configuration page fix: CLI reference format in MCP server configuration page Aug 25, 2026
@pratik-naik003 pratik-naik003 changed the title fix: CLI reference format in MCP server configuration page fix(docs): CLI reference format in MCP server configuration page Aug 25, 2026
@pratik-naik003 pratik-naik003 changed the title fix(docs): CLI reference format in MCP server configuration page fix:CLI reference format in MCP server configuration page Aug 25, 2026
@pratik-naik003 pratik-naik003 changed the title fix:CLI reference format in MCP server configuration page [fix] CLI reference format in MCP server configuration page Aug 25, 2026
@pratik-naik003 pratik-naik003 changed the title [fix] CLI reference format in MCP server configuration page fix: CLI reference format in MCP server configuration page Aug 25, 2026
@pratik-naik003 pratik-naik003 changed the title fix: CLI reference format in MCP server configuration page fix: cli reference format in MCP server configuration page Aug 25, 2026
@jaiakash

Copy link
Copy Markdown
Member

I dont think this would be need. Both format are fine.

/close

@google-oss-prow google-oss-prow Bot closed this Aug 25, 2026
@google-oss-prow

Copy link
Copy Markdown
Contributor

@jaiakash: Closed this PR.

Details

In response to this:

I dont think this would be need. Both format are fine.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: CLI reference format in MCP server configuration page

2 participants