Document how to use the OKF4net MCP server with VS Code

Open
#16 2 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@laurentkempe is already working on this.

Since Sep 8, 2026.

Assessment

This issue has not been assessed yet.

Description

documentation good first issue

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

Context: OKF4net.Mcp (okf-mcp) is a standard stdio MCP server, but src/OKF4net.Mcp/README.md only documents Claude Desktop/Code. VS Code has first-class MCP support (agent mode / GitHub Copilot), so a short recipe lets any VS Code user consult an OKF bundle from the editor.

Files to touch: src/OKF4net.Mcp/README.md (add a ### Use with VS Code section); optionally cross-link from the root README.md "Use OKF in Claude (MCP)" section.

What to do:

  1. Add a ### Use with VS Code section to src/OKF4net.Mcp/README.md.
  2. Show a workspace .vscode/mcp.json (VS Code uses a "servers" object, each entry with "type": "stdio", "command": "okf-mcp", and the bundle path in "args"), plus the user-level mcp.json alternative. Reference the current VS Code MCP docs: https://code.visualstudio.com/docs/copilot/chat/mcp-servers
  3. Mention enabling the server in agent mode and the OKF_MCP_READONLY=1 option.

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.