agent-orcha 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,6 +1,21 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/assets/images/logo.png" alt="Agent Orcha Logo" width="300">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
1
5
|
# Agent Orcha
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
Agent Orcha is a declarative framework designed to build, manage, and scale multi-agent AI systems with ease. It combines the flexibility of TypeScript with the simplicity of YAML to orchestrate complex workflows, manage diverse tools via MCP, and integrate semantic search seamlessly. Built for developers and operators who demand reliability, extensibility, and clarity in their AI operations.
|
|
8
|
+
|
|
9
|
+
## Why Agent Orcha?
|
|
10
|
+
|
|
11
|
+
- **Declarative AI**: Define agents, workflows, and infrastructure in clear, version-controlled YAML files. No more spaghetti code.
|
|
12
|
+
- **Model Agnostic**: Seamlessly swap between OpenAI, Gemini, Anthropic, or local LLMs (Ollama, LM Studio) without rewriting logic.
|
|
13
|
+
- **Universal Tooling**: Leverage the **Model Context Protocol (MCP)** to connect agents to any external service, API, or database instantly.
|
|
14
|
+
- **RAG Native**: Built-in vector store integration (Chroma, Memory) makes semantic search and knowledge retrieval a first-class citizen.
|
|
15
|
+
- **Robust Workflow Engine**: Orchestrate complex multi-agent sequences with parallel execution, conditional logic, dynamic input interpolation, and state management.
|
|
16
|
+
- **Production Ready**: Includes a high-performance Fastify REST API, Server-Sent Events (SSE) for real-time streaming, and comprehensive logging.
|
|
17
|
+
- **Developer Experience**: Fully typed interfaces, intuitive CLI tooling, and a modular architecture designed for rapid iteration from prototype to production.
|
|
18
|
+
- **Extensible Functions**: Drop in simple JavaScript functions to extend agent capabilities with zero boilerplate.
|
|
4
19
|
|
|
5
20
|
## Overview
|
|
6
21
|
|
|
@@ -12,6 +27,11 @@ Agent Orcha enables you to:
|
|
|
12
27
|
- **Connect MCP servers** to extend agent capabilities with external tools
|
|
13
28
|
- **Create local Functions** give your agents the ability to call your own custom code
|
|
14
29
|
|
|
30
|
+
### Alpha Status and Security Notice
|
|
31
|
+
|
|
32
|
+
**This project is currently in ALPHA state.** No security precautions have been implemented yet. This software should **ALWAYS** be deployed behind a firewall without open access to its APIs. It is designed for **internal use only** and should never be exposed directly to the public internet.
|
|
33
|
+
|
|
34
|
+
|
|
15
35
|
## Usage
|
|
16
36
|
- **Use as is** check out and run
|
|
17
37
|
- **Use as a library** in your TypeScript/JavaScript projects
|
|
@@ -882,36 +902,6 @@ The workflow flow diagram visualizes:
|
|
|
882
902
|
- Tool badges (MCP servers, vector databases)
|
|
883
903
|
- Input/output nodes
|
|
884
904
|
|
|
885
|
-
## Publishing to npm
|
|
886
|
-
|
|
887
|
-
To publish this package to npm:
|
|
888
|
-
|
|
889
|
-
1. **Build the package:**
|
|
890
|
-
```bash
|
|
891
|
-
npm run build
|
|
892
|
-
```
|
|
893
|
-
|
|
894
|
-
2. **Update version in package.json:**
|
|
895
|
-
```bash
|
|
896
|
-
npm version patch # or minor, or major
|
|
897
|
-
```
|
|
898
|
-
|
|
899
|
-
3. **Publish to npm:**
|
|
900
|
-
```bash
|
|
901
|
-
npm publish
|
|
902
|
-
```
|
|
903
|
-
|
|
904
|
-
The package includes:
|
|
905
|
-
- Compiled TypeScript code (`dist/`)
|
|
906
|
-
- CLI executable (`bin/cli.js`)
|
|
907
|
-
- Template files for `init` command (`templates/`)
|
|
908
|
-
- Web UI (`public/`)
|
|
909
|
-
- Type definitions
|
|
910
|
-
|
|
911
|
-
Users can then:
|
|
912
|
-
- Use as CLI: `npx agent-orcha init`
|
|
913
|
-
- Install as library: `npm install agent-orcha`
|
|
914
|
-
|
|
915
905
|
## License
|
|
916
906
|
|
|
917
907
|
MIT
|
package/package.json
CHANGED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
name: example-chroma
|
|
2
|
-
description: Example vector store using Chroma for persistent storage
|
|
3
|
-
|
|
4
|
-
source:
|
|
5
|
-
type: directory
|
|
6
|
-
path: vectors/sample-data
|
|
7
|
-
pattern: "*.txt"
|
|
8
|
-
recursive: false
|
|
9
|
-
|
|
10
|
-
loader:
|
|
11
|
-
type: text
|
|
12
|
-
|
|
13
|
-
splitter:
|
|
14
|
-
type: character
|
|
15
|
-
chunkSize: 1000
|
|
16
|
-
chunkOverlap: 200
|
|
17
|
-
|
|
18
|
-
embedding: default # References embedding config in llm.json
|
|
19
|
-
|
|
20
|
-
store:
|
|
21
|
-
type: chroma
|
|
22
|
-
options:
|
|
23
|
-
# Path where Chroma will store data (relative to project root)
|
|
24
|
-
# Default: .chroma
|
|
25
|
-
path: .chroma
|
|
26
|
-
|
|
27
|
-
# Collection name for this vector store
|
|
28
|
-
# Default: uses the vector store name
|
|
29
|
-
collectionName: example-chroma
|
|
30
|
-
|
|
31
|
-
# Chroma server URL
|
|
32
|
-
# Default: http://localhost:8000
|
|
33
|
-
# Note: You need to run Chroma server separately
|
|
34
|
-
# Docker: docker run -p 8000:8000 chromadb/chroma
|
|
35
|
-
url: http://localhost:8000
|
|
36
|
-
|
|
37
|
-
search:
|
|
38
|
-
defaultK: 4
|
|
39
|
-
scoreThreshold: 0.2
|
|
40
|
-
|
|
41
|
-
metadata:
|
|
42
|
-
category: example
|
|
43
|
-
persistence: chroma
|