Skip to content

Document how to use the OKF4net MCP server with Zed #21

Description

@jchable

Difficulty / est. effort: ~1h, small (docs + config)

Context: Zed is a fast modern editor whose assistant supports MCP via "context servers". A recipe lets Zed users consult an OKF bundle via okf-mcp. src/OKF4net.Mcp/README.md documents only Claude today.

Files to touch: src/OKF4net.Mcp/README.md (add a ### Use with Zed section).

What to do:

  1. Add a ### Use with Zed section.
  2. Show the Zed settings.json context_servers entry pointing at okf-mcp with the bundle-path args (Zed uses its own shape, e.g. "context_servers": {"okf": {"command": {"path": "okf-mcp", "args": ["<bundle>"]}}}). Verify against current Zed docs and link them: https://zed.dev/docs/ai/mcp
  3. Mention OKF_MCP_READONLY=1.

How to verify:

  1. dotnet tool install -g OKF4net.Mcp (installs okf-mcp).
  2. Point the config at a small test bundle (e.g. tests/fixtures/ has example bundles, or make a throwaway one with a single type:-tagged concept).
  3. Restart the editor, open its MCP/agent panel, and confirm the okf server connects and the OKF tools appear (okf_read_concept, okf_browse, okf_graph, okf_search, okf_validate_bundle, okf_changes_since).
  4. Ask the assistant to read or browse a concept from the bundle and confirm it works. Add a OKF_MCP_READONLY=1 note for read-only use.

Docs-only change — no build impact — but run dotnet build OKF4net.sln to be safe.

Good to know: Model the new section on the existing "Use with Claude Desktop" block in src/OKF4net.Mcp/README.md (same command: "okf-mcp" + bundle-path args, or OKF_BUNDLE_ROOT env). MCP is a standard stdio protocol, so the server itself needs no change — only the client-side config differs. See CONTRIBUTING.md. If you get stuck on a config format, open a Discussion.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions