Dart MCP

🚀 Dart MCP Project Documentation

Dart MCP is a powerful toolset for Dart development. It simplifies the installation, configuration, and management of Dart projects, providing a seamless development experience.

🚀 Quick Start

📦 Installation

To use the Dart MCP tool, you need to install the Dart SDK first. Choose the appropriate installation package according to your operating system:

• Windows Download and run the Dart Windows Installer.

• macOS Install via the terminal using the following command:

  brew install dart --with-docs
  

• Linux Install using the following command:

  sudo apt-get update && sudo apt-get install dart
  

🛠️ Verification

After the installation is complete, you can verify whether Dart is installed correctly by running the following command:

dart --version

If the following information is displayed, the installation is successful:

Dart SDK version: 3.0.1 (stable) (Thu Aug 24 13:58:50 GMT+7 2023)
Built by buildbot on Linux.

💻 Usage Examples

📋 Basic Usage

Install the tool

dart-mcp install

Uninstall the tool

dart-mcp uninstall

Get help information

dart-mcp help

Check the version

dart-mcp version

📚 Command Reference

Here are the commands supported by Dart MCP and their detailed descriptions:

dart-mcp config [options]

Description Configure the Dart MCP tool.

Options

• --help: Display help information.
• -v, --version: Display the current version number.
• --global: Install the toolchain globally (optional).

dart-mcp tools

Description Manage Dart tools.

Subcommands

dart-mcp tools list

List installed Dart tools.

dart-mcp tools install [tool]

Install the specified Dart tool.

dart-mcp tools uninstall [tool]

Uninstall the specified Dart tool.

dart-mcp package

Description Manage Dart packages.

Subcommands

dart-mcp package init

Initialize a new Dart package project.

dart-mcp package get

Fetch the dependencies of the current project.

dart-mcp package upgrade

Upgrade all dependencies to the latest version.

dart-mcp package add [package]

Add the specified dependency.

dart-mcp package remove [package]

Remove the specified dependency.

dart-mcp test

Description Run Dart project tests.

Options

• --coverage: Generate a code coverage report.
• --name=TEST_TAG: Run specific test cases by tag.
• -v, --verbose: Enable verbose mode to display more log information.

📚 Documentation

📝 Type Definitions

Configuration Class

class Configuration {
  final String name;
  final String version;
  
  const Configuration({
    required this.name,
    required this.version,
  });
}

Explanation

• name: The name of the project.
• version: The version number of the project.

Command Class

abstract class Command {
  /// Execute the command.
  Future<void> execute();
}

🤝 Contribution Guidelines

📄 Submission Specification

Follow the following format when submitting code:

Type(affected module): [ ISSUE number ] Description

Examples:

• feat(tools): Add support for a new tool.
• fix(bug): Fix a known issue. Please add relevant links, such as PR prompts or ISSUE links, in the submission description.

🚧 Development Process

1. Clone the repository

   git clone https://github.com/your-repository.git
   

2. Create a feature branch

   git checkout -b feature/your-feature
   

3. Commit the code

   git add .
   git commit -m "feat: Add a new feature"
   

4. Push the branch and create a Pull Request

   git push origin feature/your-feature
   

⚠️ Error Handling

🛠️ Common Issues

1. Installation failure

   • Ensure that the system meets the minimum requirements.
   • Check the network connection to ensure that external resources can be accessed.

2. Dependency resolution failure

   • Check the pubspec.yaml file to confirm that the dependency versions are correct.
   • Use dart-mcp package get to update the dependencies.

3. Test failure

   • Check the console output for specific error information.
   • Ensure that all dependencies are installed correctly.

📏 Project Specifications

📝 Naming Conventions

Follow the following naming rules:

• Variable names: Use camelCase.
• Class names: Use PascalCase.
• Method names: Use lowerCamelCase.

💻 Coding Style

• Follow the official Dart coding style guide.
• Keep the code concise and avoid duplicate code.
• Add appropriate comments to improve readability.

📄 License

The Dart MCP project is licensed under the MIT License. For more information, please refer to the LICENSE file.

📞 Contact Information

If you have any questions, please contact us:

• Email: contact@dartmcp.com
• GitHub: https://github.com/your-repository

Thank you for your support of the Dart MCP project! We hope this documentation helps you better understand and use the tool.