Skip to content

Describe the CLI that exists; add publicInterfacesUsed guidance; drop cursor-mcp-dkg - #25

Merged
Jurij89 merged 2 commits into
mainfrom
fix/cli-contract-docs
Jul 29, 2026
Merged

Describe the CLI that exists; add publicInterfacesUsed guidance; drop cursor-mcp-dkg#25
Jurij89 merged 2 commits into
mainfrom
fix/cli-contract-docs

Conversation

@Jurij89

@Jurij89 Jurij89 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The README documented a CLI surface that largely did not exist. dkg integration search errored with unknown command; upgrade, uninstall and install --for cursor were never implemented; the community tier is shown with --tier community, not --include-community; and "handles the supported install kinds automatically (mcp, service, cli, agent-plugin, manual)" was true of two of the five. Rewritten against the CLI as it actually ships after fix(integrations): conform the CLI to the published registry schema dkg#1988.
  • Adds guidance for choosing publicInterfacesUsed — the field the committee audits for scope compliance, and the most frequently mis-declared, because the rule only lived in a JSON Schema description contributors never read.
  • Removes the cursor-mcp-dkg entry. It is the DKG's own MCP server, shipped with the node and installed by dkg mcp setup, so listing it in a registry of third-party integrations is redundant. Its entry had also drifted: pinned @origintrail-official/dkg-mcp@0.1.0-dev.1777029135 against a current 10.0.10, and pointed at the pre-rename dkg-v9 URL.

Related

Diagrams

Files changed

File What
README.md User section rewritten to the three verbs that exist (list / search browse the registry, installed reports local state); states which install kinds are automated and which are not; --tier community corrected; upgrade/uninstall called out as not existing rather than quietly documented
CONTRIBUTING.md New §3 guidance on choosing publicInterfacesUsed, with the decision rule stated plainly and the MCP-server case spelled out
integrations/cursor-mcp-dkg.json Removed — redundant with dkg mcp setup, stale pin, pre-rename repo URL
package.json security-checks script referenced the removed entry as a seed; updated so npm run security-checks keeps working

Test plan

  • node scripts/validate.mjs2 entries checked · 0 errors · 1 warning (the pre-existing, disclosed VM-scope warning on buzz-dkg)
  • npm run security-checks1 entry checked · 0 errors · 0 warnings
  • grep -rn cursor-mcp-dkg . → no dangling references
  • Every command in the rewritten README executed against the CLI from fix(integrations): conform the CLI to the published registry schema dkg#1988: list, search <kw>, list --tier community, info <slug>, install <slug>, install --dry-run, installed — all exist and exit 0
  • dkg integration list --json{ entries, failures }, the shape it already shipped with, so this documents no breaking change

Notes for reviewers

The publicInterfacesUsed guidance is not hypothetical. #16 currently declares ["http-api", "mcp"] while its own security.notes describe a pure HTTP client ("Only communicates with the local DKG node… Bearer token read from DKG_AUTH_TOKEN or ~/.dkg/auth.token"). Per the schema's own rule it should list http-api alone — install.kind: mcp already records that it is an MCP server. Left as review feedback there rather than changed here.

🤖 Generated with Claude Code

The README documented a CLI surface that largely does not exist: `search` and
`search <keyword>` are not implemented, `upgrade`/`uninstall` do not exist,
`install --for <client>` is not a flag, the community tier is shown with
`--tier community` rather than `--include-community`, and `list` claimed to
show what is installed locally while actually listing the registry.

Rewrites the user section against the CLI as it will ship (see
OriginTrail/dkg#<TBD>), and states plainly which install kinds are automated —
`manual` is not automated by design, and `agent-plugin` / `service` docker
and binary runtimes are not automated yet.

Adds guidance for choosing publicInterfacesUsed. It is the field reviewers audit
for scope compliance and the most often mis-declared: an MCP server that calls
/api/... should declare http-api alone, because that it is an MCP server is
already recorded by install.kind. The rule existed only inside a JSON Schema
description that contributors do not read.

Also removes the cursor-mcp-dkg entry. It is the DKG's own MCP server, which
ships with the node and is installed by `dkg mcp setup`, so listing it in the
registry is redundant; its entry also pinned a stale dev prerelease
(0.1.0-dev.1777029135 vs 10.0.10) and pointed at the pre-rename repo URL. The
security-checks npm script referenced it as a seed entry and is updated too.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Follows the CLI settling on three verbs (OriginTrail/dkg#1988): list and search
are siblings over the registry differing only by a keyword filter, and local
detection gets its own unambiguous verb rather than repurposing list. This also
means list keeps the meaning it already shipped with, so nothing breaks.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Jurij89
Jurij89 merged commit d4e575a into main Jul 29, 2026
4 checks passed
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.

1 participant