README
🚀 ENS MCP 服务器
本项目是为以太坊名称服务(ENS)设计的MCP服务器,它能让Claude与ENS系统进行交互,实现域名解析、检查可用性、检索记录等功能。
npm 包:https://www.npmjs.com/package/mcp-server-ens
🚀 快速开始
本ENS MCP服务器可助力Claude与ENS系统交互,实现多种ENS相关功能。下面将详细介绍其使用方法。
✨ 主要特性
解析名称
将ENS名称解析为以太坊地址。
- 所需输入:
name(字符串):需解析的ENS名称(例如,'vitalik.eth')
- 返回:对应的以太坊地址或错误信息
反向查找
根据以太坊地址获取ENS名称。
- 所需输入:
address(字符串):需查询的以太坊地址
- 返回:对应的ENS名称或未找到名称的提示
获取文本记录
获取ENS名称的指定文本记录。
- 所需输入:
name(字符串):需查询的ENS名称key(字符串):要查找的记录键(例如,'email', 'url', 'avatar', 'description', 'twitter' 等)
- 返回:指定键对应的值或未找到记录的提示
检查可用性
检查ENS名称是否可以注册。
- 所需输入:
name(字符串):需检查的ENS名称
- 返回:可用性状态及已注册名称的所有者信息
获取所有记录
获取ENS名称的全部信息。
- 所需输入:
name(字符串):需查询的ENS名称
- 返回:包括解析器地址、文本记录、地址、内容哈希、所有权和过期详细信息在内的全面信息
获取子域名
获取ENS名称的子域名。
- 所需输入:
name(字符串):需查询子域名的ENS名称
- 返回:子域名列表及其所有者信息
获取名称历史
获取ENS名称的历史记录。
- 所需输入:
name(字符串):需检查历史记录的ENS名称
- 返回:名称的所有历史记录
获取价格
获取ENS名称的当前价格(以太坊)。
- 所需输入:
name(字符串):需查询价格的ENS名称
- 返回:名称的当前价格(以太坊)
📦 安装指南
先决条件
- 确保安装了Node.js和npm。
- 安装必要的依赖项:
@ensdomains/mcp-server、@ensdomains/eth-typings和@ensdomains/resolver。
安装
使用以下命令安装MCP服务器:
npm install -g @ensdomains/mcp-server
配置提供者URL
通过PROVIDER_URL环境变量指定以太坊节点的RPC端点。支持多个提供者,只需用逗号分隔URL即可。例如:
export PROVIDER_URL="https://eth-mainnet.g.alchemy.com/v1/YOUR_API_KEY,https://eth-mainnet.rpcool.com"
💻 使用示例
在Claude Desktop上的使用
使用npx启动MCP服务器
在终端中运行以下命令:
npx @ensdomains/mcp-server --config ./path/to/config.json
使用本地脚本启动MCP服务器
- 创建一个配置文件
server.js,内容如下:
const { startServer } = require('@ensdomains/mcp-server');
startServer({
configPath: './config.json',
});
- 在终端中运行:
node server.js
📚 详细文档
错误处理
- 如果出现错误,请检查以下内容:
- 确保ENS名称格式正确。
- 尝试使用多个提供者,通过在
PROVIDER_URL环境变量中逗号分隔多个URL。 - 确保已安装最新版本的ENS库。
发布说明
此MCP服务器遵循语义化版本控制。发布说明将在CHANGELOG.md文件中提供。
📄 许可证
此MCP服务器根据MIT许可证分发。这意味着您可以自由使用、修改和分发软件,但需遵守MIT许可证的条款和条件。有关详细信息,请参阅项目仓库中的LICENSE文件。
Scan to join WeChat group