> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Neuron AI

> 在 PHP 中让 Neuron AI 代理进行网页搜索，并以 Markdown 格式读取页面

<Note>
  **Neuron AI 官方文档：** [docs.neuron-ai.dev/agent/tools](https://docs.neuron-ai.dev/agent/tools)

  借助 Firecrawl，为 PHP 代理提供网页搜索和页面读取能力
</Note>

<h2 id="overview">
  概览
</h2>

[Neuron AI](https://neuron-ai.dev) 是一个面向 PHP 的代理式框架，内置了 Firecrawl 工具包，让 Neuron 代理能够在运行过程中进行网页搜索，并以干净的 Markdown 格式读取任意页面。

<h2 id="quick-start">
  快速开始
</h2>

1. 安装 Neuron AI 4.1.3 或更高版本：

```bash theme={null}
composer require neuron-core/neuron-ai:^4.1.3
```

2. 在 [Firecrawl Dashboard](https://www.firecrawl.dev/app/api-keys) 中获取 API 密钥，并将其设置为 `FIRECRAWL_API_KEY`
3. 将该 工具包 添加到你的代理中：

```php theme={null}
namespace App\Neuron;

use NeuronAI\Agent\Agent;
use NeuronAI\Tools\Toolkits\Firecrawl\FirecrawlToolkit;

class ResearchAgent extends Agent
{
    ...

    protected function tools(): array
    {
        return [
            FirecrawlToolkit::make(
                key: getenv('FIRECRAWL_API_KEY')
            ),
        ];
    }
}
```

<h2 id="tools">
  工具
</h2>

| 工具 | 代理看到的名称 | 功能 |
| - | - | - |
| `FirecrawlSearchTool` | `web_search` | 搜索网页 (代理需要时也可搜索新闻) ，可选指定时间范围 |
| `FirecrawlScrapeTool` | `url_reader` | 以 Markdown 格式返回页面的主要内容 |

你也可以单独添加其中任一工具，例如 `FirecrawlSearchTool::make(key: getenv('FIRECRAWL_API_KEY'))`。

<h2 id="get-page-content-with-each-search-result">
  在每个搜索结果中获取页面内容
</h2>

默认情况下，搜索会返回每个结果的标题、URL 和描述。传入 `scrapeOptions` 后，每个结果还会附带 Markdown 格式的完整页面内容，代理无需再发起一次调用来读取页面：

```php theme={null}
use NeuronAI\Tools\Toolkits\Firecrawl\FirecrawlSearchTool;

FirecrawlSearchTool::make(key: getenv('FIRECRAWL_API_KEY'))->withOptions([
    'limit' => 5,
    'scrapeOptions' => [
        'formats' => ['markdown'],
        'onlyMainContent' => true,
    ],
]);
```

`withOptions()` 会覆盖默认值，并支持任意[搜索参数](/zh/api-reference/endpoint/search)。搜索查询始终由代理提供。

<h2 id="resources">
  资源
</h2>

* [Neuron AI 工具与工具包](https://docs.neuron-ai.dev/agent/tools)
* [Firecrawl 搜索文档](/zh/features/search)
* [Firecrawl 抓取文档](/zh/features/scrape)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.