Skip to main content

A flexible, modular framework for researching engineering design AI agents

Project description

design-research-agents

CI Coverage Examples Passing Public API In Examples Docs

design-research-agents is a modular framework for prototyping and researching engineering design AI agents. It features shared runtime contracts, workflow orchestration, and pluggable LLM backends for quick iteration.

Overview

This library centers on a small set of composable pieces you can run, inspect, and test:

  • Two primary entry points: DirectLLMCall and MultiStepAgent (direct, json, and code modes)
  • A tool runtime built around Toolbox, with callable, script, and MCP-backed tool configs
  • Prebuilt orchestration patterns for plan/execute, debate, propose/critic, routing, beam search, RAG, blackboard, and conversations
  • Hosted and local LLM clients, plus ModelSelector for backend-selection policies
  • Tracing, structured ExecutionResult outputs, and runnable examples aimed at repeatable experiments
  • A workflow runtime with explicit step primitives for model calls, tool calls, delegation, loops, and memory

A Super Basic Agent

from design_research_agents import LlamaCppServerLLMClient, MultiStepAgent

with LlamaCppServerLLMClient() as llm_client:
    agent = MultiStepAgent(mode="direct", llm_client=llm_client, max_steps=3)
    result = agent.run(
        prompt="Suggest two design goals for a field-repairable drone battery latch.",
    )

print(result.final_output)

Quickstart

Requires Python 3.12+. Reproducible release installs are pinned to Python 3.12.12 (see .python-version).

python -m venv .venv
source .venv/bin/activate
make dev
make test
PYTHONPATH=src python3 examples/patterns/plan_execute.py

For frozen installs, optional extras, and release maintenance, see Dependencies and Extras.

Examples

Start with examples/README.md for runnable examples grouped by agents, clients, workflows, patterns, model selection, and tools.

Docs

See the documentation site for the full guide set, including quickstart, backend setup, workflows, patterns, and API reference.

Build docs locally with make docs.

Contributing

Contribution guidelines now live in CONTRIBUTING.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

design_research_agents-0.2.0.tar.gz (416.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

design_research_agents-0.2.0-py3-none-any.whl (409.5 kB view details)

Uploaded Python 3

File details

Details for the file design_research_agents-0.2.0.tar.gz.

File metadata

  • Download URL: design_research_agents-0.2.0.tar.gz
  • Upload date:
  • Size: 416.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for design_research_agents-0.2.0.tar.gz
Algorithm Hash digest
SHA256 dc4af4185d1dd214fdb9515e8798ddf2af727780558f1b80956df9e3c450f58b
MD5 39d96f4d5b2bb9ae644f9c333842afca
BLAKE2b-256 c3d523647e91741c6baa4265a227b28e2b6d47a66f28bbafd06898584fdee355

See more details on using hashes here.

Provenance

The following attestation bundles were made for design_research_agents-0.2.0.tar.gz:

Publisher: workflow.yml on cmudrc/design-research-agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file design_research_agents-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for design_research_agents-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad65a1e778014534bebf768b60d33f07e6cc6f5fb7cf473fbe62d0f897e7ee74
MD5 47c95fac75690b48bd70590f2a494ea1
BLAKE2b-256 6806aa9663783cf3e2e07138645584cf87cc6670e5c760fcfe5c1c1d11cabdb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for design_research_agents-0.2.0-py3-none-any.whl:

Publisher: workflow.yml on cmudrc/design-research-agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page