Allow the node to be used as a tool

Also improves the default description for the model to use

Author: dapeduu

README.md

@@ -1,51 +1,111 @@
 ![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
 
-# n8n-nodes-starter
+# n8n SearchAPI.io Node
 
-This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies.
+Search the web with [SearchAPI.io](https://www.searchapi.io/) directly from your n8n workflows. The node exposes the full power of the `/api/v1/search` endpoint and supports **all engines and query parameters** offered by the service.
 
-To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
+> **Why SearchAPI.io?**\
+> Real‑time SERP data from Google, Bing, DuckDuckGo, Yahoo, Yandex and more – no captchas, no proxies, one simple API.
 
-## Plan 
+---
 
-- Node type: Action
-- Style: Declarative
+## Installation
 
-## Prerequisites
+### Via the n8n UI (recommended)
 
-You need the following installed on your development machine:
+1. Open **Settings → Community Nodes** inside your self‑hosted n8n instance.
+2. Click **Install → Browse** and search for `n8n-nodes-searchapi`.
+3. Select the package, accept the risk prompt, and hit **Install**.
 
-* [git](https://git-scm.com/downloads)
-* Node.js and pnpm. Minimum version Node 18. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
-* Install n8n with:
+### Via the command line
+
+```bash
+# inside your n8n installation folder
+npm install n8n-nodes-searchapi
+# or with pnpm
+pnpm add n8n-nodes-searchapi
+```
+
+Restart n8n after the install finishes.
+
+> **Compatibility**
+>
+> - n8n ≥ 1.30.0
+> - Node.js ≥ 18
+
+---
+
+## Credentials
+
+1. Sign up at **[SearchAPI.io](https://www.searchapi.io/)** and copy your **API Key**.
+2. In n8n go to **Credentials → + New Credential → SearchAPI**.
+3. Paste the key and save.\
+   The new credential will now appear in the node’s **Credential** dropdown.
+
+---
+
+## Usage
+
+### 1. Drag‑and‑drop UI
+
+1. Add the **SearchAPI** node to your workflow.
+2. Choose your **Credential** and the **Engine**.
+3. Under **Parameters,** click **Add Parameter** for each query string field you need. To determine which fields to add, refer to the engine's documentation.
+   - **Name**: `q`
+   - **Value**: `weather new york`
+4. Execute the workflow to receive the response as JSON.
+
+### 2. Pass a parameters object (programmatic)
+
+You can also pass a parameters object directly to the node, instead of the UI:
+
+```json
+{
+  "parameters": {
+    "q": "n8n workflow automation",
+    "device": "mobile",
+    "location": "Berlin"
+  }
+}
+```
+
+- Feed the object through a **Set** node or any previous node.
   ```
-  pnpm install n8n -g
+  {{$json.parameters}}
   ```
-* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/).
+- The node will give preference to the parameters object.
+
+---
+
+## Example workflow
+
+The sample below searches Google for “n8n community nodes” and extracts the first organic result.
+
+
+
+You can import the full `.json` from `/examples/searchapi_google_basic.json` in this repo.
+
+---
+
+## Output
+
+The node returns the raw JSON received from SearchAPI.io. See the [official docs](https://www.searchapi.io/docs/google) for complete schemas.
 
-## Using this starter
+---
 
-These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/).
+## Troubleshooting
 
-1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository.
-2. Clone your new repo:
-   ```
-   git clone https://github.com/<your organization>/<your-repo-name>.git
-   ```
-3. Run `pnpm i` to install dependencies.
-4. Open the project in your editor.
-5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes.
-6. Update the `package.json` to match your details.
-7. Run `pnpm lint` to check for errors or `pnpm lintfix` to automatically fix errors when possible.
-8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
-9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
-10. Update the LICENSE file to use your details.
-11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
+| Error message                | Likely cause                 | Fix                                                                         |
+| ---------------------------- | ---------------------------- | --------------------------------------------------------------------------- |
+| **401 Unauthorized**         | Invalid or missing API key   | Double‑check the credentials.                                               |
+| **422 Unprocessable Entity** | Wrong parameter name / value | Verify against SearchAPI docs.                                              |
+| **429 Too Many Requests**    | Rate limit exceeded          | Slow down the workflow or [upgrade plan](https://www.searchapi.io/pricing). |
 
-## More information
+---
 
-Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes.
+## Resources
 
-## License
+- **SearchAPI.io documentation** – [https://www.searchapi.io/docs](https://www.searchapi.io/docs)
+- **n8n Community Forum** – [https://community.n8n.io](https://community.n8n.io)
+- **Community nodes installation** – [https://docs.n8n.io/integrations/community-nodes/installation/](https://docs.n8n.io/integrations/community-nodes/installation/)
 
-[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)

nodes/SearchApi/SearchApi.node.ts

@@ -7,14 +7,18 @@ export class SearchApi implements INodeType {
 		icon: 'file:searchApi.svg',
 		group: ['output'],
 		version: 1,
-		description: 'Search the web via SearchAPI.io (declarative)',
+		description: 'Call this tool whenever the answer might require fresh, niche, or externally-verifiable information. \
+Set the `engine` to the required backend (default: `google`). Always include `q` (the user’s query) and your \
+`api_key`; add optional parameters to localize, paginate, filter by date, or change device-type as needed. \
+Return the raw JSON response, then cite sources in the final reply. ',
 		subtitle: '={{ $parameter["engine"] }}',
 		defaults: { name: 'SearchAPI' },
+		// @ts-ignore
 		inputs: ['main'],
+		// @ts-ignore
 		outputs: ['main'],
-
 		credentials: [{ name: 'searchApi', required: true }],
-
+		usableAsTool: true,
 		requestDefaults: {
 			baseURL: 'https://www.searchapi.io/api/v1',
 			method: 'GET',
@@ -24,15 +28,24 @@ export class SearchApi implements INodeType {
 				api_key: '={{ $credentials.apiKey }}', // generic-auth pattern :contentReference[oaicite:3]{index=3}
 			},
 		},
-
+		hints: [
+			{
+			  message: "Hit SearchAPI's free 100-request quota? Check the Pricing page 📈'",
+			  type: 'info',
+			  whenToDisplay: 'beforeExecution',
+			  location: 'inputPane',
+			},
+		  ],
 		properties: [
 			{
 				displayName: 'Engine (Engine)',
 				name: 'engine',
 				type: 'string',
 				default: 'google',
 				required: true,
+				
 				description: 'Search engine to use for the query',
+				hint: 'Check https://www.searchapi.io/docs/google for the available engines',
 				routing: {
 					request: {
 						qs: {
@@ -47,8 +60,7 @@ export class SearchApi implements INodeType {
 				type: 'fixedCollection',
 				typeOptions: { multipleValues: true },
 				default: {},
-				hint: 'You can pass a paramters object to this node, to use the parameters in the search',
-				description: 'Add the parameters you want to use for the search, refer to the SearchAPI.io documentation for the available parameters',
+				description: 'Add the parameters you want to use for the search, refer to the SearchAPI.io documentation for the available parameters for the selected engine',
 				options: [
 					{
 						displayName: 'Parameter',
@@ -59,12 +71,14 @@ export class SearchApi implements INodeType {
 								name: 'name',
 								type: 'string',
 								default: '',
+								placeholder: 'q',
 							},
 							{
 								displayName: 'Value',
 								name: 'value',
 								type: 'string',
 								default: '',
+								placeholder: 'pizza near me',
 							},
 						],
 					},
@@ -78,7 +92,7 @@ export class SearchApi implements INodeType {
 						// We are doing this cast here because we need to
 						// build an object out of the collection entries
 						// and merge it into qs, but qs expects an object.
-						qs: '={{ Object.fromEntries(($value.parameter ?? $json.parameters ?? []).map(p => [p.name, p.value]))  }}' as unknown as IDataObject,
+						qs: '={{ Object.fromEntries(($value.parameter ?? []).map(p => [p.name, p.value])) }}' as unknown as IDataObject,
 					},
 				},
 			},

package.json

@@ -49,7 +49,8 @@
     "gulp": "^4.0.2",
     "prettier": "^3.3.2",
     "sqlite3": "^5.1.7",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "n8n-workflow": "^1.70.0"
   },
   "peerDependencies": {
     "n8n-workflow": "*"