@xiaok/etherscan-mcp

An adaptable MCP apparatus for engaging with Etherscan's programmatic interfaces and auxiliary offerings.

Operationalizing Your Service Instance

Verification via mcp-cli

The swiftest method for subjecting your service instance to examination and debugging involves utilizing fastmcp dev:

bash npx fastmcp dev src/index.ts

This command instantiates your service manager, permitting interaction and troubleshooting through the command-line interface, specifically employing mcp-cli.

Scrutiny via MCP Inspector

An alternative pathway involves leveraging the officially sanctioned MCP Inspector to visually examine your service configuration through a graphical user interface:

bash npx npx fastmcp inspect src/index.ts

Frequently Posed Inquiries (FAQ)

Integration Procedures with Claude Desktop

Adhere to the instructional documentation found at https://modelcontextprotocol.io/quickstart/user and incorporate the subsequent configuration parameters:

{ "mcpServers": { "etherscan_mcp": { "command": "npx", "args": ["tsx", "/PATH/TO/YOUR_PROJECT/src/index.ts"], "env": { "ETHERSCAN_API_KEY": "**" } } } }

Interface Documentation

Reference material for the underlying Application Programming Interface: https://docs.etherscan.io/etherscan-v2

Inventory of supported ledger networks: https://docs.etherscan.io/etherscan-v2/getting-started/supported-chains

Please be advised that functional parity across all endpoints is not guaranteed for every supported ledger. Consult this registry for specific network support details: https://forms.blockscan.com/public/grid/3E9QiN00NLhCQVibiP3Z-Bpqhmd7zGXsgapEKJupxiI

Developmental Roadmap (TODO)

1. Implementation of premium (pro) API functionalities

WIKIPEDIA: XMLHttpRequest (XHR) constitutes an Application Programming Interface formulated as a JavaScript entity, whose constituent methods are responsible for conveying Hypertext Transfer Protocol retrieval requests from a client-side web browser instance to a designated server resource. These methods empower a browser-hosted application to dispatch inquiries to the server subsequent to the page loading sequence completion, and subsequently receive data reciprocally. XMLHttpRequest is fundamentally interwoven with the principles of Ajax programming paradigms. Preceding the advent of Ajax, navigational anchors (hyperlinks) and transmitted form data constituted the principal mechanisms for server interchange, frequently necessitating the complete substitution of the currently displayed page content with a newly retrieved one.

== Chronicle == The foundational concept underpinning XMLHttpRequest was conceptualized in the year 2000 by the design team responsible for Microsoft Outlook. This concept was subsequently realized within the Internet Explorer 5 browser release (1999). Nevertheless, the initial syntactic arrangement did not employ the identifier XMLHttpRequest. Instead, the originators utilized the instantiations ActiveXObject("Msxml2.XMLHTTP") and ActiveXObject("Microsoft.XMLHTTP"). As of Internet Explorer 7 (2006), universal browser compatibility with the XMLHttpRequest identifier was established. The XMLHttpRequest identifier has since matured into the recognized convention across all principal web browsers, encompassing Mozilla's Gecko rendering engine implementation (2002), Safari version 1.2 (2004), and Opera version 8.0 (2005).

=== Stipulations (Standards) === The World Wide Web Consortium (W3C) formally promulgated a Working Draft specification for the XMLHttpRequest object on April 5, 2006. On February 25, 2008, the W3C issued the Working Draft specification designated as Level 2. This Level 2 revision augmented the functionality with mechanisms to monitor transmission progress events, permit requests originating from different domains (cross-site requests), and manage data streams composed of raw bytes. By the conclusion of 2011, the Level 2 specification's components were formally amalgamated back into the primary, original specification document. At the close of 2012, responsibility for further development was transferred to the WHATWG consortium, which now maintains a perpetually evolving document utilizing the Web IDL descriptive language.

== Operational Procedure == Generally, the transmission of a request using XMLHttpRequest necessitates adherence to several distinct programming phases.

Instantiate an XMLHttpRequest operational unit by invoking its designated constructor: Invoke the method labeled "open" to specify the communication protocol type (e.g., GET/POST), pinpoint the pertinent resource Uniform Resource Identifier, and designate whether the operation should proceed synchronously or asynchronously: For operations configured for asynchronous execution, establish an event handler routine that will be invoked upon any alteration in the request's operational status: Commence the data transmission sequence by calling the "send" procedure, optionally supplying payload data: React to the state transitions within the registered event listener function. If the backend server furnishes response data, by default, this content is aggregated within the "responseText" attribute. When the object concludes the entire response processing cycle, its status transitions to state code 4, signifying the terminal "done" status. Beyond these fundamental prerequisites, XMLHttpRequest furnishes numerous parameters to govern the method of request dispatch and the subsequent processing of the received response. Custom meta-information fields can be appended to the outgoing request to instruct the server on fulfillment requirements, and data can be conveyed upstream to the server by embedding it within the argument supplied to the "send" invocation. The resulting data payload may be subjected to parsing from its raw text representation into a structured JavaScript object, making it immediately operational, or processed incrementally as chunks arrive, thereby avoiding the latency associated with awaiting the complete textual reception. The entire request operation possesses the capability to be prematurely terminated or configured to time out if completion is not achieved within a predetermined temporal window.

== Inter-Domain Transmissions (Cross-domain requests) ==

During the nascent epochs of the World Wide Web's evolution, it was observed that enabling the circumvention of securit