> For the complete documentation index, see [llms.txt](https://vibemx.gitbook.io/neuronai-studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vibemx.gitbook.io/neuronai-studio/readme.md).

# Introduction

**NeuronAI Studio** is a visual AI agent builder for Laravel. Design agents, compose workflow graphs, test them in a browser-based studio, and export production-ready PHP classes powered by [Neuron AI](https://docs.neuron-ai.dev).

Think of it as three layers working together:

| Layer         | Purpose                                                                                |
| ------------- | -------------------------------------------------------------------------------------- |
| **Studio UI** | Create and edit agents, tools, MCP servers, and workflows visually                     |
| **Runtime**   | Execute agents and workflows from the UI with streaming, traces, and human-in-the-loop |
| **Export**    | Generate Neuron `Agent` and `Workflow` PHP classes for your production codebase        |

## Requirements

* PHP 8.2+
* Laravel 11, 12, or 13
* [neuron-core/neuron-ai](https://docs.neuron-ai.dev/overview/getting-started)

## Architecture

```mermaid
flowchart TB
    subgraph hostApp [Host Laravel App]
        StudioUI[Studio UI Livewire + React]
        DB[(Studio DB)]
        Config[config/neuron.php + neuronai-studio.php]
    end
    subgraph runtime [Runtime Layer]
        AgentRunner[AgentRunner]
        WorkflowRunner[WorkflowRunner]
        NodeExecutors[Node Executors]
    end
    subgraph neuron [Neuron AI]
        Providers[LLM Providers]
        Tools[Tools + MCP]
    end
    StudioUI --> DB
    StudioUI --> AgentRunner
    StudioUI --> WorkflowRunner
    WorkflowRunner --> NodeExecutors
    AgentRunner --> Providers
    NodeExecutors --> AgentRunner
    NodeExecutors --> Tools
    Config --> Providers
```

The studio stores definitions in your database. At runtime, `AgentRunner` and `WorkflowRunner` hydrate Neuron AI providers and tools on the fly. When you are ready for production, exporters generate typed PHP classes under `app/Neuron`.

> **Screenshot pending:** Dashboard overview with stats cards and recent workflow traces.
>
> Asset path: `docs/assets/screenshots/dashboard-overview.png` Capture: `/neuronai-studio` — dark theme, 1440×900

## Feature map

| Feature                  | Guide                                                                                       |
| ------------------------ | ------------------------------------------------------------------------------------------- |
| Install & configure      | [Installation](/neuronai-studio/getting-started/installation.md)                            |
| AI coding assistants     | [AI-Assisted Development](/neuronai-studio/getting-started/ai-assisted-development.md)      |
| Create your first agent  | [Quickstart: First Agent](/neuronai-studio/getting-started/quickstart-first-agent.md)       |
| Build a workflow graph   | [Quickstart: First Workflow](/neuronai-studio/getting-started/quickstart-first-workflow.md) |
| Dashboard overview       | [Dashboard](/neuronai-studio/guides/dashboard.md)                                           |
| Agent CRUD & playground  | [Agents](/neuronai-studio/agents/overview.md)                                               |
| Custom & webhook tools   | [Tools](/neuronai-studio/tools/overview.md)                                                 |
| Knowledge bases & RAG    | [Knowledge Bases](/neuronai-studio/knowledge-bases/overview.md)                             |
| MCP server connectors    | [MCP Servers](/neuronai-studio/mcp-servers/overview.md)                                     |
| Visual workflow editor   | [Workflows](/neuronai-studio/workflows/overview.md)                                         |
| Pre-built templates      | [Templates](/neuronai-studio/workflows/templates.md)                                        |
| Export to PHP            | [Export & Production](/neuronai-studio/workflows/export-and-production.md)                  |
| Auth & security          | [Security & Access](/neuronai-studio/workflows/security-and-access.md)                      |
| Cost estimation          | [Cost Estimation](/neuronai-studio/analytics/costs.md)                                      |
| Full config reference    | [Configuration](/neuronai-studio/reference/configuration.md)                                |
| Extend with custom nodes | [Custom Node Types](/neuronai-studio/extending/custom-node-types.md)                        |

## Quick install

```bash
composer require digitalelvis/neuronai-studio neuron-core/neuron-ai
php artisan neuronai-studio:install
```

Open `/neuronai-studio` (prefix configurable via `NEURONAI_STUDIO_ROUTE_PREFIX`).

See [Installation](/neuronai-studio/getting-started/installation.md) for the full setup guide.

## Contributing

We welcome contributions! See [CONTRIBUTING.md](https://github.com/digitalelvis/neuronai-studio/tree/main/CONTRIBUTING.md) in the repository root for development setup, branch conventions, and documentation guidelines.

## License

MIT — see [LICENSE](https://github.com/digitalelvis/neuronai-studio/tree/main/LICENSE/README.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://vibemx.gitbook.io/neuronai-studio/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.