cf

CF::MCP provides automatic documentation generation for Cute Framework projects and exposes a search-enabled documentation server. It supports two operation modes: STDIO, which communicates over standard input/output for CLI and desktop tool integrations, and HTTP, which runs as a web server with a user-friendly UI at the root and an MCP endpoint at /http. Use STDIO when integrating with local scripts or IDEs, and use HTTP when you want a web interface for browsing, searching, and inspecting documentation. After starting the server, you can generate and query documentation for your Cute Framework headers, with the MCP Inspector available to help debug and test the server. The inspector connects to the MCP server and provides a UI to explore structures, functions, and other documented elements that were indexed from your header files.

Prerequisites:

• Ruby (and Bundler) installed on your system
• Access to the internet to fetch the gem

Installation steps:

1. Install the gem from RubyGems: bundle install (if you are using Bundler in your project) or gem install cf-mcp
2. If using Bundler, add the gem to your Gemfile: gem 'cf-mcp' then run: bundle install
3. Verify installation: cf-mcp --version

Note: The README describes both STDIO and HTTP usage directly via the cf-mcp command. The following commands illustrate how to start in each mode after installation:

• STDIO mode: cf-mcp stdio --root /path/to/cute_framework_project
• HTTP mode (with web UI): cf-mcp http --root /path/to/cute_framework_project --port 9292

Tips and notes:

• The --root path must point to the root of your Cute Framework project or to a directory containing the header files so that the MCP server can index and generate documentation.
• In HTTP mode, you can access the UI at http://localhost:9292/ and the MCP endpoint at http://localhost:9292/http for programmatic access.
• If you need to inspect or debug interactions with the server, use the MCP Inspector: npx @modelcontextprotocol/inspector cf-mcp stdio --root /path/to/cute_framework or connect to the HTTP endpoint at http://localhost:9292/http via the inspector.
• There are two operation modes; STDIO is ideal for CLI tools and IDE integrations, while HTTP provides a shareable web interface for documentation exploration and search.
• When upgrading or changing the root path, restart the server to re-index the updated header files.