Contribution Guide

We welcome contributions to the Flutter MCP Toolkit! Please feel free to submit pull requests or report issues on the GitHub repository.

Development Setup

  1. Clone the repository.

  2. Install the dependencies for both the server and the toolkit:

    # Toolkit core package
    cd mcp_toolkit
    dart pub get
    
    # Server package
    cd ../../mcp_server_dart
    dart pub get
    
    # test app (if needed)
    cd ../../flutter_test_app
    dart pub get
    
  3. Run the tests:

    dart test
    

Editing skills

Skill bodies are the canonical source of AI-agent guidance, located in plugin/skills/<skill-id>/SKILL.md. After editing any skill:

make sync-skills   # regenerates mcp_server_dart/lib/src/skill_assets.g.dart

CI fails if the generated file is out of sync with plugin/. Commit both the SKILL.md change and the regenerated skill_assets.g.dart.

Pull Requests

Before submitting a pull request, please make sure that:

  • The code is well-formatted and follows the project's style guide.
  • The tests pass.
  • The documentation is updated, if necessary.