Simplest Agent Framework with Stateful Tools

中文

| Documentation | Discord |

---

CoreAgent is a lightweight and intuitive framework designed to make building intelligent agents straightforward. Focusing on simplicity, CoreAgent allows you to quickly integrate language models with custom tools to create powerful and versatile applications.

Stateful Tools

Introducing Stateful Tools, which can be shared across multiple agents.

from coreagent import Agent

class MyStatefulTool:
  def __init__(self):
    self.state = 0
  def add_state(self, n: int):
    self.state += n
  def get_state(self):
    return self.state

# single shared tool! 
shared_tool = MyStatefulTool()

agent_1 = Agent.with_tools(shared_tool)
agent_2 = Agent.with_tools(shared_tool)
agent_1.chat("add by 10")
agent_2.chat("what's current state? ")

Installation

To install CoreAgent, simply use pip:

pip install coreagent

Getting Started

Try out simple guard_and_theif.py example with OpenAI official endpoint:

python ./examples/guard_and_theif.py \
  -u "https://api.openai.com/v1/" \
  -m "gpt-3.5-turbo" \
  -k "...API KEY..." \
  --verbose

With DeepSeek official endpoint:

python examples/toolgen.py \
  -u "https://api.deepseek.com" \
  -k "sk-..." \
  -m deepseek-reasoner \
  --verbose

Now, you can start integrating CoreAgent to your project:

from coreagent import Agent, set_default_config_from_args
import urllib.request
import json

# read common arguments (--api-base-url/-u, --api-key/-k, --model/-m, --verbose/-v, --guided/-g)
set_default_config_from_args()

class IPTool:
  def get_my_ip(self) -> str:
    j = json.loads(urllib.request.urlopen("https://api.ipify.org/?format=json").read().decode())
    return j['ip']

s = Agent()
s.register_tool(IPTool())

s.chat("What's my IP address? ")

Roadmap

• Basic universal agent framework.
• Make guided_grammar optional, allow general LLM usage (DeepSeek API, GPT3.5/4/4o API, Qwen API, etc. )
• More intuitive simplified examples, allowing hands-on try-outs.
• Multi-modal input.
• RAG-based memory module.
• Integrate MCP client module. (MCP is just a propaganda, useless stuff)

Contributing

Contributions to CoreAgent are welcome! If you have ideas for improvements, bug fixes, or new features, please feel free to open an issue or submit a pull request.

License

Brought to you by Shanghai Glacies Technologies Co,. LTD.
GNU Lesser General Public License v3.0 https://www.gnu.org/licenses/lgpl-3.0.en.html

Star History