Skip to content

Commit 52afaa8

Browse files
committed
Refactor README
1 parent c95af33 commit 52afaa8

File tree

8 files changed

+22
-31
lines changed

8 files changed

+22
-31
lines changed

README.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,33 @@
1-
<p align="center">
2-
<!-- TODO: replace logo asset file when new branding asset is available -->
3-
<img src="assets/singularityio-logo.svg" alt="manifold logo (update asset)" width="200" />
4-
</p>
5-
61
# manifold
72

8-
Manifold is a platform for creating and managing AI assistants.
3+
Manifold is a platform for enabling workflow automation using AI assistants.
94

105
## Features
116

12-
- **Two Binaries**: `agent` (CLI) and `agentd` (HTTP server with web UI)
13-
- **Safe Execution**: Tool calling with secure executor (no shell) in locked WORKDIR
14-
- **Built-in Tools**: run_cli, web_search, web_fetch, write_file, llm_transform
15-
- **Database Integration**: PostgreSQL with PGVector, PostGIS, and PGRouting
16-
- **MCP Support**: Model Context Protocol client for external tool providers
17-
- **Observability**: Structured logging, OpenTelemetry traces and metrics
18-
- **Auth/RBAC**: OIDC authentication and RBAC support
7+
### **Agent Chat**: Use a traditional chat view to instructs agents to work on objectives.
8+
9+
![chat](docs/img/manifold_chat.png)
10+
11+
### **Specialist Registry**: Define and configure AI agents (specialists) and build your team of experts.
12+
13+
![specialists](docs/img/manifold_specialists.jpg)
14+
15+
### **Projects**: Configure projects as agent workspaces.
16+
17+
![specialists](docs/img/manifold_projects.jpg)
1918

20-
## Requirements
19+
### **Integrated tools and MCP Support**: Manifold implements internal tools for agent workflows as well as MCP support to extend the capabilities of your agents.
2120

22-
- Go 1.21+ (recommended: Go 1.24+)
23-
- OpenAI API key or compatible local or public endpoint
24-
- PostgreSQL with required extensions. We recommend deploying a Postgres instance using the Dockerfile at `deploy/docker/postgres.Dockerfile`.
25-
- Google Chrome (or a Chromium-compatible browser) installed — required for the web tools to work.
21+
### **Workflow Editor**: Design agent workflows using a visual flow editor.
22+
23+
![specialists](docs/img/manifold_flow_02.jpg)
24+
25+
![specialists](docs/img/manifold_flow_01.jpg)
26+
27+
### **Prompts, Datasets and Experiments Playground**: Create, iterate and version custom prompts that can be assigned to your agents. Configure datasets and run experiments to understand how prompts affect agent behaviors.
28+
29+
![specialists](docs/img/manifold_playground.jpg)
2630

2731
## Quick Start
2832

2933
For step-by-step quick start instructions, see the repository Quick Start guide: [QUICKSTART.md](./QUICKSTART.md)
30-
31-
## Documentation
32-
33-
- [Configuration](docs/configuration.md) - Environment variables and YAML configuration
34-
- [Running](docs/running.md) - Detailed usage instructions for agent and agentd
35-
- [Tools](docs/tools.md) - Built-in and custom tools
36-
- [Database](docs/database.md) - Database setup and configuration
37-
- [MCP Client](docs/mcp.md) - Model Context Protocol integration
38-
- [Specialists & Routing](docs/specialists.md) - Route requests to specialized endpoints
39-
- [Security](docs/security.md) - Security features and best practices
40-
- [Observability](docs/observability.md) - Logging, tracing, and monitoring
41-
- [Development](docs/development.md) - Development setup and contributing
42-
- [Authentication](docs/auth.md) - OIDC and session management

docs/img/manifold_chat.png

1.17 MB
Loading

docs/img/manifold_flow_01.jpg

681 KB
Loading

docs/img/manifold_flow_02.jpg

851 KB
Loading
334 KB
Loading

docs/img/manifold_playground.jpg

406 KB
Loading

docs/img/manifold_projects.jpg

1.28 MB
Loading

docs/img/manifold_specialists.jpg

799 KB
Loading

0 commit comments

Comments
 (0)