Skip to content

chore: ctl reference and mcp docs updates#430

Open
keraron wants to merge 1 commit intomainfrom
cli-reorg
Open

chore: ctl reference and mcp docs updates#430
keraron wants to merge 1 commit intomainfrom
cli-reorg

Conversation

@keraron
Copy link
Member

@keraron keraron commented Mar 10, 2026

This PR fixes #395 and #406.

  • Reworked the sidebar so the ctl docs are more visible.
  • Split slim controller and dir ctl pages into guide and reference
  • Created new dir MCP server page

Signed-off-by: Aron Kerekes <arkereke@cisco.com>
@keraron keraron requested a review from a team as a code owner March 10, 2026 15:37

**Version Resolution:**

When no version is specified, commands return the most recently created record (by record's `created_at` field). This allows non-semver tags like `latest`, `dev`, or `stable`.
Copy link
Member

Choose a reason for hiding this comment

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

nit: if multiple records exist with the same name:version then it throws and error to look by CID

| `--oidc-token` | - | OIDC token for non-interactive signing (requires `--sign`) | No | - |
| `--fulcio-url` | - | Sigstore Fulcio URL (requires `--sign`) | No | https://fulcio.sigstore.dev |
| `--rekor-url` | - | Sigstore Rekor URL (requires `--sign`) | No | https://rekor.sigstore.dev |
| `--server-addr` | DIRECTORY_CLIENT_SERVER_ADDRESS | DIR server address | No | localhost:8888 |
Copy link
Member

Choose a reason for hiding this comment

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

--server-addr is a global flag, I think we shouldn't mention it in every dirctl subcommand, rather have a central place where we display the global flags that are available to all subcommands

# Returns: bafyreib...
```

2. Sign the record (triggers automatic verification).
Copy link
Member

Choose a reason for hiding this comment

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

reword: automatic domain name verification

a signed and verified record is not the same as a record that has a name verified attribute

dirctl sync delete abc123-def456-ghi789
git clone https://github.com/agntcy/dir
cd dir
task build-dirctl
Copy link
Member

Choose a reason for hiding this comment

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

We have no task build-dirctl, we have cli:compile

export DIRECTORY_CLIENT_SERVER_ADDRESS=localhost:8888
dirctl routing list
```
# Or pull by name (if the record has a verifiable name)
Copy link
Member

Choose a reason for hiding this comment

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

It doesn't matter if a record has a verifiable name or not, it can be pulled by name either case.


**Example Cursor configuration (`~/.cursor/mcp.json`):**

```json
Copy link
Member

Choose a reason for hiding this comment

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

To start the MCP server we need to set the OASF_API_VALIDATION_SCHEMA_URL env var otherwise it won't start. I propose this to have a default value that points to our schema server, but this is the current situation.

{
  "mcpServers": {
    "dir-mcp-server": {
      "command": "/absolute/path/to/dirctl",
      "args": ["mcp", "serve"],
      "env": {
        "OASF_API_VALIDATION_SCHEMA_URL": "https://schema.oasf.outshift.com"
      }
    }
  }
}

??? example "Example Cursor configuration (`~/.cursor/mcp.json`)"

```json
{
Copy link
Member

Choose a reason for hiding this comment

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

{
  "mcpServers": {
    "dir-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--env",
        "OASF_API_VALIDATION_SCHEMA_URL=https://schema.oasf.outshift.com",
        "ghcr.io/agntcy/dir-ctl:latest",
        "mcp",
        "serve"
      ]
    }
  }
}

}
```

## Directory MCP Server Tools
Copy link
Member

Choose a reason for hiding this comment

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

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.

[Docs]: restructure ctl docs

2 participants