ENS
- typescript
9
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"justaname-id-ens-mcp-server": {
"command": "npx",
"args": [
"-y",
"mcp-server-ens"
],
"env": {
"PROVIDER_URL": "https://your-provider-url.com,https://your-backup-provider.com"
}
}
}
}You can run the ENS MCP Server to let clients resolve ENS names, perform lookups, retrieve records, and interact with the Ethereum Name Service through a simple MCP interface. This server exposes several tools you can call via MCP clients to resolve names, discover subdomains, check availability, and more, all backed by Ethereum providers.
How to use
You will run the ENS MCP Server as a local or remote MCP endpoint and connect to it from your MCP client. Two common execution methods are provided: using npx to run the package directly, or running a local script with node. In either case, you will specify your Ethereum provider URLs so the server can query the Ethereum network for ENS data.
How to install
Prerequisites you need before starting:
- Node.js (v16 or higher)
- npm or yarn
- Access to Ethereum RPC providers (public or private)
Step-by-step setup:
- Clone the repository or set up a new project for the ENS MCP Server.
- Install dependencies.
- Run or configure the server with your preferred method.
# Step 1: Install dependencies
npm i
# Step 2: Run using npx (recommended for quick starts)
npx -y mcp-server-ens
# Or run as a local script once you have the source locally
node /path/to/your/server.js
Additional sections
Configuration notes: you can set your Ethereum providers by placing a PROVIDER_URL value in an environment file or directly in the command environment. If you omit providers, default public endpoints will be used. The server exposes a set of tools for common ENS interactions and handles errors with clear messages to help you diagnose problems quickly.
Error handling: expect robust handling for network errors, invalid ENS names or addresses, ENS-specific errors, and general operational errors. Errors are normalized into user-friendly messages while preserving technical details for debugging.
Publishing: you can publish the MCP server as an npm package with public access when you are ready to share it. Ensure you follow standard npm publishing practices for your project.
Available tools
resolve-name
Resolve an ENS name to an Ethereum address. Input: name (e.g., vitalik.eth). Output: the corresponding Ethereum address or an error.
reverse-lookup
Get the ENS name for an Ethereum address. Input: address. Output: the ENS name or an indication that no name was found.
get-text-record
Get a text record for an ENS name. Input: name and key. Output: the value of the text record or an indication that it was not found.
check-availability
Check if an ENS name is available for registration. Input: name. Output: availability status and owner information if registered.
get-all-records
Get all available information for an ENS name. Input: name. Output: resolver, text records, addresses, content hash, ownership, and expiration details.
get-subdomains
Get subdomains for an ENS name. Input: name. Output: list of subdomains with owner information.
get-name-history
Get the history of an ENS name. Input: name. Output: historical events such as transfers, resolver changes, and registrations.
get-registration-price
Get the price to register an ENS name. Input: name and optional duration (years). Output: registration price breakdown including base price, premium, and total.