@noditlabs/nodit-mcp-server 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,179 @@
+# Nodit MCP Server
+
+A Model Context Provider (MCP) server that connects AI agents and developers to structured, context-ready blockchain data across multiple networks through Nodit's Web3 infrastructure.
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-green.svg)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue.svg)](https://www.typescriptlang.org/)
+
+
+## Overview
+
+Nodit MCP Server simplifies how AI models and applications interact with blockchain ecosystems.  
+Instead of handling complex node RPCs, raw event logs, or chain-specific data structures, developers can access normalized, multi-chain blockchain data in a format optimized for AI reasoning and decision-making.
+
+With Nodit's MCP, you can:
+- Build AI agents that query, analyze, and act on real-time blockchain data across EVM-compatible and non-EVM networks.
+- Create Web3-integrated applications without requiring specialized blockchain development expertise.
+- Leverage Nodit's reliable node infrastructure, Web3 Data APIs, and GraphQL indexing services through a unified access layer.
+
+Supported networks include Ethereum, Base, Optimism, Arbitrum, Polygon, Aptos, Bitcoin, Dogecoin, TRON, XRPL, and more.
+
+
+## How Nodit MCP Tools Work
+
+Nodit MCP Server provides tools enabling AI agents to dynamically discover, understand, and interact with Nodit's Web3 APIs and data infrastructure. The tools minimize token consumption and maintain a lightweight context by modularizing API interactions into distinct steps:
+
+- **List API Categories (`list_nodit_api_categories`)**  
+  Retrieve a list of high-level API categories available.
+
+- **List API Operations (`list_nodit_node_apis`, `list_nodit_data_apis`, `list_nodit_aptos_indexer_api_query_root`)**  
+  Fetch available operations within a selected category (Node APIs, Data APIs, Aptos Indexer APIs).
+
+- **Get API Specification (`get_nodit_api_spec`)**  
+  Obtain detailed information for a specific API operation (parameters, request/response schema).
+
+- **Call API (`call_nodit_api`,`call_nodit_aptos_indexer_api`)**  
+  Execute an API call using the operationId and validated parameters.
+
+
+## Features
+
+The following are the key features and supported blockchain networks provided through Nodit MCP Server for AI agents and LLMs.  
+For detailed API specifications and usage guidelines, please refer to the [Nodit Developer Documentation](https://developer.nodit.io/).
+
+- **RPC Node & Node APIs**  
+  Access blockchain node endpoints through Nodit's professionally operated infrastructure.  
+  Supports real-time network queries, transaction submissions, smart contract interactions, and more.
+
+- **Web3 Data APIs**  
+  High-level APIs for accessing meticulously indexed blockchain data.  
+  Includes processed datasets such as block and transaction details, token transfer histories, account-level transaction summaries, and asset movement details — information that would be difficult to assemble directly through raw RPC calls.
+
+- **GraphQL Indexer APIs (Aptos only)**  
+  Query detailed Aptos blockchain activities through GraphQL endpoints.
+
+- **Supported Networks**  
+  - EVM-Compatible: Ethereum, Arbitrum, Avalanche, Base, Kaia, Optimism, Polygon
+  - Non-EVM: Aptos, Bitcoin, Dogecoin, TRON, XRPL
+
+
+## Prerequisites
+
+- Node.js 18+
+- **Nodit API Key** (Sign up and get an API key at [Nodit Console](https://nodit.lambda256.io/))
+
+
+## Installation & Integration
+
+### Using npx (Recommended)
+
+```bash
+npx @noditlabs/nodit-mcp-server@latest
+```
+
+
+### Connect to Cursor IDE or Claude Desktop
+
+Add the following configuration to your `.cursor/mcp.json` or `claude_desktop_config.json`:
+
+- **Cursor**
+  - MacOS: `~/.cursor/mcp.json`
+  - Windows: `C:\Users\<Username>\.cursor\mcp.json`
+
+- **Claude Desktop**
+  - MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+  - Windows: `C:\Users\<Username>\AppData\Roaming\Claude\claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "nodit": {
+      "command": "npx",
+      "args": ["@noditlabs/nodit-mcp-server@latest"],
+      "env": {
+        "NODIT_API_KEY": "****"
+      }
+    }
+  }
+}
+```
+> 🔔 **Important**  
+> Replace `****` with your actual Nodit API key.  
+> If the API key is not configured properly, API requests will fail due to authentication errors.
+
+### Connect to Claude CLI
+
+You can also use Nodit MCP Server directly with Claude CLI for a quick setup.
+
+Add Nodit MCP Server with the following commands:
+
+```bash
+# Add the Nodit MCP server
+claude mcp add nodit-mcp-server npx @noditlabs/nodit-mcp-server
+
+# Set API Key
+export NODIT_API_KEY=your-api-key
+
+# Start Claude with the Nodit MCP server enabled
+claude
+```
+
+### Running Locally (Optional)
+
+Clone and run the server locally:
+
+```bash
+# Clone the repository
+git clone --recurse-submodules https://github.com/noditlabs/nodit-mcp-server.git
+
+# Move into the project directory
+cd nodit-mcp-server
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+```
+
+Before starting, set your Nodit API key:
+
+```bash
+export NODIT_API_KEY=your-api-key
+```
+
+Then start the server:
+
+```bash
+node build/index.js
+```
+
+## Scope & Limitations
+
+Nodit MCP Server provides structured context to help LLM-based agents utilize Nodit's APIs effectively.  
+Its responsibilities include:
+
+- Structuring Nodit APIs (Node APIs, Web3 Data APIs) in an LLM-consumable format.
+- Exposing endpoint details, input/output schemas, sample responses, and error handling guidelines.
+
+However, the following are **outside the MCP's control**:
+
+- API selection may vary depending on the LLM version (e.g., GPT-4, Claude 3), prompt engineering, or agent design.
+- Interpretation of API responses or errors depends on the consuming LLM's reasoning capabilities.
+
+Nodit MCP Server focuses on delivering accurate and structured API context,  
+but does **not guarantee** the final reasoning outcomes or behavior of external LLMs.
+
+
+## License
+
+This project is licensed under the [Apache License 2.0](./LICENSE).  
+Refer to the LICENSE file for full license terms.  
+Relevant legal notices are provided in the [NOTICE](./NOTICE) file.
+
+"Nodit" and the Nodit logo are trademarks of Lambda256.  
+Use of the name or logo without prior written permission is prohibited.
+
+---
+© Lambda256. All rights reserved.

package/build/index.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { log } from "./nodit-apidoc-helper.js";
+import { registerAllTools } from "./tools/index.js";
+async function main() {
+    const server = new McpServer({
+        name: "nodit-blockchain-context",
+        version: "1.0.0",
+        capabilities: {
+            resources: {},
+            tools: {},
+        },
+    });
+    registerAllTools(server);
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+}
+main().catch((error) => {
+    log("Fatal error in main():", error);
+    process.exit(1);
+});

package/build/nodit-apidoc-helper.js

@@ -0,0 +1,116 @@
+import yaml from 'js-yaml';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export function log(message, ...args) {
+    console.error(message, ...args);
+}
+export function loadNoditDataApiSpec() {
+    const specPath = path.resolve(__dirname, './spec/reference/web3-data-api.yaml');
+    return loadOpenapiSpecFile(specPath);
+}
+export function loadNoditNodeApiSpecMap() {
+    const noditApiSpecMap = new Map();
+    const specDir = path.resolve(__dirname, './spec/reference');
+    try {
+        const files = fs.readdirSync(specDir);
+        const evmSpecFiles = files.filter(file => file.startsWith('evm-') && file.endsWith('.yaml'));
+        for (const file of evmSpecFiles) {
+            const parts = file.replace('.yaml', '').split('-');
+            if (parts.length >= 2) {
+                const protocol = parts[1];
+                const filePath = path.join(specDir, file);
+                try {
+                    const spec = loadOpenapiSpecFile(filePath);
+                    const operationId = spec.paths['/'].post.operationId;
+                    if (operationId) {
+                        const key = protocol === 'ethereum' ? `ethereum-${operationId}` : operationId;
+                        noditApiSpecMap.set(key, spec);
+                    }
+                    else {
+                        log(`Could not extract operationId from spec file ${file}`);
+                    }
+                }
+                catch (error) {
+                    log(`Error loading spec file ${file}:`, error);
+                }
+            }
+        }
+        return noditApiSpecMap;
+    }
+    catch (error) {
+        log('Error reading spec directory:', error);
+        return new Map();
+    }
+}
+export function loadNoditAptosIndexerApiSpec() {
+    const schemaPath = path.resolve(__dirname, './nodit-aptos-indexer-api-schema.json');
+    return loadOpenapiSpecFile(schemaPath);
+}
+export function isNodeApi(operationId) {
+    return operationId.includes("_");
+}
+export function isEthereumNodeApi(operationId) {
+    return !operationId.includes("-");
+}
+export function findNoditNodeApiSpec(operationId, noditNodeApiSpecMap) {
+    let key = operationId;
+    if (isEthereumNodeApi(operationId)) {
+        key = `ethereum-${operationId}`;
+    }
+    return noditNodeApiSpecMap.get(key);
+}
+export function isValidNodeApi(operationId, noditNodeApiSpecMap) {
+    return findNoditNodeApiSpec(operationId, noditNodeApiSpecMap) !== undefined;
+}
+export function loadOpenapiSpecFile(path) {
+    const fileContents = fs.readFileSync(path, 'utf8');
+    if (path.endsWith('.json')) {
+        return JSON.parse(fileContents);
+    }
+    return yaml.load(fileContents);
+}
+export function normalizeDescription(description) {
+    if (!description) {
+        return "No description available.";
+    }
+    const lines = description.split('\n');
+    const filteredLines = lines.filter(line => !line.trimStart().startsWith('>'));
+    return filteredLines.join('\n').trim();
+}
+export function findNoditDataApiDetails(operationId, spec) {
+    if (!spec || !spec.paths) {
+        log("findApiDetails: Invalid spec object or missing paths.");
+        return null;
+    }
+    for (const pathKey in spec.paths) {
+        if (Object.prototype.hasOwnProperty.call(spec.paths, pathKey)) {
+            const pathItem = spec.paths[pathKey];
+            if (pathItem?.post?.operationId === operationId) {
+                return {
+                    path: pathKey,
+                    method: 'post',
+                    details: pathItem.post
+                };
+            }
+        }
+    }
+    return null;
+}
+export function findNoditNodeApiDetails(operationId, specMap) {
+    const spec = findNoditNodeApiSpec(operationId, specMap);
+    if (!spec) {
+        return null;
+    }
+    return {
+        path: '/',
+        method: 'post',
+        details: spec.paths['/']?.post
+    };
+}
+export function createErrorResponse(message, toolName) {
+    log(`Tool Error (${toolName}): ${message}`);
+    return { content: [{ type: "text", text: `Tool Error: ${message}` }] };
+}