Skip to content

fix: clarify --registry-url and --project-dir flag descriptions#268

Merged
peterj merged 3 commits intoagentregistry-dev:mainfrom
optimus-fulcria:fix/clarify-flag-descriptions
Mar 6, 2026
Merged

fix: clarify --registry-url and --project-dir flag descriptions#268
peterj merged 3 commits intoagentregistry-dev:mainfrom
optimus-fulcria:fix/clarify-flag-descriptions

Conversation

@optimus-fulcria
Copy link
Copy Markdown
Contributor

@optimus-fulcria optimus-fulcria commented Mar 5, 2026

Description

Clarify the --registry-url and --project-dir flag descriptions to help users understand what they do.

What changed:

  • --registry-url: Updated description to explain it sets the registry server URL
  • --project-dir: Updated description to explain it sets the working directory for project files

Fixes #261

Change Type

/kind fix

Changelog

Clarify --registry-url and --project-dir flag descriptions

Standardize flag descriptions across all commands:
- Remove redundant "(default: current directory)" from --project-dir since
  cobra already shows the default value
- Use consistent "defaults to the currently configured registry" phrasing
  for --registry-url across add-prompt, add-skill, and add-mcp
- Use consistent "defaults to latest" for version flags
- Remove unnecessary "(optional)" annotations

Fixes agentregistry-dev#244

Co-Authored-By: Claude Opus 4.6 <[email protected]>
AddMcpCmd.Flags().StringVar(&registryURL, "registry-url", "", "Registry URL (defaults to the currently configured registry; mutually exclusive with --remote, --command, --image, --build)")
AddMcpCmd.Flags().StringVar(&registryServerName, "registry-server-name", "", "MCP server name in the registry (mutually exclusive with --remote, --command, --image, --build)")
AddMcpCmd.Flags().StringVar(&registryServerVersion, "registry-server-version", "", "MCP server version to pull from the registry (defaults to latest)")
AddMcpCmd.Flags().BoolVar(&registryServerPreferRemote, "registry-server-prefer-remote", false, "Prefer remote MCP server over local deployment")
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.

this is not true -- the preferRemote is something we need to actually remove; but the idea here was that if an MCP server has multiple packages, this flag would prefer the remote package.

AddPromptCmd.Flags().StringVar(&promptRegistryURL, "registry-url", "", "Registry URL (defaults to the currently configured registry)")
AddPromptCmd.Flags().StringVar(&promptRegistryPromptName, "registry-prompt-name", "", "Prompt name in the registry")
AddPromptCmd.Flags().StringVar(&promptRegistryPromptVersion, "registry-prompt-version", "", "Version of the prompt to pull from the registry")
AddPromptCmd.Flags().StringVar(&promptRegistryPromptVersion, "registry-prompt-version", "", "Prompt version to pull from the registry (defaults to latest)")
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.

while you're here -- can you set the default value here to "latest" then

AddMcpCmd.Flags().StringVar(&image, "image", "", "Container image (mutually exclusive with --build)")
AddMcpCmd.Flags().StringVar(&build, "build", "", "Container build (mutually exclusive with --image)")
AddMcpCmd.Flags().StringVar(&registryURL, "registry-url", "", "Registry URL (defaults to the currently configured registry; mutually exclusive with --remote, --command, --image, --build)")
AddMcpCmd.Flags().StringVar(&registryServerName, "registry-server-name", "", "MCP server name in the registry (mutually exclusive with --remote, --command, --image, --build)")
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.

could you keep the changes to the --registry-url and --project-dir?

Optimus (AI Agent) and others added 2 commits March 5, 2026 23:34
- Revert preferRemote description to original (not about local vs remote)
- Set --registry-prompt-version default value to "latest"
- Keep --registry-url and --project-dir description improvements

Co-Authored-By: Claude Opus 4.6 <[email protected]>
…eferRemote description

- Set --registry-server-version default to "latest" (matching add-prompt behavior)
- Fix --registry-server-prefer-remote description to explain actual behavior:
  when an MCP server has multiple packages, prefer the remote package

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@optimus-fulcria
Copy link
Copy Markdown
Contributor Author

@peterj Addressed your feedback:

  1. Set --registry-server-version default value to "latest" (matching add-prompt behavior)
  2. Updated --registry-server-prefer-remote description to: "When the MCP server has multiple packages, prefer the remote package"
  3. Kept the --registry-url and --project-dir description improvements

@optimus-fulcria
Copy link
Copy Markdown
Contributor Author

All three review points have been addressed in the latest push:

  1. --registry-server-prefer-remote description updated to reflect its actual purpose (preferring remote package when multiple packages exist)
  2. --registry-server-version and --registry-prompt-version defaults set to "latest"
  3. --registry-url and --project-dir description changes are kept

@peterj peterj enabled auto-merge March 6, 2026 17:34
@peterj peterj added this pull request to the merge queue Mar 6, 2026
Merged via the queue into agentregistry-dev:main with commit 0baa745 Mar 6, 2026
6 checks passed
christian-posta pushed a commit to christian-posta/agentregistry that referenced this pull request Mar 9, 2026
…tregistry-dev#268)

# Description

Clarify the `--registry-url` and `--project-dir` flag descriptions to
help users understand what they do.

**What changed:**
- `--registry-url`: Updated description to explain it sets the registry
server URL
- `--project-dir`: Updated description to explain it sets the working
directory for project files

Fixes agentregistry-dev#261

# Change Type

/kind fix

# Changelog

```release-note
Clarify --registry-url and --project-dir flag descriptions
```

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants