Document how to use the OKF4net MCP server with Cursor
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- csharp, markdown
- Domain
- documentation
Research direction
Edit src/OKF4net.Mcp/README.md, modeling the new Use with Cursor section on the existing Use with Claude Desktop block. Include project and global Cursor MCP configuration, the linked Cursor MCP docs, and the OKF_MCP_READONLY=1 note. Verify against a test bundle and run dotnet build OKF4net.sln; done when the README covers setup and read-only use.
Written by the indexing model from the issue text.
Description
Difficulty / est. effort: ~30-45min, small (docs + config)
Context: Cursor is a popular AI-first editor with native MCP support and uses the same {"mcpServers": {...}} shape as Claude, so this is a near-drop-in recipe. src/OKF4net.Mcp/README.md documents only Claude today.
Files to touch: src/OKF4net.Mcp/README.md (add a ### Use with Cursor section).
What to do:
- Add a
### Use with Cursorsection. - Show
.cursor/mcp.json(project) and the global Cursor MCP settings, using{"mcpServers": {"okf": {"command": "okf-mcp", "args": ["<bundle>"]}}}. Link current Cursor MCP docs: https://docs.cursor.com/context/model-context-protocol - Mention
OKF_MCP_READONLY=1.
How to verify:
dotnet tool install -g OKF4net.Mcp(installsokf-mcp).- Point the config at a small test bundle (e.g.
tests/fixtures/has example bundles, or make a throwaway one with a singletype:-tagged concept). - Restart the editor, open its MCP/agent panel, and confirm the
okfserver connects and the OKF tools appear (okf_read_concept,okf_browse,okf_graph,okf_search,okf_validate_bundle,okf_changes_since). - Ask the assistant to read or browse a concept from the bundle and confirm it works. Add a
OKF_MCP_READONLY=1note 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
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jchable/okf4net
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
.NET bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/backend type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
umbraco/Umbraco-CMS#24668 · 1 comment ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area-ai untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/extensions#7956 ·
Maintainers usually reply within 1 day