Document how to use the OKF4net MCP server with Windsurf

Open Beginner friendly
#20 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
csharp, markdown
Domain
documentation

Research direction

Read the existing “Use with Claude Desktop” section in src/OKF4net.Mcp/README.md and follow its setup pattern. Check the current Windsurf documentation for the MCP config path and schema, then add the requested Windsurf section, including the config example and OKF_MCP_READONLY=1 note. Verify the setup as described in the issue and run dotnet build OKF4net.sln.

Written by the indexing model from the issue text.

Description

documentation good first issue

Difficulty / est. effort: ~30-45min, small (docs + config)

Context: Windsurf (Codeium) supports MCP via Cascade and uses a {"mcpServers": {...}} config, so wiring in okf-mcp is straightforward. src/OKF4net.Mcp/README.md documents only Claude today.

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

What to do:

  1. Add a ### Use with Windsurf section.
  2. Show the Windsurf MCP config (~/.codeium/windsurf/mcp_config.json) with {"mcpServers": {"okf": {"command": "okf-mcp", "args": ["<bundle>"]}}}. Verify the exact path/schema against current Windsurf 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.

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.