Skip to content

Document how to use the OKF4net MCP server with JetBrains Rider (and IntelliJ) #18

Description

@jchable

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

Context: JetBrains Rider is the JetBrains .NET IDE (and IntelliJ the JVM flagship); the AI Assistant supports MCP. A recipe lets Rider/IntelliJ users consult an OKF bundle via okf-mcp (a standard stdio MCP server; src/OKF4net.Mcp/README.md documents only Claude today).

Files to touch: src/OKF4net.Mcp/README.md (add a ### Use with JetBrains Rider (and IntelliJ) section).

What to do:

  1. Add the section covering Rider and, where identical, IntelliJ IDEA.
  2. Document how to register the server via the AI Assistant MCP settings (Settings → Tools → AI Assistant → Model Context Protocol) and/or an mcp.json, with command: "okf-mcp" + bundle-path args. Verify the exact path/schema and minimum IDE version against current JetBrains docs and link them.
  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.

Activity

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

Metadata

Metadata

Assignees

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