diff --git a/COPYRIGHT b/COPYRIGHT deleted file mode 100644 index 7885aa2..0000000 --- a/COPYRIGHT +++ /dev/null @@ -1,6 +0,0 @@ -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. \ No newline at end of file diff --git a/LICENSE_FAQ.md b/LICENSE_FAQ.md deleted file mode 100644 index 5d9c7c0..0000000 --- a/LICENSE_FAQ.md +++ /dev/null @@ -1,51 +0,0 @@ -# License FAQ - -## What is the Sustainable Use License? - -The Sustainable Use License is a "fair-code" license that allows free use of the software for internal business purposes and non-commercial use, while restricting commercial redistribution or hosting as a service. - -## What can I do with this software? - -✅ **You CAN:** -- Use it for your own internal business purposes -- Use it for personal, non-commercial projects -- Modify it for your own use -- Share it with others for free (non-commercial) -- Use it to learn and experiment -- Use it in development and testing environments - -❌ **You CANNOT:** -- Host it as a service for others -- Sell it or include it in commercial products -- White-label it for commercial purposes -- Remove licensing notices -- Use it in violation of the license terms - -## Is this "open source"? - -No, this is "fair-code" or "source-available" software. While you can view and modify the source code, there are restrictions on commercial use that make it incompatible with the Open Source Definition. - -## Why use this license? - -This license helps ensure the project remains sustainable while still providing value to the community. It prevents large cloud providers from offering the software as a service without contributing back, while allowing individuals and businesses to use it freely for their own purposes. - -## Can I use this in my company? - -Yes! You can use this software for your company's internal business purposes. You just can't resell it or offer it as a service to others. - -## What about enterprise features? - -Currently, all features are available under the same license. In the future, some enterprise features may be added under a different license model (similar to n8n's .ee. system), but for now everything is included. - -## How is this enforced? - -The license is primarily enforced through legal means rather than technical restrictions. Using the software in violation of the license terms means you don't have a valid license and could face legal consequences. - -## Can I contribute to the project? - -Yes! Contributions are welcome. By contributing, you agree that your contributions will be licensed under the same terms. - -## What if I need different terms? - -For commercial licensing or custom terms, please contact the maintainers through the GitHub repository. - diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md deleted file mode 100644 index d9abcf1..0000000 --- a/TESTING_GUIDE.md +++ /dev/null @@ -1,132 +0,0 @@ -# Testing n8n-mcp with Claude Desktop - -## Setup Complete! 🎉 - -The n8n-mcp server is already configured in your Claude Desktop. The new essentials tools are ready to test. - -## How to Test - -### 1. Restart Claude Desktop -Close and reopen Claude Desktop to ensure it loads the updated MCP server with the new tools. - -### 2. Available Tools to Test - -#### New Tools (Test These!) -- **get_node_essentials** - Returns only essential properties (95% smaller) -- **search_node_properties** - Search for specific properties within nodes - -#### Existing Tools -- **list_nodes** - List all available nodes -- **get_node_info** - Get full node information (original tool) -- **search_nodes** - Search for nodes by name -- **get_node_documentation** - Get markdown documentation -- **get_database_statistics** - Get database stats -- **list_ai_tools** - List AI-capable nodes - -### 3. Test Commands to Try - -In a new Claude Desktop conversation, try these: - -``` -1. "Show me the essential properties for the HTTP Request node" - - This should use get_node_essentials - - You'll see only 6 properties instead of 200+ - -2. "Find authentication properties in the HTTP Request node" - - This should use search_node_properties - - You'll see the 3 auth-related properties - -3. "How do I make a POST request with JSON data in n8n?" - - This should use get_node_essentials and show examples - -4. "List all available n8n nodes" - - This uses list_nodes - -5. "Show me database statistics" - - This uses get_database_statistics -``` - -### 4. What to Look For - -✅ **Success Indicators:** -- Responses are much shorter and focused -- Examples are included -- Only essential properties shown -- Search returns specific properties - -❌ **If Something Goes Wrong:** -- Check if Claude Desktop was restarted -- Look for any error messages -- The server logs are suppressed in production mode - -### 5. Comparing Old vs New - -Try these to see the difference: - -**Old way** (using get_node_info): -``` -"Show me ALL properties for the HTTP Request node" -``` -- Returns 100KB+ of data with 200+ properties - -**New way** (using get_node_essentials): -``` -"Show me the essential properties for the HTTP Request node" -``` -- Returns <5KB with only 6 essential properties - -### 6. Example Workflow Test - -Ask Claude to: -``` -"Help me create an n8n workflow that: -1. Receives a webhook -2. Makes an HTTP POST request with JSON data -3. Sends the result to Slack" -``` - -With the new tools, Claude should: -- Use get_node_essentials for each node -- Provide focused configuration -- Include working examples -- Complete the task much faster - -## Current Status - -✅ **What's Working:** -- n8n-mcp is configured in Claude Desktop -- New essentials tools are implemented -- 82.5% average size reduction achieved -- Examples included for all nodes -- Property search functioning - -📊 **Performance Improvements:** -- HTTP Request: 20.5KB → 2.6KB (87% reduction) -- Slack: 62.3KB → 4.0KB (94% reduction) -- Postgres: 38.3KB → 2.3KB (94% reduction) -- Average response time: <50ms - -## Troubleshooting - -If the tools aren't working: - -1. **Restart Claude Desktop** (most common fix) -2. **Check the build**: - ```bash - cd /Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp - npm run build - ``` -3. **Test manually**: - ```bash - npm start < test-command.txt - ``` - -## Next Steps - -After testing, consider: -1. Monitoring which properties users ask for most -2. Refining the essential property lists -3. Adding more task-based examples -4. Expanding to more nodes - -Good luck with testing! The new tools should make n8n workflow building much more efficient. 🚀 \ No newline at end of file diff --git a/claude_desktop_config.example.json b/claude_desktop_config.example.json deleted file mode 100644 index 35b46cc..0000000 --- a/claude_desktop_config.example.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "mcpServers": { - "n8n-documentation": { - "command": "/Users/johndoe/projects/n8n-mcp/mcp-server-v20.sh", - "args": [] - } - } -} \ No newline at end of file diff --git a/mcp-server-v20.example.sh b/mcp-server-v20.example.sh deleted file mode 100644 index d67e8da..0000000 --- a/mcp-server-v20.example.sh +++ /dev/null @@ -1,43 +0,0 @@ -#!/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" \ No newline at end of file diff --git a/mcp-server.sh b/mcp-server.sh deleted file mode 100755 index 12c7f7a..0000000 --- a/mcp-server.sh +++ /dev/null @@ -1,31 +0,0 @@ -#!/bin/bash - -# n8n-MCP Server Wrapper Script -# This ensures the server runs with the correct environment - -# Get the directory where this script is located -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" - -# Change to the script directory -cd "$SCRIPT_DIR" - -# 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" \ No newline at end of file