Flux

🚀 Flux

An AI-powered enhanced AO tool invocation platform that seamlessly integrates with your existing tools and editors via the MCP server.

GitHub Resource Link

🚀 Quick Start

Flux is an AI - based platform that enhances AO tool invocations. It can integrate seamlessly with your current tools and editors through the MCP server. You can follow the installation instructions below to start using it.

✨ Features

Implemented Features

• Run AO code using pure natural language.
• Create and run custom AO code/blueprints entirely through natural language.
• Integrate with existing AI development tools (e.g., Cursor, Windsurf, Claude, etc.) and support any tool that enables MCP tool invocation.
• Test all pushed code.
• Create and test complex handlers.

Features to be Implemented

• Integrate with AO ecosystem tools.
• Improve code generation capabilities by adding more context information about AO.

📦 Installation

Currently, there are two ways to install and use Flux. After testing, it runs well on Cursor, so we will show you how to install Flux in Cursor -

Local Setup

This is suitable for users who want everything to run locally without involving any remote servers.

• Make sure you have installed the latest stable version of NODE.js - Download Node.js.
• Copy the content of the file local/index.js to any folder on your local computer and get its absolute path.
• Open Cursor, go to Settings > Cursor Settings > MCP > Add a new MCP tool.
• Paste the following code:

"mcpServers": {
    "flux": {
        "command": "node /path/to/your/local/index.js"
    }
}

• If configured correctly, you will be able to see the MCP tool with Flux loaded and can start using it!

Remote Setup

This is suitable for users who don't want to install anything locally.

• Open Cursor, go to Settings > Cursor Settings > MCP > Add a new MCP tool.
• Paste the following code:

"mcpServers": {
    "flux": {
        "url": "https://flux-2esw.onrender.com/sse"
    }
}

• If configured correctly, you will be able to see the MCP tool with Flux loaded and can start using it!

💻 Usage Examples

Basic Setup

We recommend that you first add the llms.txt file to Cursor to enhance the context information of AO documentation. If you're not sure how to do this, refer to this document.

The more context you provide to Cursor, the more accurate the response will be.

Now, add these custom rules to your Cursor project to ensure that Cursor doesn't generate hallucinations or give incorrect responses. You can do this in Settings > Cursor Settings > Rules > Add a new rule.

Only when you need to add specific tags to the handler, please refer to the following instructions:
- It must start with the # symbol.
- The tag content must be in English.
- One tag per line, and tags cannot be combined.
- There is no limit to the number of tags.

In addition, please follow these best practices:
1. Avoid reusing the same tags.
2. Check if similar tags already exist before adding new ones.
3. Keep the tags concise and descriptive.

🔧 Technical Details

Technology Stack

• AO
• Arweave
• MCP TypeScript SDK
• TypeScript
• Node.js

📄 License

No license information provided in the original document.

⚠️ Important Note

• Check your network connection if you encounter any issues.
• Ensure that all dependencies are installed correctly.
• Update regularly to get the latest features and improvements.