smartsearch

Basic Information

• Author: cloudsway
• Version: 0.1.2
• Type: tool (Dify plugin)

Description

smartsearch is an intelligent search tool for the Dify ecosystem, integrating the Cloudsway Search API to provide efficient and controllable web search capabilities for large model applications. It supports freshness filtering, full-text content extraction, and structured result output — suitable for deep content analysis, fact-checking, and multi-source information aggregation scenarios.

Note: This README describes the Dify plugin. This is NOT an MCP server and contains no MCP deployment instructions.

Key Features

• Precise Web Search: Supports keyword search with configurable result count and pagination offset.
• Freshness Filtering: Allows filtering search results by Day, Week, or Month to get the most relevant and timely information.
• Full-Text Content Extraction: Can return the core content of web pages (in HTML, MARKDOWN, or TEXT format) and key text snippets to meet deep analysis needs.
• Structured Output: Results are returned in JSON format, including title, URL, publication date, summary, and full content for easy parsing and downstream processing.
• Seamless Dify Integration: Complies with Dify plugin specifications and can be called directly in Dify applications and workflows.

Usage Guide

1. Prerequisites

• Obtain your Cloudsway Search API key (SERVER_KEY).
• How to get it: Log in to the Cloudsway Console or contact info@cloudsway.ai to apply.

2. Configuration Steps

After installing the plugin in Dify, configure the environment variable in "Plugin Settings":

SERVER_KEY=your_api_key

3. Tool Parameters

Parameter	Type	Required	Default	Description
q	string	Yes	-	Search keyword or question (e.g., "Latest advances in machine learning 2024").
count	number	No	10	Number of results. Accepted values: 10, 20, 30, 40, 50. Recommended: 3-10.
offset	number	No	0	Zero-based pagination offset (e.g., offset=10 starts from result #11).
freshness	string	No	(none)	Time filter for results. Accepted values: Day, Week, Month.
enableContent	boolean	No	false	Set to true to return a long summary (full-text content).
contentType	string	No	TEXT	Format for the long summary: HTML, MARKDOWN, or TEXT. Requires enableContent=true.
contentTimeout	number	No	3	Timeout in seconds for fetching the long summary. Requires enableContent=true.
mainText	boolean	No	false	Set to true to return key text snippets. Requires enableContent=true.

Notes:

• q is required and cannot be empty.
• If count is omitted, the plugin returns 10 results by default.

4. Example Parameters (Dify UI)

• Query string: What is Cloudsway
• Result count: 3
• Freshness: Month
• Enable Content: true

Sample Output (simplified):

{
    "webPages": {
        "value": [
            {
                "name": "Cloudsway - Intelligent Search API",
                "url": "https://www.cloudsway.ai/product/search",
                "isFamilyFriendly": true,
                "displayUrl": "https://www.cloudsway.ai/product/search",
                "snippet": "Cloudsway provides a powerful intelligent search API designed for AI applications, offering stable, reliable, and secure search services.",
                "datePublished": "2024-05-10T14:30:00.0000000",
                "content": "Full extracted text content of the page goes here...",
                "mainText": "Key snippets and main text from the page content go here..."
            }
            // ... more results
        ]
    }
}

Response Structure

Successful response (JSON) includes these key fields:

• webPages.value[]: A list of result items. Each item may include:
  • name: Page title.
  • url: Full page URL.
  • displayUrl: Display-friendly URL.
  • snippet: Short description or excerpt from the page.
  • datePublished: Publication date, if available.
  • content: The full-text content of the page (if enableContent is true).
  • mainText: Key text snippets from the page (if enableContent and mainText are true).

Error Handling

Common HTTP status codes returned by the Cloudsway API:

• 200 — Success.
• 429 — Rate limit exceeded (QPS limit reached). If you need a higher QPS, contact Cloudsway support.
• 4xx / 5xx — Other client/server errors. Check your request parameters and ensure your SERVER_KEY is valid.

Privacy Policy

• Data Collected: This plugin only collects the search keyword (q) and other search parameters entered by the user for real-time calls to the Cloudsway Search API. The plugin does not collect any personally identifiable information.
• Data Usage: All input is used solely for instant search requests and is not stored, analyzed, or used for any other purpose.
• Third-Party Processing: Search requests are processed in real-time by the Cloudsway API. Data is only transmitted to Cloudsway during the request and is not shared with other third parties.
• Security Measures: The API key is used only for authentication. All data transmission is encrypted via HTTPS.
• User Rights: Users can delete or replace their API key at any time. The plugin does not save any historical data.
• Support & Feedback: For privacy-related questions, please contact us at support@cloudsway.ai.

License

This project is open-sourced under the MIT License. See LICENSE for details.

FAQ

Q: Call failed? A: Check if the SERVER_KEY is correctly configured and valid in the Cloudsway Console. Ensure required parameters (like q) are provided and not empty.

Q: Empty results? A: Try using broader keywords for your q, or relax the freshness filter (e.g., change from Day to Month or remove it entirely).

For more support, you can submit an Issue to the GitHub repository or contact support@cloudsway.ai.