Cocosmcp

🚀 Cocos MCP Log Bridging Tool

A powerful log synchronization tool for transmitting log information between the Cocos Creator editor and Cursor AI, helping developers analyze and solve problems more efficiently.

✨ Features

• Real-time log synchronization: Retrieve the latest logs directly from the Cocos Creator editor.
• Intelligent filtering: Support filtering by type (normal logs, warnings, errors).
• Keyword search: Pinpoint specific issues accurately.
• One-click clearing: Clear logs at any time to reduce interference.
• Scene information: Obtain basic information and node lists of the current scene.
• Scene operations: Support basic operations such as opening scenes.
• TCP communication bridging: A stable and reliable communication mechanism.
• Cursor AI integration: Fully compatible with the Cursor MCP protocol.

🚀 Quick Start

Prerequisites

• Cocos Creator 3.8.0 or higher.
• Python 3.7 or higher.
• uv package manager (recommended) or pip.

Installation Steps

1. Clone the repository

   git clone https://github.com/czh2774/cocosMCP.git
   

2. Copy to the Cocos Creator project Copy the cloned cocosMCP directory to the extensions directory of your Cocos Creator project.
3. Install Python dependencies

   cd your-project/extensions/cocosMCP/Python
   uv pip install -r requirements.txt
   

4. Enable the extension in Cocos Creator Launch Cocos Creator, go to Extensions -> Extension Manager, and ensure that the cocosMCP extension is enabled.
5. Configure Cursor AI Set the MCP protocol in Cursor AI to complete log synchronization.

Basic Usage

# Example code: How to use Cocos MCP for log operations
from cocos_mcp import log_bridge

# Initialize the log bridging tool
bridge = log_bridge.LogBridge()

# Synchronize real-time logs
def on_log_received(log):
    print(f"Received log: {log}")

bridge.start_logging(on_log_received)

# Filter logs (e.g., by type)
filtered_logs = bridge.filter_logs("error")

# Search for keywords
search_results = bridge.search_logs("Crash")

# Clear logs
bridge.clear_logs()

📚 Documentation

For more information on how to use this tool, please refer to the following documents:

• User Guide: Usage Instructions
• Developer Guide: Development Documentation
• Troubleshooting: Frequently Asked Questions

🔧 Technical Details

This project consists of the following three main parts:

1. Log bridging tool: Responsible for transmitting log information between Cocos Creator and Cursor AI.
2. Filtering module: Supports log screening by type (e.g., normal logs, warnings, errors).
3. TCP communication bridging: Provides a stable and reliable communication mechanism to ensure the efficiency and reliability of log transmission.

🤝 Contribution Guidelines

Community contributions are welcome! If you have any questions or suggestions, please refer to the Contribution Guidelines or submit an issue on GitHub.

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.

🙏 Thanks

Thanks to the following teams and individuals:

• Cocos Creator Team: Provided powerful game engine support.
• Cursor AI Team: Developed an excellent AI tool, making integration possible.
• All contributors and users: Your support and feedback are crucial to the project.