Your mogul in the agent designer

[Hekas1]

Hello. How can I make my own module for an agent, like a wiki search or a web search engine? I have access to a closed part of the site with a certain database of dynamically updated data, I need to set up an agent so that it can make a request and receive what this closed part of the site provides, is it possible to implement this by adding my own module to the agent designer, with the necessary parameters, credentials, parsing settings.

[dosubot[bot]]

Hi @Hekas1! I'm Dosu and I’m helping the ragflow team.

Yes, you can add your own module to the agent designer in RAGFlow to access a private or dynamic data source. RAGFlow supports custom modules by letting you implement a Python class (typically as a subclass of a base class), assign it a unique _FACTORY_NAME, and register it so it appears as a selectable tool in the agent designer UI. The system uses a dynamic registration mechanism (MODULE_MAPPING) to load and map these modules for use in agents, similar to how built-in tools like wiki or web search are integrated [source].

To implement your module, you’ll need to:

• Subclass the appropriate base class and define a _FACTORY_NAME attribute for registration.
• Handle parameters (like API endpoints, credentials, or parsing options) by exposing them as configurable fields—these will show up in the agent designer’s form UI.
• For authentication, use secure storage for API tokens or credentials, and pass them as needed in your module’s logic.
• For parsing settings (like chunk size), use the correct parameter names (e.g., chunk_token_num for token chunking) [source].
• Integrate your module’s prompt/parameter handling with the dynamic prompt editor and form components, so users can configure it visually in the agent designer [source].

If you want to see concrete examples, the retrieval tool and other built-in modules (like web or wiki search) are good templates—they show how to structure the code and UI integration [source].

Let me know if you want more details on any specific part of the process!

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[ZhenhangTung]

@Hekas1 Currently we don't support customized agent component very well. I would suggest start with our code component and write code in there.