mada 0.1.0__tar.gz

mada-0.1.0/LICENSE

@@ -0,0 +1,207 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2018, Lawrence Livermore National Security, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions of this Software are embedded into an Object form of such source code, you may redistribute such embedded portions in such Object form without complying with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with software that is licensed under the GPLv2 ("Combined Software") and if a court of competent jurisdiction determines that the patent provision (Section 3), the indemnity provision (Section 9) or other Section of the License conflicts with the conditions of the GPLv2, you may retroactively and prospectively choose to deem waived or otherwise exclude such Section(s) of the License, but only in their entirety and only with respect to the Combined Software.

mada-0.1.0/PKG-INFO

@@ -0,0 +1,354 @@
+Metadata-Version: 2.4
+Name: mada
+Version: 0.1.0
+Summary: Multi-agent orchestration system for MADA workflows
+License-Expression: Apache-2.0 WITH LLVM-exception
+Project-URL: Homepage, https://github.com/llnl/mada
+Project-URL: Documentation, https://software.llnl.gov/mada
+Project-URL: Issues, https://github.com/llnl/mada/issues
+Project-URL: Release Notes, https://github.com/llnl/mada/releases
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: agent-framework>=1.0.1
+Requires-Dist: autogen-ext[mcp]>=0.7.4
+Requires-Dist: fastapi
+Requires-Dist: gradio>=6.2.0
+Requires-Dist: openai
+Requires-Dist: python-dotenv
+Requires-Dist: psycopg2
+Requires-Dist: tiktoken
+Requires-Dist: uvicorn
+Requires-Dist: click
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-asyncio; extra == "tests"
+Requires-Dist: jeds-cli; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: markdown-grid-tables; extra == "docs"
+Requires-Dist: mkdocs<2.0.0; extra == "docs"
+Requires-Dist: mkdocs-codeinclude-plugin; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs-glightbox; extra == "docs"
+Requires-Dist: mkdocs-literate-nav; extra == "docs"
+Requires-Dist: mkdocs-gen-files; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Provides-Extra: all
+Requires-Dist: mada[docs,tests]; extra == "all"
+Dynamic: license-file
+
+# MADA
+
+Multi-agent orchestration system for coordinating complex engineering workflows using MCP (Model Context Protocol) servers.
+
+## Overview
+
+MADA coordinates multiple specialized agents to execute complex engineering workflows. Each agent connects to MCP servers that provide domain-specific tools for simulation, geometry, job management, and inverse design.
+
+
+### Project Structure
+
+```
+mada/
+├── src/mada/
+│   ├── core/                 # Core orchestration logic
+│   │   ├── config.py         # Configuration classes
+│   │   ├── coordinator.py    # Agent coordination base class
+│   │   ├── model_client.py   # LLM client factory
+│   │   ├── orchestrator.py   # Main multi-agent orchestrator
+│   │   └── utils.py          # Utility functions
+│   ├── interfaces/           # User interfaces
+│   │   ├── cli/              # Command-line interface
+│   │   │   └── main.py       # CLI implementation
+│   │   ├── openai_api/       # OpenAI-compatible HTTP API
+│   │   │   └── main.py       # FastAPI launcher
+│   │   └── gradio/           # Web interface
+│   │       ├── interface.py  # Gradio interface components
+│   │       ├── mcp_client_wrapper.py # MCP client session
+│   │       └── main.py       # Gradio launcher
+│   └── main.py               # Main entry point
+├── configs/                  # Configuration files
+│   └── orchestrator_config.json # Main configuration
+├── examples/                 # Usage examples
+│   └── basic_usage.py        # Basic usage example
+└── pyproject.toml            # Package configuration
+```
+
+## Architecture
+
+### Core Components
+
+- **Orchestrator** (`src/mada/core/orchestrator.py`) - Main coordination engine
+- **Agents** - Specialized agents for different domains
+- **MCP Servers** - External tool providers 
+- **Interfaces** - CLI, Gradio web, and OpenAI-compatible API interfaces
+
+
+## Installation
+
+
+```bash
+# Clone the repository
+git clone https://github.com/llnl/mada.git
+cd mada
+```
+
+
+```bash
+# Create python virtual environment
+python -m venv venv
+source venv/bin/activate
+
+# Install dependencies (--pre required for agent-framework pre-release)
+pip install --pre -e .
+```
+
+
+## Prerequisites
+
+1. **MCP Servers**: Install and configure MADA Tools:
+   ```bash
+   # SSH access (preferred)
+   git clone git@github.com:llnl/mada-tools.git
+   
+   # HTTPS access (alternative)
+   git clone https://github.com/llnl/mada-tools.git
+   ```
+
+2. **Install**: Install mada-tools following README
+
+## Configuration
+
+### Main Configuration
+
+MADA uses a single JSON configuration file that defines all agents and their MCP server connections. The configuration file specifies:
+
+- **Model settings**: LLM model, API credentials, and connection details
+- **Agent definitions**: Specialized agents and their MCP server connections  
+- **MCP server endpoints**: Transport types, URLs, and descriptions
+- **Orchestration settings**: Timeouts, concurrency limits, coordination options
+- **Interface configuration**: UI titles, descriptions, and placeholders
+
+See [`configs/mada_config.json`](configs/mada_config.json) for the complete configuration.
+
+### Environment Variables
+
+MADA uses environment variables for API credentials, which are referenced in the configuration file. Set these environment variables:
+
+```bash
+# Required: LLM API configuration
+export API_KEY="your-api-key"
+export API_BASE_URL="https://api.openai.com/v1/responses"  # or your preferred endpoint
+```
+
+These are referenced in the config file using environment variable expansion:
+```json
+{
+  "model": {
+    "model": "gpt-4o",
+    "api_key": "${API_KEY}",
+    "base_url": "${API_BASE_URL:-https://livai-api.llnl.gov/v1}"
+  }
+}
+```
+
+### MCP Server Setup
+
+Ensure MCP servers are running on the expected ports. From the mada-tools directory:
+
+```bash
+# Start individual servers
+mada-mcp-flux --port 8001 &
+mada-mcp-professor --port 8005 &
+
+# Or start with specific config
+mada-mcp-flux --config configs/development.json --port 8001 &
+```
+
+**Important**: Update the MCP server URLs in your `mada_config.json` to point to the correct endpoints where your servers are running. The default configuration assumes servers are running locally on ports 8001-8005.
+
+## Usage
+
+### CLI Interface
+
+Launch the interactive command-line interface:
+
+```bash
+# Using the CLI entry point
+mada-cli configs/mada_config.json
+
+# Or using the module directly
+python -m mada.interfaces.cli.main configs/mada_config.json
+```
+
+The CLI provides an interactive prompt where you can chat directly with the multi-agent team.
+
+### Gradio Web Interface
+
+Launch the web-based interface:
+
+```bash
+# Using the Gradio entry point
+mada-gradio configs/mada_config.json
+
+# Or using the module directly
+python -m mada.interfaces.gradio.main configs/mada_config.json
+```
+
+The web interface will be available at `http://localhost:7860`.
+
+### OpenAI-Compatible API
+
+Launch the OpenAI-compatible API server:
+
+```bash
+# Using the dedicated entry point
+mada-openai-api configs/orchestrator_config.json
+
+# Or using the main entry point
+mada openai-api configs/orchestrator_config.json
+```
+
+The API will be available at `http://localhost:8000/v1` and can be connected directly from Open WebUI or any other OpenAI-compatible client.
+
+## Examples
+
+### Basic Usage
+
+Get started quickly with the basic example:
+
+```bash
+# Basic CLI interface using main configuration
+python examples/basic_usage.py
+```
+
+## Example User Commands
+
+Once MADA is running, you can interact with the multi-agent team using natural language commands. Below are some general commands you can try out:
+
+**Ask about available agents:**
+```
+what are the agents
+```
+
+**Check job status:**
+```
+What is the status of my running jobs?
+```
+
+### Adding New Agents
+
+1. Add agent configuration to `mada_config.json`:
+   ```json
+   {
+     "agent_name": "new_agent",
+     "description": "Description of what this agent does",
+     "mcp_servers": ["server1", "server2"],
+     "domain": "agent_domain",
+     "instructions": "Custom system prompt for this agent"
+   }
+   ```
+2. Ensure the MCP servers the agent needs are running
+3. MADA will automatically create and manage the agent
+
+### Adding New MCP Servers
+
+1. Create the MCP server using the [`mada-tools` repository](https://github.com/llnl/mada-tools)
+2. Add server definition to `mcp_servers` section in `mada_config.json`:
+   ```json
+   {
+     "mcp_servers": {
+       "new_server": {
+         "transport": "streamable-http",
+         "url": "http://localhost:8006",
+         "description": "Description of the server"
+       }
+     }
+   }
+   ```
+3. Update agent's `mcp_servers` list to include the new server
+4. Start the server on the specified port
+
+
+## Troubleshooting
+
+### Common Issues
+
+#### MCP Server Connection Failed
+
+   - Verify servers are running on expected ports
+   - Ensure transport type matches server configuration
+
+#### API Key Issues
+
+   - Verify `API_KEY` environment variable is set. If using LivAI's endpoint, request a LivAPI key.
+   - Confirm `API_BASE_URL` is correct
+
+#### Agent Initialization Failed
+
+   - Check agent configuration in JSON file
+   - Verify required MCP servers are available
+
+
+#### "Address already in use" Error
+
+If you see an error like:
+
+```
+bind [127.0.0.1]:7860: Address already in use
+```
+
+it means port 7860 on your local machine is already occupied by another process. To free it:
+
+Identify which process is listening on 7860
+
+```
+lsof -iTCP:7860 -sTCP:LISTEN
+```
+
+Suppose the output shows PID 12345, then kill it:
+
+```
+kill -9 12345
+```
+
+After freeing the port, try setting up the SSH tunnel again.
+
+#### Gradio timeout
+
+Use Safari.
+
+
+#### SSL certificate errors
+
+If you encounter SSL errors (which sometimes surface as an "Agent error") update your certificate bundle:
+
+```
+python_cert_path=$(python -c "import certifi; print(certifi.where())")
+cat /etc/ssl/certs/ca-bundle.crt >> "$python_cert_path"
+```
+
+
+## Related Projects
+
+- **MADA Tools**: AI tooling for MADA
+  - SSH: `git@github.com:llnl/mada-tools.git`
+  - HTTPS: `https://github.com/llnl/mada-tools.git`
+- [Microsoft Agent Framework](https://github.com/microsoft/agent-framework): Multi-agent orchestration framework
+- [MCP](https://modelcontextprotocol.io/): Model Context Protocol specification
+
+
+## Release
+
+MADA is distributed under the terms of the Apache License (Version 2.0) WITH LLVM Exception.
+
+All new contributions must be made under the Apache 2.0 License WITH LLVM Exception.
+
+See [LICENSE](./LICENSE), [COPYRIGHT](./COPYRIGHT), and [NOTICE](./NOTICE) for details.
+
+SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+LLNL-CODE-2019927