Project

cf-mcp

0.0
No release in over 3 years
An MCP server that indexes Cute Framework header files and provides search functionality for structs, functions, enums, and other elements.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 0.5
~> 6.0
~> 3.0
~> 2.0
~> 2.3
 Project Readme

CF::MCP

CF::MCP is an MCP server providing documentation tools for the Cute Framework, a C/C++ 2D game framework.

The MCP server supports two modes of operation:

  • STDIO Mode: Communicates via standard input and output streams, suitable for integration with CLI tools and desktop applications.
  • HTTP Mode: Operates as an HTTP server with a web interface at the root and MCP endpoint at /http.

Features

  • Documentation Generation: Automatically generates documentation for Cute Framework projects by indexing the the header files and extracting the documentation from the comments.
  • Search Functionality: Provides a search feature to quickly find structs, classes, functions, and other elements within the documentation.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add cf-mcp

If bundler is not being used to manage dependencies, install the gem by executing:

gem install cf-mcp

Usage

To start the MCP server, run the following command in your terminal:

cf-mcp stdio --root /path/to/cute_framework_project  # STDIO mode
cf-mcp http --root /path/to/cute_framework_project   # HTTP mode with web UI

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pusewicz/cf-mcp.

License

The gem is available as open source under the terms of the MIT License.