内容
<div align="center">
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/aries-wordmark.png" />
<img alt="Aries" src="assets/aries-wordmark-ink.png" width="300" />
</picture>
</p>
<p align="center">
<img src="assets/aries-logo-tagline.png" alt="Aries — 烷烃 + 亚冻土" width="270" />
</p>
### 让任何AI助手都能熟练构建烷烃 + 亚冻土
[](#license)
[](https://modelcontextprotocol.io)
[](https://www.typescriptlang.org)
[](https://nodejs.org)
**[使用托管的Aries API · bragi.build/aries](https://bragi.build/aries)**
</div>
---
Aries 是一个 [模型上下文协议](https://modelcontextprotocol.io) 服务器,为任何支持MCP的助手(如 **Claude Code, Claude Desktop, Cursor**)提供一个知识和实时链数据层,用于 **烷烃** 元协议和 **亚冻土** 网络。指向Aries,助手可以直接读取协议文档,查询实时链数据,并在无需离开编辑器的情况下构建合约。
使用Aries有两种方式:**托管API**(推荐)和 **自带密钥的本地安装**。
---
## 托管API — 活跃的Aries
> ### [订阅托管Aries · bragi.build/aries](https://bragi.build/aries)
托管版现已上线,提供完整的Aries功能。它是一个 **持续学习的实例**,在基线文档之上,它还拥有一个 **不断增长的现实世界经验库** —— 由每个连接的代理贡献的审阅事件知识,新鲜的本地克隆不具备此功能。连接一个URL,您的助手就会继承整个共享大脑,它每天都在变得更智能。
| | |
| --- | --- |
| **实时知识库** | 累积的、审阅过的现实世界经验和修复方法 —— 不仅仅是静态文档。 |
| **零配置** | 无需克隆、无需构建、无需配置密钥。连接即可使用。 |
| **分级、托管访问** | 从免费层到生产吞吐量,速率限制由我们处理。 |
| **始终保持最新** | 知识库和工具在服务端更新。 |
您更喜欢自己运行所有内容吗?此仓库中的开放、自带密钥版本如下。
## 托管 vs. 本地
两个版本都包含相同的 **21 个工具** 和 **75 个文档基线**。区别在于 **实时知识库** —— 以及谁管理密钥。
| | 托管 · [bragi.build/aries](https://bragi.build/aries) | 本地 · 此仓库 |
| --- | --- | --- |
| 所有 21 个工具 | 是 | 是 |
| 75 个文档基线知识 | 是 | 是 |
| 实时亚冻土链数据 | 是 — 托管 | 是 — 您自己的密钥 |
| **现实世界经验库** | **是 — 不断增长** | 否 |
| 累积事件学习 | 是 | 否(仅本地存储) |
| 配置 | 连接一个URL | 克隆、安装、构建 |
| 亚冻土密钥 | 为您托管 | 您提供 |
| 访问 | 免费到生产层 | 无限制、本地 |
本地版本为您提供一个完整的、独立的伴侣,基于 **静态** 基线。托管版本在此基础上添加了 **持续学习的脑**。您可以从本地开始,当您需要实时知识库时,切换到 [托管](https://bragi.build/aries)。
---
## 在本地运行(自带密钥)
克隆此仓库,并在您的机器上使用您自己的 **亚冻土API密钥** 运行Aries。您将获得完整的工具集和完整的 **75个文档静态基线知识** —— 但不包括托管实例的累积学习。
### 获取亚冻土API密钥
Aries使用您的密钥与亚冻土网关通信。
> **[注册亚冻土API密钥](https://api.subfrost.io/auth/signup?ref=82D1DE7C)** —
> 使用我们的亚冻土推荐链接注册并获得 **第一个月的50%折扣**。
### 快速开始
**要求:** [Node.js](https://nodejs.org) >= 20 和一个
[亚冻土API密钥](https://api.subfrost.io/auth/signup?ref=82D1DE7C) (使用我们的推荐链接注册可获得 **第一个月的50%折扣**)。
```bash
git clone https://github.com/bitbragi/alkanes-aries.git
cd alkanes-aries
npm install
cp .env.example .env # 然后设置SUBFROST_API_KEY(见下文)
npm run build
```
在 `.env` 中设置您的密钥:
```bash
SUBFROST_API_KEY=您的密钥
# 可选覆盖:
# SUBFROST_RPC=https://mainnet.subfrost.io/v4/jsonrpc
```
密钥作为 `x-subfrost-api-key` 头部发送(从不出现在URL中),并且永远不会离开您的机器。 `.env` 被git忽略。
### 连接您的MCP客户端
**Claude Code**
```bash
claude mcp add --scope local --transport stdio aries \
-e SUBFROST_API_KEY=您的密钥 \
-- node /绝对路径/to/alkanes-aries/dist/index.js
```
使用 `claude mcp list` 验证,然后在会话中使用 `/mcp`。( `--` 分隔Claude的标志和启动命令;保持 `-e KEY=value` 在 `--` 之前 — 它是可变的,否则会吞噬服务器名称。)
**Cursor / Claude Desktop** — 任何接受JSON服务器配置的客户端:
```json
{
"mcpServers": {
"aries": {
"command": "node",
"args": ["/绝对路径/to/alkanes-aries/dist/index.js"],
"env": { "SUBFROST_API_KEY": "您的密钥" }
}
}
}
```
现在,您的助手拥有所有21个Aries工具。
---
## 内部 — 21个工具,四层
| 层 | 工具 |
| --- | --- |
| **知识** — 一个可搜索的 **75个精选文档** 库:烷烃元协议,亚冻土JSON-RPC/REST参考,alkanes-rs,教程,预言机文档,参考合约 | `aries_search`, `aries_doc`, `aries_full_doc`, `aries_catalog`, `aries_tutorials` |
| **链数据** — 对亚冻土网关的实时只读查询:持有量,合约元数据,字节码,模拟,frBTC挂钩 + DIESEL状态,预言机读取,AMM池,保护的RPC | `aries_tokens_by_address`, `aries_token`, `aries_contract_meta`, `aries_bytecode`, `aries_simulate`, `aries_frbtc_status`, `aries_diesel_status`, `aries_oracle_read`, `aries_oracle_price`, `aries_pools`, `aries_pool_info`, `aries_rpc` |
| **开发** — 协议常量和合约脚手架,包括 `orbital` NFTs | `aries_constants`, `aries_scaffold` |
| **学习** — 一个本地事件循环,记录您工作时的错误 | `aries_incident_report`, `aries_incident_query` |
### 向您的助手提问,例如
> *"frBTC挂钩是否上线,谁是签名者,存在多少frBTC?*"*
>
> *"哪些烷烃代币持有 `bc1p…`?*"*
>
> *"显示AMM池和池的储备。*"*
>
> *"如何构建代币 / 预言机 / 稳定币 / AMM / Orbital?*"*
>
> *"为Orbital NFT合约搭建脚手架。*"*
---
## 安全 — 设计为只读
Aries **仅用于分析**。它从不签名、广播或触摸钱包或密钥:
- `aries_rpc` 直通 **仅限于读取方法**,明确阻止广播 / 支出 / 管理调用。
- 脚手架和常量由 **您** 在自己的 `alkanes` CLI中运行,您持有密钥。
- 本地事件循环仅写入您的机器,并从任何报告中净化秘密、密钥和路径。
您的密钥始终由您保管。Aries仅读取并提供建议。
---
## 配置
| 变量 | 目的 |
| --- | --- |
| `SUBFROST_API_KEY` | **必填** — 实时链数据工具的身份验证。 |
| `SUBFROST_RPC` / `SUBFROST_REST` | 可选的网关覆盖(默认为主网JSON-RPC / REST)。 |
| `ARIES_INCIDENTS_PATH` | 可选的本地事件存储路径(默认为 `data/incidents.jsonl`,被git忽略)。 |
日志仅输出到 **stderr** — stdout是MCP协议通道。文档索引在启动时从 `corpus/` 构建。
## 需要了解的事项
- 烷烃ID为 `{block, tx}` / `block:tx`。 frBTC = `32:0`,DIESEL(创世)= `2:0`。协议标签始终为 `1`。
- 使用 `aries_simulate` 读取合约状态:将opcode放入 `inputs` (例如 `[103]`),而不是 `data`。
- **轨道** (烷烃NFT)是一种 `Token`,总供应量为1 + opcode `1000` 用于媒体;使用 `aries_oracle_read` 读取,使用 `aries_scaffold orbital` 搭建。
## 链接
| | |
| --- | --- |
| 托管、持续学习的Aries | **[bragi.build/aries](https://bragi.build/aries)** |
| 亚冻土API密钥(第一个月50%折扣) | **[api.subfrost.io](https://api.subfrost.io/auth/signup?ref=82D1DE7C)** |
| 模型上下文协议 | **[modelcontextprotocol.io](https://modelcontextprotocol.io)** |
## 许可证
MIT