refactor: reorganize documentation and configuration files for improved clarity

2025-06-12 15:03:12 +02:00
parent 8bf670c31e
commit f831b02415
21 changed files with 1094 additions and 1841 deletions
--- a/README_CLAUDE_SETUP.md
+++ b/README_CLAUDE_SETUP.md
@@ -0,0 +1,101 @@
+# Claude Desktop Configuration for n8n-MCP
+
+## Setup Instructions
+
+1. **Build the project first:**
+   ```bash
+   cd /Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp
+   npm run build
+   npm run rebuild
+   ```
+
+2. **Locate your Claude Desktop config file:**
+   - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+   - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+   - Linux: `~/.config/Claude/claude_desktop_config.json`
+
+3. **Add the n8n-documentation server to your config:**
+   ```json
+   {
+     "mcpServers": {
+       "n8n-documentation": {
+         "command": "node",
+         "args": [
+           "/Users/romualdczlonkowski/Pliki/n8n-mcp/n8n-mcp/dist/mcp/index.js"
+         ],
+         "env": {
+           "NODE_ENV": "production"
+         }
+       }
+     }
+   }
+   ```
+
+   **Note**: Update the path in `args` to match your actual installation directory.
+
+4. **Restart Claude Desktop** to load the new configuration.
+
+## Available Tools
+
+Once configured, you'll have access to these tools in Claude:
+
+- **`list_nodes`** - List and filter n8n nodes
+  ```
+  list_nodes({ package: "n8n-nodes-base", limit: 10 })
+  ```
+
+- **`get_node_info`** - Get detailed information about a specific node
+  ```
+  get_node_info({ nodeType: "httpRequest" })
+  ```
+
+- **`search_nodes`** - Search across all node documentation
+  ```
+  search_nodes({ query: "webhook", limit: 20 })
+  ```
+
+- **`list_ai_tools`** - List nodes that can be used as AI Agent tools
+  ```
+  list_ai_tools({})
+  ```
+
+- **`get_node_documentation`** - Get full documentation for a node
+  ```
+  get_node_documentation({ nodeType: "slack" })
+  ```
+
+- **`get_database_statistics`** - Get statistics about the node database
+  ```
+  get_database_statistics({})
+  ```
+
+## Troubleshooting
+
+1. **If the server doesn't appear in Claude:**
+   - Check that the path in `args` is absolute and correct
+   - Ensure you've run `npm run build` and `npm run rebuild`
+   - Check `~/.n8n-mcp/logs/` for error logs
+
+2. **If tools return errors:**
+   - Ensure the database exists: `data/nodes.db`
+   - Run `npm run validate` to check the database
+   - Rebuild if necessary: `npm run rebuild`
+
+3. **For development/testing:**
+   You can also run with more verbose logging:
+   ```json
+   {
+     "mcpServers": {
+       "n8n-documentation": {
+         "command": "node",
+         "args": [
+           "/path/to/your/n8n-mcp/dist/mcp/index.js"
+         ],
+         "env": {
+           "NODE_ENV": "development",
+           "LOG_LEVEL": "debug"
+         }
+       }
+     }
+   }
+   ```