How to Publish Agents

Before submitting your agents, make sure that you have read and followed the guidelines in How to Develop Agents and check the following things

1. Tested your agent locally and verified its functionality

2. Organized agent files according to the required structure

3. Configured the correct versioning in your agent's configuration file

After you develop your agents locally and organize the agent files in the structure, you can run the following file to upload your agent.

python cerebrum/example/upload_agent_demo.py --agent_path <the absolute path for your agent folder>

For example, if you run the following command

python cerebrum/example/upload_agent_demo.py --agent_path /home/user/xxx/Cerebrum/cerebrum/example/agents/academic_agent

It is expected to show the following feedback if your agent has been uploaded successfully.

Successfully uploaded example.

It is important to mention that the version guidelines as below

Version Format

• Follow semantic versioning (MAJOR.MINOR.PATCH)

• Example: 1.0.0, 1.1.0, 2.0.0

Important Version Rules

1. Immutable Versions: Similar to PyPI packages and Huggingface models, uploaded agent versions are immutable and cannot be modified

2. Version Updates: To upload changes:

   • Increment the version number in your agent's config.json

   • Major version (X.0.0): Breaking changes

   • Minor version (0.X.0): New features, backward compatible

   • Patch version (0.0.X): Bug fixes