feat: implement node parser and property extractor with versioned node support
This commit is contained in:
czlonkowski
@@ -5,9 +5,9 @@
|
|||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
# Database Configuration
|
# Database Configuration
|
||||||
# For local development: ./data/nodes-v2.db
|
# For local development: ./data/nodes.db
|
||||||
# For Docker: /app/data/nodes-v2.db
|
# For Docker: /app/data/nodes.db
|
||||||
NODE_DB_PATH=./data/nodes-v2.db
|
NODE_DB_PATH=./data/nodes.db
|
||||||
|
|
||||||
# Logging Level (debug, info, warn, error)
|
# Logging Level (debug, info, warn, error)
|
||||||
MCP_LOG_LEVEL=info
|
MCP_LOG_LEVEL=info
|
||||||
|
|||||||
19
.gitignore
vendored
19
.gitignore
vendored
@@ -69,3 +69,22 @@ docker-compose.override.yml
|
|||||||
# Temporary files
|
# Temporary files
|
||||||
temp/
|
temp/
|
||||||
tmp/
|
tmp/
|
||||||
|
|
||||||
|
# Database files
|
||||||
|
data/*.db
|
||||||
|
data/*.db-journal
|
||||||
|
data/*.db.bak
|
||||||
|
!data/.gitkeep
|
||||||
|
|
||||||
|
# Claude Desktop configs (personal)
|
||||||
|
claude_desktop_config.json
|
||||||
|
claude_desktop_config_*.json
|
||||||
|
!claude_desktop_config.example.json
|
||||||
|
|
||||||
|
# Personal wrapper scripts
|
||||||
|
mcp-server-v20.sh
|
||||||
|
rebuild-v20.sh
|
||||||
|
!mcp-server-v20.example.sh
|
||||||
|
|
||||||
|
# n8n-docs repo (cloned locally)
|
||||||
|
../n8n-docs/
|
||||||
|
|||||||
32
CHANGELOG.md
32
CHANGELOG.md
@@ -2,6 +2,38 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [2.2.0] - 2024-12-06
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- PropertyExtractor class for dedicated property/operation extraction
|
||||||
|
- NodeRepository for proper JSON serialization/deserialization
|
||||||
|
- Support for @n8n/n8n-nodes-langchain package (59 AI nodes)
|
||||||
|
- AI tool detection (35 tools with usableAsTool property)
|
||||||
|
- Test suite for critical node validation
|
||||||
|
- Comprehensive documentation (README, SETUP, CHANGELOG)
|
||||||
|
- Example configuration files for Claude Desktop
|
||||||
|
- Node.js v20.17.0 wrapper scripts for compatibility
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Empty properties/operations arrays (now 98.7% nodes have properties)
|
||||||
|
- Versioned node detection (HTTPRequest, Code properly identified)
|
||||||
|
- Documentation mapping for nodes with directory-based docs
|
||||||
|
- Critical node validation (httpRequest, slack, code all pass)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Refactored parser to handle instance-level properties
|
||||||
|
- Updated MCP server to use NodeRepository
|
||||||
|
- Improved rebuild script with validation
|
||||||
|
- Enhanced database schema with proper typing
|
||||||
|
|
||||||
|
### Metrics
|
||||||
|
- 458 total nodes (100% success rate)
|
||||||
|
- 452 nodes with properties (98.7%)
|
||||||
|
- 265 nodes with operations (57.9%)
|
||||||
|
- 406 nodes with documentation (88.6%)
|
||||||
|
- 35 AI-capable tools detected
|
||||||
|
- All critical nodes validated
|
||||||
|
|
||||||
## [2.1.0] - 2025-01-08
|
## [2.1.0] - 2025-01-08
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
102
CLAUDE.md
102
CLAUDE.md
@@ -6,38 +6,45 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
|||||||
|
|
||||||
n8n-mcp is a comprehensive documentation and knowledge server that provides AI assistants with complete access to n8n node information through the Model Context Protocol (MCP). It serves as a bridge between n8n's workflow automation platform and AI models, enabling them to understand and work with n8n nodes effectively.
|
n8n-mcp is a comprehensive documentation and knowledge server that provides AI assistants with complete access to n8n node information through the Model Context Protocol (MCP). It serves as a bridge between n8n's workflow automation platform and AI models, enabling them to understand and work with n8n nodes effectively.
|
||||||
|
|
||||||
## 🚧 ACTIVE REFACTOR IN PROGRESS
|
## ✅ Refactor Complete (v2.2)
|
||||||
|
|
||||||
**We are currently implementing a major refactor based on IMPLEMENTATION_PLAN.md v2.1 Final**
|
**The major refactor has been successfully completed based on IMPLEMENTATION_PLAN.md v2.2**
|
||||||
|
|
||||||
### Refactor Goals:
|
### Achieved Goals:
|
||||||
- Fix documentation mapping issues (HTTP Request, Code, Webhook nodes)
|
- ✅ Fixed property/operation extraction (452/458 nodes have properties)
|
||||||
- Add support for @n8n/n8n-nodes-langchain package
|
- ✅ Added AI tool detection (35 AI tools detected)
|
||||||
- Simplify architecture to align with n8n's LoadNodesAndCredentials patterns
|
- ✅ Full support for @n8n/n8n-nodes-langchain package
|
||||||
- Implement proper VersionedNodeType handling
|
- ✅ Proper VersionedNodeType handling
|
||||||
- Add AI tool detection (usableAsTool flag)
|
- ✅ Fixed documentation mapping issues
|
||||||
|
|
||||||
### New Architecture (In Progress):
|
### Current Architecture:
|
||||||
```
|
```
|
||||||
src/
|
src/
|
||||||
├── loaders/
|
├── loaders/
|
||||||
│ └── node-loader.ts # Simple npm package loader
|
│ └── node-loader.ts # NPM package loader for both packages
|
||||||
├── parsers/
|
├── parsers/
|
||||||
│ └── simple-parser.ts # Single parser for all nodes
|
│ ├── node-parser.ts # Enhanced parser with version support
|
||||||
|
│ └── property-extractor.ts # Dedicated property/operation extraction
|
||||||
├── mappers/
|
├── mappers/
|
||||||
│ └── docs-mapper.ts # Deterministic documentation mapping
|
│ └── docs-mapper.ts # Documentation mapping with fixes
|
||||||
|
├── database/
|
||||||
|
│ ├── schema.sql # SQLite schema
|
||||||
|
│ └── node-repository.ts # Data access layer
|
||||||
├── scripts/
|
├── scripts/
|
||||||
│ ├── rebuild.ts # One-command rebuild
|
│ ├── rebuild.ts # Database rebuild with validation
|
||||||
│ └── validate.ts # Validation script
|
│ ├── validate.ts # Node validation
|
||||||
|
│ └── test-nodes.ts # Critical node tests
|
||||||
└── mcp/
|
└── mcp/
|
||||||
└── server.ts # Enhanced MCP server
|
└── server.ts # MCP server with enhanced tools
|
||||||
```
|
```
|
||||||
|
|
||||||
### Timeline:
|
### Key Metrics:
|
||||||
- Week 1: Core implementation (loaders, parsers, mappers)
|
- 458 nodes successfully loaded (100%)
|
||||||
- Week 2: Testing, validation, and MCP updates
|
- 452 nodes with properties (98.7%)
|
||||||
|
- 265 nodes with operations (57.9%)
|
||||||
See IMPLEMENTATION_PLAN.md for complete details.
|
- 406 nodes with documentation (88.6%)
|
||||||
|
- 35 AI-capable tools detected
|
||||||
|
- All critical nodes pass validation
|
||||||
|
|
||||||
## Key Commands
|
## Key Commands
|
||||||
|
|
||||||
@@ -50,12 +57,13 @@ npm test # Run Jest tests
|
|||||||
npm run typecheck # TypeScript type checking
|
npm run typecheck # TypeScript type checking
|
||||||
npm run lint # Check TypeScript types (alias for typecheck)
|
npm run lint # Check TypeScript types (alias for typecheck)
|
||||||
|
|
||||||
# NEW Commands (After Refactor):
|
# Core Commands:
|
||||||
npm run rebuild # Rebuild node database with new architecture
|
npm run rebuild # Rebuild node database
|
||||||
npm run validate # Validate critical nodes (HTTP Request, Code, Slack, AI Agent)
|
npm run validate # Validate critical nodes
|
||||||
|
npm run test-nodes # Test critical node properties/operations
|
||||||
|
|
||||||
# Database Management (Current - being replaced)
|
# Legacy Commands (deprecated):
|
||||||
npm run db:rebuild # Rebuild the node database (run after build)
|
npm run db:rebuild # Old rebuild command
|
||||||
npm run db:init # Initialize empty database
|
npm run db:init # Initialize empty database
|
||||||
npm run docs:rebuild # Rebuild documentation from TypeScript source
|
npm run docs:rebuild # Rebuild documentation from TypeScript source
|
||||||
|
|
||||||
@@ -75,13 +83,11 @@ The project implements MCP (Model Context Protocol) to expose n8n node documenta
|
|||||||
|
|
||||||
### MCP Tools Available
|
### MCP Tools Available
|
||||||
- `list_nodes` - List all available n8n nodes with filtering
|
- `list_nodes` - List all available n8n nodes with filtering
|
||||||
- `get_node_info` - Get comprehensive information about a specific node
|
- `get_node_info` - Get comprehensive information about a specific node (properties, operations, credentials)
|
||||||
- `search_nodes` - Full-text search across all node documentation
|
- `search_nodes` - Full-text search across all node documentation
|
||||||
- `get_node_example` - Generate example workflows for nodes
|
- `list_ai_tools` - List all AI-capable nodes (usableAsTool: true)
|
||||||
- `get_node_source_code` - Extract complete node source code
|
|
||||||
- `get_node_documentation` - Get parsed documentation from n8n-docs
|
- `get_node_documentation` - Get parsed documentation from n8n-docs
|
||||||
- `rebuild_database` - Rebuild the entire node database
|
- `get_database_statistics` - Get database usage statistics and metrics
|
||||||
- `get_database_statistics` - Get database usage statistics
|
|
||||||
|
|
||||||
### Database Structure
|
### Database Structure
|
||||||
Uses SQLite with enhanced schema:
|
Uses SQLite with enhanced schema:
|
||||||
@@ -94,24 +100,28 @@ Uses SQLite with enhanced schema:
|
|||||||
|
|
||||||
### Initial Setup Requirements
|
### Initial Setup Requirements
|
||||||
|
|
||||||
#### Current Setup:
|
|
||||||
1. **Build First**: Always run `npm run build` before any other commands
|
|
||||||
2. **Database Initialization**: Run `npm run db:rebuild` after building to populate the node database
|
|
||||||
3. **Documentation Fetching**: The rebuild process clones n8n-docs repository temporarily
|
|
||||||
|
|
||||||
#### New Setup (After Refactor):
|
|
||||||
1. **Clone n8n-docs**: `git clone https://github.com/n8n-io/n8n-docs.git ../n8n-docs`
|
1. **Clone n8n-docs**: `git clone https://github.com/n8n-io/n8n-docs.git ../n8n-docs`
|
||||||
2. **Build**: `npm run build`
|
2. **Install Dependencies**: `npm install`
|
||||||
3. **Rebuild Database**: `npm run rebuild`
|
3. **Build**: `npm run build`
|
||||||
4. **Validate**: `npm run validate`
|
4. **Rebuild Database**: `npm run rebuild`
|
||||||
|
5. **Validate**: `npm run test-nodes`
|
||||||
|
|
||||||
### Current Implementation Status
|
### Node.js Version Compatibility
|
||||||
The existing implementation has several gaps that the active refactor addresses:
|
|
||||||
- ✅ Documentation mapping issues → Being fixed with KNOWN_FIXES mapping
|
This project requires Node.js v20.17.0 for Claude Desktop compatibility. If using a different Node version locally:
|
||||||
- ✅ Limited to n8n-nodes-base → Adding @n8n/n8n-nodes-langchain support
|
|
||||||
- ⏳ Incomplete property schemas → Keeping n8n's structure as-is (MVP approach)
|
1. Install Node v20.17.0 via nvm: `nvm install 20.17.0`
|
||||||
- ⏳ No version tracking → Only tracking current version (deferred post-MVP)
|
2. Use the provided wrapper script: `mcp-server-v20.sh`
|
||||||
- ⏳ Generic examples → Using actual n8n-docs examples (deferred enhancement)
|
3. Or switch Node version: `nvm use 20.17.0`
|
||||||
|
|
||||||
|
### Implementation Status
|
||||||
|
- ✅ Property/operation extraction for 98.7% of nodes
|
||||||
|
- ✅ Support for both n8n-nodes-base and @n8n/n8n-nodes-langchain
|
||||||
|
- ✅ AI tool detection (35 tools with usableAsTool property)
|
||||||
|
- ✅ Versioned node support (HTTPRequest, Code, etc.)
|
||||||
|
- ✅ Documentation coverage for 88.6% of nodes
|
||||||
|
- ⏳ Version history tracking (deferred - only current version)
|
||||||
|
- ⏳ Workflow examples (deferred - using documentation)
|
||||||
|
|
||||||
### Testing Workflow
|
### Testing Workflow
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
6
COPYRIGHT
Normal file
6
COPYRIGHT
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
This software is licensed under the Sustainable Use License v1.0.
|
||||||
|
See the LICENSE file for the full license terms.
|
||||||
2
LICENSE
2
LICENSE
@@ -2,6 +2,8 @@ Sustainable Use License
|
|||||||
|
|
||||||
Version 1.0
|
Version 1.0
|
||||||
|
|
||||||
|
Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
|
||||||
## Acceptance
|
## Acceptance
|
||||||
|
|
||||||
By using the software, you agree to all of the terms and conditions below.
|
By using the software, you agree to all of the terms and conditions below.
|
||||||
|
|||||||
179
README.md
Normal file
179
README.md
Normal file
@@ -0,0 +1,179 @@
|
|||||||
|
# n8n-MCP
|
||||||
|
|
||||||
|
A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to n8n node documentation, properties, and operations.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
n8n-MCP serves as a bridge between n8n's workflow automation platform and AI models, enabling them to understand and work with n8n nodes effectively. It provides structured access to:
|
||||||
|
|
||||||
|
- 📚 **458 n8n nodes** from both n8n-nodes-base and @n8n/n8n-nodes-langchain
|
||||||
|
- 🔧 **Node properties** - 98.7% coverage with detailed schemas
|
||||||
|
- ⚡ **Node operations** - 57.9% coverage of available actions
|
||||||
|
- 📄 **Documentation** - 88.6% coverage from official n8n docs
|
||||||
|
- 🤖 **AI tools** - 35 AI-capable nodes detected
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Comprehensive Node Information**: Access properties, operations, credentials, and documentation for all n8n nodes
|
||||||
|
- **AI Tool Detection**: Automatically identifies nodes with AI capabilities (usableAsTool)
|
||||||
|
- **Versioned Node Support**: Handles complex versioned nodes like HTTPRequest and Code
|
||||||
|
- **Fast Search**: SQLite with FTS5 for instant full-text search across all documentation
|
||||||
|
- **MCP Protocol**: Standard interface for AI assistants to query n8n knowledge
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Node.js v20.17.0 (required for Claude Desktop compatibility)
|
||||||
|
- npm or yarn
|
||||||
|
- Git
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/yourusername/n8n-mcp.git
|
||||||
|
cd n8n-mcp
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Clone n8n documentation (required for full documentation coverage):
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/n8n-io/n8n-docs.git ../n8n-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Install dependencies:
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Build the project:
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Initialize the database:
|
||||||
|
```bash
|
||||||
|
npm run rebuild
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Validate the installation:
|
||||||
|
```bash
|
||||||
|
npm run test-nodes
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### With Claude Desktop
|
||||||
|
|
||||||
|
1. Copy the example configuration:
|
||||||
|
```bash
|
||||||
|
cp claude_desktop_config.example.json ~/Library/Application\ Support/Claude/claude_desktop_config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Edit the configuration to point to your installation:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"n8n-documentation": {
|
||||||
|
"command": "/path/to/n8n-mcp/mcp-server-v20.sh",
|
||||||
|
"args": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Make sure the wrapper script is executable:
|
||||||
|
```bash
|
||||||
|
chmod +x mcp-server-v20.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Restart Claude Desktop
|
||||||
|
|
||||||
|
### Available MCP Tools
|
||||||
|
|
||||||
|
- `list_nodes` - List all n8n nodes with filtering options
|
||||||
|
- `get_node_info` - Get detailed information about a specific node
|
||||||
|
- `search_nodes` - Full-text search across all node documentation
|
||||||
|
- `list_ai_tools` - List all AI-capable nodes
|
||||||
|
- `get_node_documentation` - Get parsed documentation for a node
|
||||||
|
- `get_database_statistics` - View database metrics and coverage
|
||||||
|
|
||||||
|
### Example Queries
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// List all trigger nodes
|
||||||
|
list_nodes({ isTrigger: true })
|
||||||
|
|
||||||
|
// Get info about the HTTP Request node
|
||||||
|
get_node_info({ nodeType: "nodes-base.httpRequest" })
|
||||||
|
|
||||||
|
// Search for OAuth-related nodes
|
||||||
|
search_nodes({ query: "oauth" })
|
||||||
|
|
||||||
|
// Find AI-capable tools
|
||||||
|
list_ai_tools()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build # Build TypeScript
|
||||||
|
npm run rebuild # Rebuild node database
|
||||||
|
npm run test-nodes # Test critical nodes
|
||||||
|
npm run validate # Validate node data
|
||||||
|
npm start # Start MCP server
|
||||||
|
npm test # Run tests
|
||||||
|
npm run typecheck # Check TypeScript types
|
||||||
|
```
|
||||||
|
|
||||||
|
### Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
├── loaders/ # Node package loaders
|
||||||
|
├── parsers/ # Node metadata parsers
|
||||||
|
├── mappers/ # Documentation mappers
|
||||||
|
├── database/ # SQLite repository
|
||||||
|
├── scripts/ # Build and test scripts
|
||||||
|
└── mcp/ # MCP server implementation
|
||||||
|
```
|
||||||
|
|
||||||
|
### Node.js Version Management
|
||||||
|
|
||||||
|
For development with different Node versions:
|
||||||
|
|
||||||
|
1. Install nvm (Node Version Manager)
|
||||||
|
2. Install Node v20.17.0: `nvm install 20.17.0`
|
||||||
|
3. Use the wrapper script: `./mcp-server-v20.sh`
|
||||||
|
|
||||||
|
## Metrics
|
||||||
|
|
||||||
|
Current implementation achieves:
|
||||||
|
|
||||||
|
- ✅ 458/458 nodes loaded (100%)
|
||||||
|
- ✅ 452 nodes with properties (98.7%)
|
||||||
|
- ✅ 265 nodes with operations (57.9%)
|
||||||
|
- ✅ 406 nodes with documentation (88.6%)
|
||||||
|
- ✅ 35 AI-capable tools detected
|
||||||
|
- ✅ All critical nodes validated
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create a feature branch
|
||||||
|
3. Make your changes
|
||||||
|
4. Run tests and validation
|
||||||
|
5. Submit a pull request
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project uses the Sustainable Use License. See LICENSE file for details.
|
||||||
|
|
||||||
|
Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
- n8n team for the excellent workflow automation platform
|
||||||
|
- Anthropic for the Model Context Protocol specification
|
||||||
192
SETUP.md
Normal file
192
SETUP.md
Normal file
@@ -0,0 +1,192 @@
|
|||||||
|
# n8n-MCP Setup Guide
|
||||||
|
|
||||||
|
This guide will help you set up n8n-MCP with Claude Desktop.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Node.js v20.17.0 (required for Claude Desktop)
|
||||||
|
- npm (comes with Node.js)
|
||||||
|
- Git
|
||||||
|
- Claude Desktop app
|
||||||
|
|
||||||
|
## Step 1: Install Node.js v20.17.0
|
||||||
|
|
||||||
|
### Using nvm (recommended)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install nvm if you haven't already
|
||||||
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
|
||||||
|
|
||||||
|
# Install Node v20.17.0
|
||||||
|
nvm install 20.17.0
|
||||||
|
nvm use 20.17.0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Direct installation
|
||||||
|
|
||||||
|
Download and install Node.js v20.17.0 from [nodejs.org](https://nodejs.org/)
|
||||||
|
|
||||||
|
## Step 2: Clone the Repository
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Clone n8n-mcp
|
||||||
|
git clone https://github.com/yourusername/n8n-mcp.git
|
||||||
|
cd n8n-mcp
|
||||||
|
|
||||||
|
# Clone n8n documentation (required)
|
||||||
|
git clone https://github.com/n8n-io/n8n-docs.git ../n8n-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 3: Install and Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# Build the project
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Initialize the database
|
||||||
|
npm run rebuild
|
||||||
|
|
||||||
|
# Verify installation
|
||||||
|
npm run test-nodes
|
||||||
|
```
|
||||||
|
|
||||||
|
Expected output:
|
||||||
|
```
|
||||||
|
🧪 Running node tests...
|
||||||
|
✅ nodes-base.httpRequest passed all checks
|
||||||
|
✅ nodes-base.slack passed all checks
|
||||||
|
✅ nodes-base.code passed all checks
|
||||||
|
📊 Test Results: 3 passed, 0 failed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 4: Configure Claude Desktop
|
||||||
|
|
||||||
|
### macOS
|
||||||
|
|
||||||
|
1. Copy the example configuration:
|
||||||
|
```bash
|
||||||
|
cp claude_desktop_config.example.json ~/Library/Application\ Support/Claude/claude_desktop_config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Edit the configuration file:
|
||||||
|
```bash
|
||||||
|
nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Update the path to your installation:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"n8n-documentation": {
|
||||||
|
"command": "/Users/yourusername/path/to/n8n-mcp/mcp-server-v20.sh",
|
||||||
|
"args": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
1. Copy the example configuration:
|
||||||
|
```bash
|
||||||
|
copy claude_desktop_config.example.json %APPDATA%\Claude\claude_desktop_config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Edit the configuration with the full path to your installation.
|
||||||
|
|
||||||
|
## Step 5: Create the Wrapper Script
|
||||||
|
|
||||||
|
1. Copy the example wrapper script:
|
||||||
|
```bash
|
||||||
|
cp mcp-server-v20.example.sh mcp-server-v20.sh
|
||||||
|
chmod +x mcp-server-v20.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Edit the script if your nvm path is different:
|
||||||
|
```bash
|
||||||
|
nano mcp-server-v20.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step 6: Restart Claude Desktop
|
||||||
|
|
||||||
|
1. Quit Claude Desktop completely
|
||||||
|
2. Start Claude Desktop again
|
||||||
|
3. You should see "n8n-documentation" in the MCP tools menu
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Node version mismatch
|
||||||
|
|
||||||
|
If you see errors about NODE_MODULE_VERSION:
|
||||||
|
```bash
|
||||||
|
# Make sure you're using Node v20.17.0
|
||||||
|
node --version # Should output: v20.17.0
|
||||||
|
|
||||||
|
# Rebuild native modules
|
||||||
|
npm rebuild better-sqlite3
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database not found
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Rebuild the database
|
||||||
|
npm run rebuild
|
||||||
|
```
|
||||||
|
|
||||||
|
### Permission denied
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Make the wrapper script executable
|
||||||
|
chmod +x mcp-server-v20.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Claude Desktop doesn't see the MCP server
|
||||||
|
|
||||||
|
1. Check the config file location:
|
||||||
|
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
||||||
|
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
||||||
|
|
||||||
|
2. Verify the path in the config is absolute and correct
|
||||||
|
|
||||||
|
3. Check Claude Desktop logs:
|
||||||
|
- macOS: `~/Library/Logs/Claude/mcp.log`
|
||||||
|
|
||||||
|
## Testing the Integration
|
||||||
|
|
||||||
|
Once configured, you can test the integration in Claude Desktop:
|
||||||
|
|
||||||
|
1. Open a new conversation
|
||||||
|
2. Ask: "What MCP tools are available?"
|
||||||
|
3. You should see the n8n documentation tools listed
|
||||||
|
|
||||||
|
Example queries to test:
|
||||||
|
- "List all n8n trigger nodes"
|
||||||
|
- "Show me the properties of the HTTP Request node"
|
||||||
|
- "Search for nodes that work with Slack"
|
||||||
|
- "What AI tools are available in n8n?"
|
||||||
|
|
||||||
|
## Updating
|
||||||
|
|
||||||
|
To update to the latest version:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
npm install
|
||||||
|
npm run build
|
||||||
|
npm run rebuild
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development Mode
|
||||||
|
|
||||||
|
For development with hot reloading:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Make sure you're using Node v20.17.0
|
||||||
|
nvm use 20.17.0
|
||||||
|
|
||||||
|
# Run in development mode
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
8
claude_desktop_config.example.json
Normal file
8
claude_desktop_config.example.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"n8n-documentation": {
|
||||||
|
"command": "/Users/johndoe/projects/n8n-mcp/mcp-server-v20.sh",
|
||||||
|
"args": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"n8n-documentation": {
|
|
||||||
"command": "/Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp/mcp-server.sh",
|
|
||||||
"args": [],
|
|
||||||
"env": {
|
|
||||||
"NODE_ENV": "production"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"n8n-documentation": {
|
|
||||||
"command": "{REPLACE_WITH_PATH_TO_MCP_SERVER_V20_SH}/n8n-mcp/n8n-mcp/mcp-server-v20.sh",
|
|
||||||
"args": []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"n8n-documentation": {
|
|
||||||
"command": "node",
|
|
||||||
"args": [
|
|
||||||
"/Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp/dist/mcp/index.js"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
0
data/.gitkeep
Normal file
0
data/.gitkeep
Normal file
BIN
data/nodes.db
BIN
data/nodes.db
Binary file not shown.
74
docs/v22-implementation-summary.md
Normal file
74
docs/v22-implementation-summary.md
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
# n8n-MCP v2.2 Implementation Summary
|
||||||
|
|
||||||
|
## Successfully Implemented All Fixes from implementation_plan2.md
|
||||||
|
|
||||||
|
### Key Issues Resolved
|
||||||
|
|
||||||
|
1. **Empty Properties/Operations Arrays** ✅
|
||||||
|
- Created dedicated PropertyExtractor class
|
||||||
|
- Properly handles versioned nodes by instantiating them
|
||||||
|
- Extracts properties from latest version of versioned nodes
|
||||||
|
- Result: 452/458 nodes now have properties (98.7%)
|
||||||
|
|
||||||
|
2. **AI Tools Detection** ✅
|
||||||
|
- Deep search for usableAsTool property
|
||||||
|
- Checks in actions and versioned nodes
|
||||||
|
- Name-based heuristics as fallback
|
||||||
|
- Result: 35 AI tools detected
|
||||||
|
|
||||||
|
3. **Versioned Node Support** ✅
|
||||||
|
- Proper detection of VersionedNodeType pattern
|
||||||
|
- Extracts data from instance.nodeVersions
|
||||||
|
- HTTPRequest and Code nodes correctly identified as versioned
|
||||||
|
- Result: All versioned nodes properly handled
|
||||||
|
|
||||||
|
4. **Operations Extraction** ✅
|
||||||
|
- Handles both declarative (routing-based) and programmatic nodes
|
||||||
|
- Extracts from routing.request for declarative nodes
|
||||||
|
- Finds operation properties in programmatic nodes
|
||||||
|
- Result: 265/458 nodes have operations (57.9%)
|
||||||
|
|
||||||
|
### Final Metrics
|
||||||
|
|
||||||
|
```
|
||||||
|
Total nodes: 458
|
||||||
|
Successful: 458 (100%)
|
||||||
|
Failed: 0
|
||||||
|
AI Tools: 35
|
||||||
|
Triggers: 93
|
||||||
|
Webhooks: 71
|
||||||
|
With Properties: 452 (98.7%)
|
||||||
|
With Operations: 265 (57.9%)
|
||||||
|
With Documentation: 406 (88.6%)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Critical Node Tests
|
||||||
|
|
||||||
|
All critical nodes pass validation:
|
||||||
|
- ✅ HTTP Request: 29 properties, versioned, has documentation
|
||||||
|
- ✅ Slack: 17 operations, declarative style
|
||||||
|
- ✅ Code: 11 properties including mode, language, jsCode
|
||||||
|
|
||||||
|
### Architecture Improvements
|
||||||
|
|
||||||
|
1. **PropertyExtractor** - Dedicated class for complex property/operation extraction
|
||||||
|
2. **NodeRepository** - Proper JSON serialization/deserialization
|
||||||
|
3. **Enhanced Parser** - Better versioned node handling
|
||||||
|
4. **Validation** - Built-in validation in rebuild script
|
||||||
|
5. **Test Suite** - Automated testing for critical nodes
|
||||||
|
|
||||||
|
### MCP Server Ready
|
||||||
|
|
||||||
|
The MCP server now correctly:
|
||||||
|
- Returns non-empty properties arrays
|
||||||
|
- Returns non-empty operations arrays
|
||||||
|
- Detects AI tools
|
||||||
|
- Handles alternative node name formats
|
||||||
|
- Uses NodeRepository for consistent data access
|
||||||
|
|
||||||
|
### Next Steps
|
||||||
|
|
||||||
|
1. The implementation is complete and ready for Claude Desktop
|
||||||
|
2. Use `mcp-server-v20.sh` wrapper script for Node v20 compatibility
|
||||||
|
3. All success metrics from v2.2 plan have been achieved
|
||||||
|
4. The system is ready for production use
|
||||||
43
mcp-server-v20.example.sh
Normal file
43
mcp-server-v20.example.sh
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# n8n-MCP Server Wrapper Script for Node v20.17.0
|
||||||
|
# This ensures the server runs with the correct Node version
|
||||||
|
|
||||||
|
# Get the directory where this script is located
|
||||||
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
# Change to the script directory
|
||||||
|
cd "$SCRIPT_DIR"
|
||||||
|
|
||||||
|
# Use Node v20.17.0 specifically (what Claude Desktop uses)
|
||||||
|
# Update this path to match your nvm installation
|
||||||
|
export PATH="$HOME/.nvm/versions/node/v20.17.0/bin:$PATH"
|
||||||
|
|
||||||
|
# Verify we're using the right version
|
||||||
|
NODE_VERSION=$(node --version)
|
||||||
|
if [ "$NODE_VERSION" != "v20.17.0" ]; then
|
||||||
|
echo "Error: Wrong Node.js version. Expected v20.17.0, got $NODE_VERSION" >&2
|
||||||
|
echo "Please install Node v20.17.0 using nvm: nvm install 20.17.0" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if node_modules exists
|
||||||
|
if [ ! -d "node_modules" ]; then
|
||||||
|
echo "Error: node_modules not found. Please run 'npm install' first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if database exists
|
||||||
|
if [ ! -f "data/nodes.db" ]; then
|
||||||
|
echo "Error: Database not found. Please run 'npm run rebuild' first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if dist directory exists
|
||||||
|
if [ ! -d "dist" ]; then
|
||||||
|
echo "Error: dist directory not found. Please run 'npm run build' first." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run the MCP server
|
||||||
|
exec node "$SCRIPT_DIR/dist/mcp/index.js"
|
||||||
@@ -10,7 +10,8 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|||||||
cd "$SCRIPT_DIR"
|
cd "$SCRIPT_DIR"
|
||||||
|
|
||||||
# Use Node v20.17.0 specifically (what Claude Desktop uses)
|
# Use Node v20.17.0 specifically (what Claude Desktop uses)
|
||||||
export PATH="/Users/romualdczlonkowski/.nvm/versions/node/v20.17.0/bin:$PATH"
|
# Update this path to match your nvm installation
|
||||||
|
export PATH="$HOME/.nvm/versions/node/v20.17.0/bin:$PATH"
|
||||||
|
|
||||||
# Verify we're using the right version
|
# Verify we're using the right version
|
||||||
NODE_VERSION=$(node --version)
|
NODE_VERSION=$(node --version)
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"rebuild": "node dist/scripts/rebuild.js",
|
"rebuild": "node dist/scripts/rebuild.js",
|
||||||
"validate": "node dist/scripts/validate.js",
|
"validate": "node dist/scripts/validate.js",
|
||||||
|
"test-nodes": "node dist/scripts/test-nodes.js",
|
||||||
"start": "node dist/mcp/index.js",
|
"start": "node dist/mcp/index.js",
|
||||||
"dev": "npm run build && npm run rebuild && npm run validate",
|
"dev": "npm run build && npm run rebuild && npm run validate",
|
||||||
"test": "jest",
|
"test": "jest",
|
||||||
@@ -20,8 +21,8 @@
|
|||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/czlonkowski/n8n-mcp.git"
|
"url": "git+https://github.com/czlonkowski/n8n-mcp.git"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": ["n8n", "mcp", "model-context-protocol", "ai", "workflow", "automation"],
|
||||||
"author": "",
|
"author": "AiAdvisors Romuald Czlonkowski",
|
||||||
"license": "Sustainable-Use-1.0",
|
"license": "Sustainable-Use-1.0",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/czlonkowski/n8n-mcp/issues"
|
"url": "https://github.com/czlonkowski/n8n-mcp/issues"
|
||||||
|
|||||||
94
src/database/node-repository.ts
Normal file
94
src/database/node-repository.ts
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
import Database from 'better-sqlite3';
|
||||||
|
import { ParsedNode } from '../parsers/node-parser';
|
||||||
|
|
||||||
|
export class NodeRepository {
|
||||||
|
constructor(private db: Database.Database) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Save node with proper JSON serialization
|
||||||
|
*/
|
||||||
|
saveNode(node: ParsedNode): void {
|
||||||
|
const stmt = this.db.prepare(`
|
||||||
|
INSERT OR REPLACE INTO nodes (
|
||||||
|
node_type, package_name, display_name, description,
|
||||||
|
category, development_style, is_ai_tool, is_trigger,
|
||||||
|
is_webhook, is_versioned, version, documentation,
|
||||||
|
properties_schema, operations, credentials_required
|
||||||
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
|
`);
|
||||||
|
|
||||||
|
stmt.run(
|
||||||
|
node.nodeType,
|
||||||
|
node.packageName,
|
||||||
|
node.displayName,
|
||||||
|
node.description,
|
||||||
|
node.category,
|
||||||
|
node.style,
|
||||||
|
node.isAITool ? 1 : 0,
|
||||||
|
node.isTrigger ? 1 : 0,
|
||||||
|
node.isWebhook ? 1 : 0,
|
||||||
|
node.isVersioned ? 1 : 0,
|
||||||
|
node.version,
|
||||||
|
node.documentation || null,
|
||||||
|
JSON.stringify(node.properties, null, 2),
|
||||||
|
JSON.stringify(node.operations, null, 2),
|
||||||
|
JSON.stringify(node.credentials, null, 2)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get node with proper JSON deserialization
|
||||||
|
*/
|
||||||
|
getNode(nodeType: string): any {
|
||||||
|
const row = this.db.prepare(`
|
||||||
|
SELECT * FROM nodes WHERE node_type = ?
|
||||||
|
`).get(nodeType) as any;
|
||||||
|
|
||||||
|
if (!row) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
nodeType: row.node_type,
|
||||||
|
displayName: row.display_name,
|
||||||
|
description: row.description,
|
||||||
|
category: row.category,
|
||||||
|
developmentStyle: row.development_style,
|
||||||
|
package: row.package_name,
|
||||||
|
isAITool: !!row.is_ai_tool,
|
||||||
|
isTrigger: !!row.is_trigger,
|
||||||
|
isWebhook: !!row.is_webhook,
|
||||||
|
isVersioned: !!row.is_versioned,
|
||||||
|
version: row.version,
|
||||||
|
properties: this.safeJsonParse(row.properties_schema, []),
|
||||||
|
operations: this.safeJsonParse(row.operations, []),
|
||||||
|
credentials: this.safeJsonParse(row.credentials_required, []),
|
||||||
|
hasDocumentation: !!row.documentation
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get AI tools with proper filtering
|
||||||
|
*/
|
||||||
|
getAITools(): any[] {
|
||||||
|
const rows = this.db.prepare(`
|
||||||
|
SELECT node_type, display_name, description, package_name
|
||||||
|
FROM nodes
|
||||||
|
WHERE is_ai_tool = 1
|
||||||
|
ORDER BY display_name
|
||||||
|
`).all() as any[];
|
||||||
|
|
||||||
|
return rows.map(row => ({
|
||||||
|
nodeType: row.node_type,
|
||||||
|
displayName: row.display_name,
|
||||||
|
description: row.description,
|
||||||
|
package: row.package_name
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
private safeJsonParse(json: string, defaultValue: any): any {
|
||||||
|
try {
|
||||||
|
return JSON.parse(json);
|
||||||
|
} catch {
|
||||||
|
return defaultValue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,3 +1,9 @@
|
|||||||
|
/**
|
||||||
|
* n8n-MCP - Model Context Protocol Server for n8n
|
||||||
|
* Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
* Licensed under the Sustainable Use License v1.0
|
||||||
|
*/
|
||||||
|
|
||||||
import dotenv from 'dotenv';
|
import dotenv from 'dotenv';
|
||||||
import { N8NMCPServer } from './mcp/server';
|
import { N8NMCPServer } from './mcp/server';
|
||||||
import { MCPServerConfig, N8NConfig } from './types';
|
import { MCPServerConfig, N8NConfig } from './types';
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import { existsSync } from 'fs';
|
|||||||
import path from 'path';
|
import path from 'path';
|
||||||
import { n8nDocumentationTools } from './tools-update';
|
import { n8nDocumentationTools } from './tools-update';
|
||||||
import { logger } from '../utils/logger';
|
import { logger } from '../utils/logger';
|
||||||
|
import { NodeRepository } from '../database/node-repository';
|
||||||
|
|
||||||
interface NodeRow {
|
interface NodeRow {
|
||||||
node_type: string;
|
node_type: string;
|
||||||
@@ -31,6 +32,7 @@ interface NodeRow {
|
|||||||
export class N8NDocumentationMCPServer {
|
export class N8NDocumentationMCPServer {
|
||||||
private server: Server;
|
private server: Server;
|
||||||
private db: Database.Database;
|
private db: Database.Database;
|
||||||
|
private repository: NodeRepository;
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
// Try multiple database paths
|
// Try multiple database paths
|
||||||
@@ -55,6 +57,7 @@ export class N8NDocumentationMCPServer {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
this.db = new Database(dbPath);
|
this.db = new Database(dbPath);
|
||||||
|
this.repository = new NodeRepository(this.db);
|
||||||
logger.info(`Initialized database from: ${dbPath}`);
|
logger.info(`Initialized database from: ${dbPath}`);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
logger.error('Failed to initialize database:', error);
|
logger.error('Failed to initialize database:', error);
|
||||||
@@ -184,31 +187,31 @@ export class N8NDocumentationMCPServer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private getNodeInfo(nodeType: string): any {
|
private getNodeInfo(nodeType: string): any {
|
||||||
const node = this.db.prepare(`
|
let node = this.repository.getNode(nodeType);
|
||||||
SELECT * FROM nodes WHERE node_type = ?
|
|
||||||
`).get(nodeType) as NodeRow | undefined;
|
if (!node) {
|
||||||
|
// Try alternative formats
|
||||||
|
const alternatives = [
|
||||||
|
nodeType,
|
||||||
|
nodeType.replace('n8n-nodes-base.', ''),
|
||||||
|
`n8n-nodes-base.${nodeType}`,
|
||||||
|
nodeType.toLowerCase()
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const alt of alternatives) {
|
||||||
|
const found = this.repository.getNode(alt);
|
||||||
|
if (found) {
|
||||||
|
node = found;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (!node) {
|
if (!node) {
|
||||||
throw new Error(`Node ${nodeType} not found`);
|
throw new Error(`Node ${nodeType} not found`);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return node;
|
||||||
nodeType: node.node_type,
|
|
||||||
displayName: node.display_name,
|
|
||||||
description: node.description,
|
|
||||||
category: node.category,
|
|
||||||
developmentStyle: node.development_style,
|
|
||||||
package: node.package_name,
|
|
||||||
isAITool: !!node.is_ai_tool,
|
|
||||||
isTrigger: !!node.is_trigger,
|
|
||||||
isWebhook: !!node.is_webhook,
|
|
||||||
isVersioned: !!node.is_versioned,
|
|
||||||
version: node.version,
|
|
||||||
properties: JSON.parse(node.properties_schema || '[]'),
|
|
||||||
operations: JSON.parse(node.operations || '[]'),
|
|
||||||
credentials: JSON.parse(node.credentials_required || '[]'),
|
|
||||||
hasDocumentation: !!node.documentation,
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private searchNodes(query: string, limit: number = 20): any {
|
private searchNodes(query: string, limit: number = 20): any {
|
||||||
@@ -256,20 +259,10 @@ export class N8NDocumentationMCPServer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private listAITools(): any {
|
private listAITools(): any {
|
||||||
const tools = this.db.prepare(`
|
const tools = this.repository.getAITools();
|
||||||
SELECT node_type, display_name, description, package_name
|
|
||||||
FROM nodes
|
|
||||||
WHERE is_ai_tool = 1
|
|
||||||
ORDER BY display_name
|
|
||||||
`).all() as NodeRow[];
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
tools: tools.map(tool => ({
|
tools,
|
||||||
nodeType: tool.node_type,
|
|
||||||
displayName: tool.display_name,
|
|
||||||
description: tool.description,
|
|
||||||
package: tool.package_name,
|
|
||||||
})),
|
|
||||||
totalCount: tools.length,
|
totalCount: tools.length,
|
||||||
requirements: {
|
requirements: {
|
||||||
environmentVariable: 'N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true',
|
environmentVariable: 'N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true',
|
||||||
|
|||||||
164
src/parsers/node-parser.ts
Normal file
164
src/parsers/node-parser.ts
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
import { PropertyExtractor } from './property-extractor';
|
||||||
|
|
||||||
|
export interface ParsedNode {
|
||||||
|
style: 'declarative' | 'programmatic';
|
||||||
|
nodeType: string;
|
||||||
|
displayName: string;
|
||||||
|
description?: string;
|
||||||
|
category?: string;
|
||||||
|
properties: any[];
|
||||||
|
credentials: any[];
|
||||||
|
isAITool: boolean;
|
||||||
|
isTrigger: boolean;
|
||||||
|
isWebhook: boolean;
|
||||||
|
operations: any[];
|
||||||
|
version?: string;
|
||||||
|
isVersioned: boolean;
|
||||||
|
packageName: string;
|
||||||
|
documentation?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class NodeParser {
|
||||||
|
private propertyExtractor = new PropertyExtractor();
|
||||||
|
|
||||||
|
parse(nodeClass: any, packageName: string): ParsedNode {
|
||||||
|
// Get base description (handles versioned nodes)
|
||||||
|
const description = this.getNodeDescription(nodeClass);
|
||||||
|
|
||||||
|
return {
|
||||||
|
style: this.detectStyle(nodeClass),
|
||||||
|
nodeType: this.extractNodeType(description, packageName),
|
||||||
|
displayName: description.displayName || description.name,
|
||||||
|
description: description.description,
|
||||||
|
category: this.extractCategory(description),
|
||||||
|
properties: this.propertyExtractor.extractProperties(nodeClass),
|
||||||
|
credentials: this.propertyExtractor.extractCredentials(nodeClass),
|
||||||
|
isAITool: this.propertyExtractor.detectAIToolCapability(nodeClass),
|
||||||
|
isTrigger: this.detectTrigger(description),
|
||||||
|
isWebhook: this.detectWebhook(description),
|
||||||
|
operations: this.propertyExtractor.extractOperations(nodeClass),
|
||||||
|
version: this.extractVersion(nodeClass),
|
||||||
|
isVersioned: this.detectVersioned(nodeClass),
|
||||||
|
packageName: packageName
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private getNodeDescription(nodeClass: any): any {
|
||||||
|
// Try to get description from the class first
|
||||||
|
let description: any;
|
||||||
|
|
||||||
|
// Check if it's a versioned node (has baseDescription and nodeVersions)
|
||||||
|
if (typeof nodeClass === 'function' && nodeClass.prototype &&
|
||||||
|
nodeClass.prototype.constructor &&
|
||||||
|
nodeClass.prototype.constructor.name === 'VersionedNodeType') {
|
||||||
|
// This is a VersionedNodeType class - instantiate it
|
||||||
|
const instance = new nodeClass();
|
||||||
|
description = instance.baseDescription || {};
|
||||||
|
} else if (typeof nodeClass === 'function') {
|
||||||
|
// Try to instantiate to get description
|
||||||
|
try {
|
||||||
|
const instance = new nodeClass();
|
||||||
|
description = instance.description || {};
|
||||||
|
|
||||||
|
// For versioned nodes, we might need to look deeper
|
||||||
|
if (!description.name && instance.baseDescription) {
|
||||||
|
description = instance.baseDescription;
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// Some nodes might require parameters to instantiate
|
||||||
|
// Try to access static properties
|
||||||
|
description = nodeClass.description || {};
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Maybe it's already an instance
|
||||||
|
description = nodeClass.description || {};
|
||||||
|
}
|
||||||
|
|
||||||
|
return description;
|
||||||
|
}
|
||||||
|
|
||||||
|
private detectStyle(nodeClass: any): 'declarative' | 'programmatic' {
|
||||||
|
const desc = this.getNodeDescription(nodeClass);
|
||||||
|
return desc.routing ? 'declarative' : 'programmatic';
|
||||||
|
}
|
||||||
|
|
||||||
|
private extractNodeType(description: any, packageName: string): string {
|
||||||
|
// Ensure we have the full node type including package prefix
|
||||||
|
const name = description.name;
|
||||||
|
|
||||||
|
if (!name) {
|
||||||
|
throw new Error('Node is missing name property');
|
||||||
|
}
|
||||||
|
|
||||||
|
if (name.includes('.')) {
|
||||||
|
return name;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add package prefix if missing
|
||||||
|
const packagePrefix = packageName.replace('@n8n/', '').replace('n8n-', '');
|
||||||
|
return `${packagePrefix}.${name}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private extractCategory(description: any): string {
|
||||||
|
return description.group?.[0] ||
|
||||||
|
description.categories?.[0] ||
|
||||||
|
description.category ||
|
||||||
|
'misc';
|
||||||
|
}
|
||||||
|
|
||||||
|
private detectTrigger(description: any): boolean {
|
||||||
|
return description.polling === true ||
|
||||||
|
description.trigger === true ||
|
||||||
|
description.eventTrigger === true ||
|
||||||
|
description.name?.toLowerCase().includes('trigger');
|
||||||
|
}
|
||||||
|
|
||||||
|
private detectWebhook(description: any): boolean {
|
||||||
|
return (description.webhooks?.length > 0) ||
|
||||||
|
description.webhook === true ||
|
||||||
|
description.name?.toLowerCase().includes('webhook');
|
||||||
|
}
|
||||||
|
|
||||||
|
private extractVersion(nodeClass: any): string {
|
||||||
|
if (nodeClass.baseDescription?.defaultVersion) {
|
||||||
|
return nodeClass.baseDescription.defaultVersion.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (nodeClass.nodeVersions) {
|
||||||
|
const versions = Object.keys(nodeClass.nodeVersions);
|
||||||
|
return Math.max(...versions.map(Number)).toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check instance for nodeVersions
|
||||||
|
try {
|
||||||
|
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
|
||||||
|
if (instance?.nodeVersions) {
|
||||||
|
const versions = Object.keys(instance.nodeVersions);
|
||||||
|
return Math.max(...versions.map(Number)).toString();
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// Ignore
|
||||||
|
}
|
||||||
|
|
||||||
|
return nodeClass.description?.version || '1';
|
||||||
|
}
|
||||||
|
|
||||||
|
private detectVersioned(nodeClass: any): boolean {
|
||||||
|
// Check class-level nodeVersions
|
||||||
|
if (nodeClass.nodeVersions || nodeClass.baseDescription?.defaultVersion) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check instance-level nodeVersions
|
||||||
|
try {
|
||||||
|
const instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
|
||||||
|
if (instance?.nodeVersions) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// Ignore
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
215
src/parsers/property-extractor.ts
Normal file
215
src/parsers/property-extractor.ts
Normal file
@@ -0,0 +1,215 @@
|
|||||||
|
export class PropertyExtractor {
|
||||||
|
/**
|
||||||
|
* Extract properties with proper handling of n8n's complex structures
|
||||||
|
*/
|
||||||
|
extractProperties(nodeClass: any): any[] {
|
||||||
|
const properties: any[] = [];
|
||||||
|
|
||||||
|
// First try to get instance-level properties
|
||||||
|
let instance: any;
|
||||||
|
try {
|
||||||
|
instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
|
||||||
|
} catch (e) {
|
||||||
|
// Failed to instantiate
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle versioned nodes - check instance for nodeVersions
|
||||||
|
if (instance?.nodeVersions) {
|
||||||
|
const versions = Object.keys(instance.nodeVersions);
|
||||||
|
const latestVersion = Math.max(...versions.map(Number));
|
||||||
|
const versionedNode = instance.nodeVersions[latestVersion];
|
||||||
|
|
||||||
|
if (versionedNode?.description?.properties) {
|
||||||
|
return this.normalizeProperties(versionedNode.description.properties);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for description with properties
|
||||||
|
const description = instance?.description || instance?.baseDescription ||
|
||||||
|
this.getNodeDescription(nodeClass);
|
||||||
|
|
||||||
|
if (description?.properties) {
|
||||||
|
return this.normalizeProperties(description.properties);
|
||||||
|
}
|
||||||
|
|
||||||
|
return properties;
|
||||||
|
}
|
||||||
|
|
||||||
|
private getNodeDescription(nodeClass: any): any {
|
||||||
|
// Try to get description from the class first
|
||||||
|
let description: any;
|
||||||
|
|
||||||
|
if (typeof nodeClass === 'function') {
|
||||||
|
// Try to instantiate to get description
|
||||||
|
try {
|
||||||
|
const instance = new nodeClass();
|
||||||
|
description = instance.description || instance.baseDescription || {};
|
||||||
|
} catch (e) {
|
||||||
|
// Some nodes might require parameters to instantiate
|
||||||
|
description = nodeClass.description || {};
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
description = nodeClass.description || {};
|
||||||
|
}
|
||||||
|
|
||||||
|
return description;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract operations from both declarative and programmatic nodes
|
||||||
|
*/
|
||||||
|
extractOperations(nodeClass: any): any[] {
|
||||||
|
const operations: any[] = [];
|
||||||
|
|
||||||
|
// First try to get instance-level data
|
||||||
|
let instance: any;
|
||||||
|
try {
|
||||||
|
instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
|
||||||
|
} catch (e) {
|
||||||
|
// Failed to instantiate
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle versioned nodes
|
||||||
|
if (instance?.nodeVersions) {
|
||||||
|
const versions = Object.keys(instance.nodeVersions);
|
||||||
|
const latestVersion = Math.max(...versions.map(Number));
|
||||||
|
const versionedNode = instance.nodeVersions[latestVersion];
|
||||||
|
|
||||||
|
if (versionedNode?.description) {
|
||||||
|
return this.extractOperationsFromDescription(versionedNode.description);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get description
|
||||||
|
const description = instance?.description || instance?.baseDescription ||
|
||||||
|
this.getNodeDescription(nodeClass);
|
||||||
|
|
||||||
|
return this.extractOperationsFromDescription(description);
|
||||||
|
}
|
||||||
|
|
||||||
|
private extractOperationsFromDescription(description: any): any[] {
|
||||||
|
const operations: any[] = [];
|
||||||
|
|
||||||
|
if (!description) return operations;
|
||||||
|
|
||||||
|
// Declarative nodes (with routing)
|
||||||
|
if (description.routing) {
|
||||||
|
const routing = description.routing;
|
||||||
|
|
||||||
|
// Extract from request.resource and request.operation
|
||||||
|
if (routing.request?.resource) {
|
||||||
|
const resources = routing.request.resource.options || [];
|
||||||
|
const operationOptions = routing.request.operation?.options || {};
|
||||||
|
|
||||||
|
resources.forEach((resource: any) => {
|
||||||
|
const resourceOps = operationOptions[resource.value] || [];
|
||||||
|
resourceOps.forEach((op: any) => {
|
||||||
|
operations.push({
|
||||||
|
resource: resource.value,
|
||||||
|
operation: op.value,
|
||||||
|
name: `${resource.name} - ${op.name}`,
|
||||||
|
action: op.action
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Programmatic nodes - look for operation property in properties
|
||||||
|
if (description.properties && Array.isArray(description.properties)) {
|
||||||
|
const operationProp = description.properties.find(
|
||||||
|
(p: any) => p.name === 'operation' || p.name === 'action'
|
||||||
|
);
|
||||||
|
|
||||||
|
if (operationProp?.options) {
|
||||||
|
operationProp.options.forEach((op: any) => {
|
||||||
|
operations.push({
|
||||||
|
operation: op.value,
|
||||||
|
name: op.name,
|
||||||
|
description: op.description
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return operations;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deep search for AI tool capability
|
||||||
|
*/
|
||||||
|
detectAIToolCapability(nodeClass: any): boolean {
|
||||||
|
const description = this.getNodeDescription(nodeClass);
|
||||||
|
|
||||||
|
// Direct property check
|
||||||
|
if (description?.usableAsTool === true) return true;
|
||||||
|
|
||||||
|
// Check in actions for declarative nodes
|
||||||
|
if (description?.actions?.some((a: any) => a.usableAsTool === true)) return true;
|
||||||
|
|
||||||
|
// Check versioned nodes
|
||||||
|
if (nodeClass.nodeVersions) {
|
||||||
|
for (const version of Object.values(nodeClass.nodeVersions)) {
|
||||||
|
if ((version as any).description?.usableAsTool === true) return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for specific AI-related properties
|
||||||
|
const aiIndicators = ['openai', 'anthropic', 'huggingface', 'cohere', 'ai'];
|
||||||
|
const nodeName = description?.name?.toLowerCase() || '';
|
||||||
|
|
||||||
|
return aiIndicators.some(indicator => nodeName.includes(indicator));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract credential requirements with proper structure
|
||||||
|
*/
|
||||||
|
extractCredentials(nodeClass: any): any[] {
|
||||||
|
const credentials: any[] = [];
|
||||||
|
|
||||||
|
// First try to get instance-level data
|
||||||
|
let instance: any;
|
||||||
|
try {
|
||||||
|
instance = typeof nodeClass === 'function' ? new nodeClass() : nodeClass;
|
||||||
|
} catch (e) {
|
||||||
|
// Failed to instantiate
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle versioned nodes
|
||||||
|
if (instance?.nodeVersions) {
|
||||||
|
const versions = Object.keys(instance.nodeVersions);
|
||||||
|
const latestVersion = Math.max(...versions.map(Number));
|
||||||
|
const versionedNode = instance.nodeVersions[latestVersion];
|
||||||
|
|
||||||
|
if (versionedNode?.description?.credentials) {
|
||||||
|
return versionedNode.description.credentials;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for description with credentials
|
||||||
|
const description = instance?.description || instance?.baseDescription ||
|
||||||
|
this.getNodeDescription(nodeClass);
|
||||||
|
|
||||||
|
if (description?.credentials) {
|
||||||
|
return description.credentials;
|
||||||
|
}
|
||||||
|
|
||||||
|
return credentials;
|
||||||
|
}
|
||||||
|
|
||||||
|
private normalizeProperties(properties: any[]): any[] {
|
||||||
|
// Ensure all properties have consistent structure
|
||||||
|
return properties.map(prop => ({
|
||||||
|
displayName: prop.displayName,
|
||||||
|
name: prop.name,
|
||||||
|
type: prop.type,
|
||||||
|
default: prop.default,
|
||||||
|
description: prop.description,
|
||||||
|
options: prop.options,
|
||||||
|
required: prop.required,
|
||||||
|
displayOptions: prop.displayOptions,
|
||||||
|
typeOptions: prop.typeOptions,
|
||||||
|
noDataExpression: prop.noDataExpression
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
65
src/scripts/debug-node.ts
Normal file
65
src/scripts/debug-node.ts
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
import { N8nNodeLoader } from '../loaders/node-loader';
|
||||||
|
import { NodeParser } from '../parsers/node-parser';
|
||||||
|
|
||||||
|
async function debugNode() {
|
||||||
|
const loader = new N8nNodeLoader();
|
||||||
|
const parser = new NodeParser();
|
||||||
|
|
||||||
|
console.log('Loading nodes...');
|
||||||
|
const nodes = await loader.loadAllNodes();
|
||||||
|
|
||||||
|
// Find HTTP Request node
|
||||||
|
const httpNode = nodes.find(n => n.nodeName === 'HttpRequest');
|
||||||
|
|
||||||
|
if (httpNode) {
|
||||||
|
console.log('\n=== HTTP Request Node Debug ===');
|
||||||
|
console.log('NodeName:', httpNode.nodeName);
|
||||||
|
console.log('Package:', httpNode.packageName);
|
||||||
|
console.log('NodeClass type:', typeof httpNode.NodeClass);
|
||||||
|
console.log('NodeClass constructor name:', httpNode.NodeClass?.constructor?.name);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = parser.parse(httpNode.NodeClass, httpNode.packageName);
|
||||||
|
console.log('\nParsed successfully:');
|
||||||
|
console.log('- Node Type:', parsed.nodeType);
|
||||||
|
console.log('- Display Name:', parsed.displayName);
|
||||||
|
console.log('- Style:', parsed.style);
|
||||||
|
console.log('- Properties count:', parsed.properties.length);
|
||||||
|
console.log('- Operations count:', parsed.operations.length);
|
||||||
|
console.log('- Is AI Tool:', parsed.isAITool);
|
||||||
|
console.log('- Is Versioned:', parsed.isVersioned);
|
||||||
|
|
||||||
|
if (parsed.properties.length > 0) {
|
||||||
|
console.log('\nFirst property:', parsed.properties[0]);
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.error('\nError parsing node:', (error as Error).message);
|
||||||
|
console.error('Stack:', (error as Error).stack);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log('HTTP Request node not found');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find Code node
|
||||||
|
const codeNode = nodes.find(n => n.nodeName === 'Code');
|
||||||
|
|
||||||
|
if (codeNode) {
|
||||||
|
console.log('\n\n=== Code Node Debug ===');
|
||||||
|
console.log('NodeName:', codeNode.nodeName);
|
||||||
|
console.log('Package:', codeNode.packageName);
|
||||||
|
console.log('NodeClass type:', typeof codeNode.NodeClass);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const parsed = parser.parse(codeNode.NodeClass, codeNode.packageName);
|
||||||
|
console.log('\nParsed successfully:');
|
||||||
|
console.log('- Node Type:', parsed.nodeType);
|
||||||
|
console.log('- Properties count:', parsed.properties.length);
|
||||||
|
console.log('- Is Versioned:', parsed.isVersioned);
|
||||||
|
} catch (error) {
|
||||||
|
console.error('\nError parsing node:', (error as Error).message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
debugNode().catch(console.error);
|
||||||
@@ -1,22 +1,27 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
* Licensed under the Sustainable Use License v1.0
|
||||||
|
*/
|
||||||
import Database from 'better-sqlite3';
|
import Database from 'better-sqlite3';
|
||||||
import { N8nNodeLoader } from '../loaders/node-loader';
|
import { N8nNodeLoader } from '../loaders/node-loader';
|
||||||
import { SimpleParser } from '../parsers/simple-parser';
|
import { NodeParser } from '../parsers/node-parser';
|
||||||
import { DocsMapper } from '../mappers/docs-mapper';
|
import { DocsMapper } from '../mappers/docs-mapper';
|
||||||
import { readFileSync } from 'fs';
|
import { NodeRepository } from '../database/node-repository';
|
||||||
import path from 'path';
|
import * as fs from 'fs';
|
||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
async function rebuild() {
|
async function rebuild() {
|
||||||
console.log('🔄 Rebuilding n8n node database...\n');
|
console.log('🔄 Rebuilding n8n node database...\n');
|
||||||
|
|
||||||
const db = new Database('./data/nodes.db');
|
const db = new Database('./data/nodes.db');
|
||||||
const loader = new N8nNodeLoader();
|
const loader = new N8nNodeLoader();
|
||||||
const parser = new SimpleParser();
|
const parser = new NodeParser();
|
||||||
const mapper = new DocsMapper();
|
const mapper = new DocsMapper();
|
||||||
|
const repository = new NodeRepository(db);
|
||||||
|
|
||||||
// Initialize database
|
// Initialize database
|
||||||
const schemaPath = path.join(__dirname, '../../src/database/schema.sql');
|
const schema = fs.readFileSync(path.join(__dirname, '../../src/database/schema.sql'), 'utf8');
|
||||||
const schema = readFileSync(schemaPath, 'utf8');
|
|
||||||
db.exec(schema);
|
db.exec(schema);
|
||||||
|
|
||||||
// Clear existing data
|
// Clear existing data
|
||||||
@@ -28,74 +33,108 @@ async function rebuild() {
|
|||||||
console.log(`📦 Loaded ${nodes.length} nodes from packages\n`);
|
console.log(`📦 Loaded ${nodes.length} nodes from packages\n`);
|
||||||
|
|
||||||
// Statistics
|
// Statistics
|
||||||
let successful = 0;
|
const stats = {
|
||||||
let failed = 0;
|
successful: 0,
|
||||||
let aiTools = 0;
|
failed: 0,
|
||||||
|
aiTools: 0,
|
||||||
|
triggers: 0,
|
||||||
|
webhooks: 0,
|
||||||
|
withProperties: 0,
|
||||||
|
withOperations: 0,
|
||||||
|
withDocs: 0
|
||||||
|
};
|
||||||
|
|
||||||
// Process each node
|
// Process each node
|
||||||
for (const { packageName, nodeName, NodeClass } of nodes) {
|
for (const { packageName, nodeName, NodeClass } of nodes) {
|
||||||
try {
|
try {
|
||||||
// Debug: log what we're working with
|
|
||||||
// Don't check for description here since it might be an instance property
|
|
||||||
if (!NodeClass) {
|
|
||||||
console.error(`❌ Node ${nodeName} has no NodeClass`);
|
|
||||||
failed++;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse node
|
// Parse node
|
||||||
const parsed = parser.parse(NodeClass);
|
const parsed = parser.parse(NodeClass, packageName);
|
||||||
|
|
||||||
|
// Validate parsed data
|
||||||
|
if (!parsed.nodeType || !parsed.displayName) {
|
||||||
|
throw new Error('Missing required fields');
|
||||||
|
}
|
||||||
|
|
||||||
// Get documentation
|
// Get documentation
|
||||||
const docs = await mapper.fetchDocumentation(parsed.nodeType);
|
const docs = await mapper.fetchDocumentation(parsed.nodeType);
|
||||||
|
parsed.documentation = docs || undefined;
|
||||||
|
|
||||||
// Insert into database
|
// Save to database
|
||||||
db.prepare(`
|
repository.saveNode(parsed);
|
||||||
INSERT INTO nodes (
|
|
||||||
node_type, package_name, display_name, description,
|
|
||||||
category, development_style, is_ai_tool, is_trigger,
|
|
||||||
is_webhook, is_versioned, version, documentation,
|
|
||||||
properties_schema, operations, credentials_required
|
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
|
||||||
`).run(
|
|
||||||
parsed.nodeType,
|
|
||||||
packageName,
|
|
||||||
parsed.displayName,
|
|
||||||
parsed.description,
|
|
||||||
parsed.category,
|
|
||||||
parsed.style,
|
|
||||||
parsed.isAITool ? 1 : 0,
|
|
||||||
parsed.isTrigger ? 1 : 0,
|
|
||||||
parsed.isWebhook ? 1 : 0,
|
|
||||||
parsed.isVersioned ? 1 : 0,
|
|
||||||
parsed.version,
|
|
||||||
docs,
|
|
||||||
JSON.stringify(parsed.properties),
|
|
||||||
JSON.stringify(parsed.operations),
|
|
||||||
JSON.stringify(parsed.credentials)
|
|
||||||
);
|
|
||||||
|
|
||||||
successful++;
|
// Update statistics
|
||||||
if (parsed.isAITool) aiTools++;
|
stats.successful++;
|
||||||
|
if (parsed.isAITool) stats.aiTools++;
|
||||||
|
if (parsed.isTrigger) stats.triggers++;
|
||||||
|
if (parsed.isWebhook) stats.webhooks++;
|
||||||
|
if (parsed.properties.length > 0) stats.withProperties++;
|
||||||
|
if (parsed.operations.length > 0) stats.withOperations++;
|
||||||
|
if (docs) stats.withDocs++;
|
||||||
|
|
||||||
console.log(`✅ ${parsed.nodeType}`);
|
console.log(`✅ ${parsed.nodeType} [Props: ${parsed.properties.length}, Ops: ${parsed.operations.length}]`);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
failed++;
|
stats.failed++;
|
||||||
console.error(`❌ Failed to process ${nodeName}: ${(error as Error).message}`);
|
console.error(`❌ Failed to process ${nodeName}: ${(error as Error).message}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validation check
|
||||||
|
console.log('\n🔍 Running validation checks...');
|
||||||
|
const validationResults = validateDatabase(repository);
|
||||||
|
|
||||||
// Summary
|
// Summary
|
||||||
console.log('\n📊 Summary:');
|
console.log('\n📊 Summary:');
|
||||||
console.log(` Total nodes: ${nodes.length}`);
|
console.log(` Total nodes: ${nodes.length}`);
|
||||||
console.log(` Successful: ${successful}`);
|
console.log(` Successful: ${stats.successful}`);
|
||||||
console.log(` Failed: ${failed}`);
|
console.log(` Failed: ${stats.failed}`);
|
||||||
console.log(` AI Tools: ${aiTools}`);
|
console.log(` AI Tools: ${stats.aiTools}`);
|
||||||
|
console.log(` Triggers: ${stats.triggers}`);
|
||||||
|
console.log(` Webhooks: ${stats.webhooks}`);
|
||||||
|
console.log(` With Properties: ${stats.withProperties}`);
|
||||||
|
console.log(` With Operations: ${stats.withOperations}`);
|
||||||
|
console.log(` With Documentation: ${stats.withDocs}`);
|
||||||
|
|
||||||
|
if (!validationResults.passed) {
|
||||||
|
console.log('\n⚠️ Validation Issues:');
|
||||||
|
validationResults.issues.forEach(issue => console.log(` - ${issue}`));
|
||||||
|
}
|
||||||
|
|
||||||
console.log('\n✨ Rebuild complete!');
|
console.log('\n✨ Rebuild complete!');
|
||||||
|
|
||||||
db.close();
|
db.close();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function validateDatabase(repository: NodeRepository): { passed: boolean; issues: string[] } {
|
||||||
|
const issues = [];
|
||||||
|
|
||||||
|
// Check critical nodes
|
||||||
|
const criticalNodes = ['nodes-base.httpRequest', 'nodes-base.code', 'nodes-base.webhook', 'nodes-base.slack'];
|
||||||
|
|
||||||
|
for (const nodeType of criticalNodes) {
|
||||||
|
const node = repository.getNode(nodeType);
|
||||||
|
|
||||||
|
if (!node) {
|
||||||
|
issues.push(`Critical node ${nodeType} not found`);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (node.properties.length === 0) {
|
||||||
|
issues.push(`Node ${nodeType} has no properties`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check AI tools
|
||||||
|
const aiTools = repository.getAITools();
|
||||||
|
if (aiTools.length === 0) {
|
||||||
|
issues.push('No AI tools found - check detection logic');
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
passed: issues.length === 0,
|
||||||
|
issues
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
// Run if called directly
|
// Run if called directly
|
||||||
if (require.main === module) {
|
if (require.main === module) {
|
||||||
rebuild().catch(console.error);
|
rebuild().catch(console.error);
|
||||||
|
|||||||
108
src/scripts/test-nodes.ts
Normal file
108
src/scripts/test-nodes.ts
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
* Licensed under the Sustainable Use License v1.0
|
||||||
|
*/
|
||||||
|
import Database from 'better-sqlite3';
|
||||||
|
import { NodeRepository } from '../database/node-repository';
|
||||||
|
|
||||||
|
const TEST_CASES = [
|
||||||
|
{
|
||||||
|
nodeType: 'nodes-base.httpRequest',
|
||||||
|
checks: {
|
||||||
|
hasProperties: true,
|
||||||
|
minProperties: 5,
|
||||||
|
hasDocumentation: true,
|
||||||
|
isVersioned: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
nodeType: 'nodes-base.slack',
|
||||||
|
checks: {
|
||||||
|
hasOperations: true,
|
||||||
|
minOperations: 10,
|
||||||
|
style: 'declarative'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
nodeType: 'nodes-base.code',
|
||||||
|
checks: {
|
||||||
|
hasProperties: true,
|
||||||
|
properties: ['mode', 'language', 'jsCode']
|
||||||
|
}
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
async function runTests() {
|
||||||
|
const db = new Database('./data/nodes.db');
|
||||||
|
const repository = new NodeRepository(db);
|
||||||
|
|
||||||
|
console.log('🧪 Running node tests...\n');
|
||||||
|
|
||||||
|
let passed = 0;
|
||||||
|
let failed = 0;
|
||||||
|
|
||||||
|
for (const testCase of TEST_CASES) {
|
||||||
|
console.log(`Testing ${testCase.nodeType}...`);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const node = repository.getNode(testCase.nodeType);
|
||||||
|
|
||||||
|
if (!node) {
|
||||||
|
throw new Error('Node not found');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run checks
|
||||||
|
for (const [check, expected] of Object.entries(testCase.checks)) {
|
||||||
|
switch (check) {
|
||||||
|
case 'hasProperties':
|
||||||
|
if (expected && node.properties.length === 0) {
|
||||||
|
throw new Error('No properties found');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'minProperties':
|
||||||
|
if (node.properties.length < expected) {
|
||||||
|
throw new Error(`Expected at least ${expected} properties, got ${node.properties.length}`);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'hasOperations':
|
||||||
|
if (expected && node.operations.length === 0) {
|
||||||
|
throw new Error('No operations found');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'minOperations':
|
||||||
|
if (node.operations.length < expected) {
|
||||||
|
throw new Error(`Expected at least ${expected} operations, got ${node.operations.length}`);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'properties':
|
||||||
|
const propNames = node.properties.map((p: any) => p.name);
|
||||||
|
for (const prop of expected as string[]) {
|
||||||
|
if (!propNames.includes(prop)) {
|
||||||
|
throw new Error(`Missing property: ${prop}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`✅ ${testCase.nodeType} passed all checks\n`);
|
||||||
|
passed++;
|
||||||
|
} catch (error) {
|
||||||
|
console.error(`❌ ${testCase.nodeType} failed: ${(error as Error).message}\n`);
|
||||||
|
failed++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`\n📊 Test Results: ${passed} passed, ${failed} failed`);
|
||||||
|
|
||||||
|
db.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (require.main === module) {
|
||||||
|
runTests().catch(console.error);
|
||||||
|
}
|
||||||
@@ -1,4 +1,8 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Copyright (c) 2024 AiAdvisors Romuald Czlonkowski
|
||||||
|
* Licensed under the Sustainable Use License v1.0
|
||||||
|
*/
|
||||||
import Database from 'better-sqlite3';
|
import Database from 'better-sqlite3';
|
||||||
|
|
||||||
interface NodeRow {
|
interface NodeRow {
|
||||||
|
|||||||
Reference in New Issue
Block a user