Built-in tools

Language: 简体中文 | 日本語 | 四川话 | English

Optional tools in pagent.defaults: clock, region, readfile, web_search, bash.

from pagent import Agent, LLM, Session, DEFAULT_TOOLS, bash, clock, readfile, region, web_search

agent = Agent(
    llm=LLM("gpt-4o-mini"),
    session=Session("You are helpful."),
    tools=[*DEFAULT_TOOLS],  # clock + region
    max_turns=8,
)

DEFAULT_TOOLS is [clock, region]. Add web_search yourself (needs extra install).

clock

Current time as ISO 8601.

tools=[clock]
# utc=True (default) or utc=False for local time

region

OS locale and timezone hint (no GPS).

tools=[region]

readfile

Read a UTF-8 text file under process cwd (absolute or relative path; ~ expanded). Up to 500 code points per call (max_chars). Use offset to read the next window when the header says continues at offset N.

tools=[readfile]
# readfile("src/pagent/defaults.py", max_chars=500, offset=0)
# readfile("src/pagent/defaults.py", max_chars=500, offset=500)

bash

Run a whitelisted command in process cwd (no shell). Currently only ls is allowed; path arguments must resolve under the workspace (same rules as readfile).

tools=[bash]
# bash("ls")
# bash("ls -la src")

web_search

Web search via DuckDuckGo.

pip install 'pagent[search]'

tools=[web_search]

See also

• Tools (write your own @tool)