From c5ed533752aacc17484f498c94a4bf8d97d72160 Mon Sep 17 00:00:00 2001 From: Parallel Date: Sun, 11 Oct 2026 04:09:27 +0000 Subject: [PATCH] feat(mcp): add Parallel Search example --- docs/features/user-plugins/authoring.md | 5 + .../parallel-search/.codex-plugin/plugin.json | 10 + .../user-plugins/parallel-search/.mcp.json | 9 + examples/user-plugins/parallel-search/LICENSE | 202 ++++++++++++++++++ .../user-plugins/parallel-search/README.md | 73 +++++++ test/main/plugin/userPluginLifecycle.test.ts | 64 ++++++ 6 files changed, 363 insertions(+) create mode 100644 examples/user-plugins/parallel-search/.codex-plugin/plugin.json create mode 100644 examples/user-plugins/parallel-search/.mcp.json create mode 100644 examples/user-plugins/parallel-search/LICENSE create mode 100644 examples/user-plugins/parallel-search/README.md diff --git a/docs/features/user-plugins/authoring.md b/docs/features/user-plugins/authoring.md index d2a35a960d..1c928d3088 100644 --- a/docs/features/user-plugins/authoring.md +++ b/docs/features/user-plugins/authoring.md @@ -17,6 +17,11 @@ password field for a user-supplied Bearer key and includes ZIP packaging instruc rotation and removal guidance. The hosted service requires a separate account and may charge for usage; the example is optional and is not bundled or auto-enabled. +For anonymous web search and page fetching, see +[Parallel Search](../../../examples/user-plugins/parallel-search/README.md). This MCP-only example +uses Streamable HTTP with no account or API key required. Package it as a small ZIP and explicitly +enable it after installation; anonymous service rate limits apply. + ## A complete skills-and-hooks package ```text diff --git a/examples/user-plugins/parallel-search/.codex-plugin/plugin.json b/examples/user-plugins/parallel-search/.codex-plugin/plugin.json new file mode 100644 index 0000000000..daf322771a --- /dev/null +++ b/examples/user-plugins/parallel-search/.codex-plugin/plugin.json @@ -0,0 +1,10 @@ +{ + "name": "parallel-search", + "version": "0.1.0", + "description": "Free web search and page fetching through Parallel Search MCP. No account or API key required.", + "author": { + "name": "Parallel" + }, + "license": "Apache-2.0", + "mcpServers": "./.mcp.json" +} diff --git a/examples/user-plugins/parallel-search/.mcp.json b/examples/user-plugins/parallel-search/.mcp.json new file mode 100644 index 0000000000..67b98ed0b8 --- /dev/null +++ b/examples/user-plugins/parallel-search/.mcp.json @@ -0,0 +1,9 @@ +{ + "parallel-search": { + "type": "http", + "url": "https://search.parallel.ai/mcp", + "headers": { + "User-Agent": "DeepChat-Parallel-Search/0.1.0 (https://github.com/ThinkInAIXYZ/deepchat)" + } + } +} diff --git a/examples/user-plugins/parallel-search/LICENSE b/examples/user-plugins/parallel-search/LICENSE new file mode 100644 index 0000000000..4d226b6b61 --- /dev/null +++ b/examples/user-plugins/parallel-search/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2025] [ThinkInAIXYZ] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/examples/user-plugins/parallel-search/README.md b/examples/user-plugins/parallel-search/README.md new file mode 100644 index 0000000000..bac0778669 --- /dev/null +++ b/examples/user-plugins/parallel-search/README.md @@ -0,0 +1,73 @@ +# Parallel Search for DeepChat + +An optional MCP-only user plugin for free web search and page fetching with +[Parallel Search MCP](https://docs.parallel.ai/integrations/mcp/search-mcp). +No account or API key is required. Anonymous searches use Fast mode; the free endpoint has +rate limits and is intended for exploration and light use. + +The package contains a manifest and remote MCP configuration, with no local commands, hooks, +Skills or dependencies to install. Installation leaves the plugin disabled and preserves your +existing model and MCP settings. It connects directly to `https://search.parallel.ai/mcp` using +Streamable HTTP. Search queries and requested URLs are sent to Parallel when tools are called. + +## Install + +Use a DeepChat version with **Plugins → Install from ZIP**. The user-plugin installation flow +is available in `v1.1.2-beta.5` and later; `v1.1.1` does not include it. + +1. Obtain a source checkout containing this example. For a pending PR, use its exact commit; + the example will only be available in upstream `dev` after merge. +2. Package only this directory, including its hidden files. With Python 3, run from the + repository root: + + ```sh + cd examples/user-plugins/parallel-search + python3 -m zipfile -c /tmp/parallel-search.zip .codex-plugin .mcp.json README.md LICENSE + ``` + + Choose another output path on Windows. Do not include the entire repository, `.git`, + credentials or `node_modules`. **Install from Git** on the whole DeepChat repository exceeds + the current plugin file-count limit; use the small ZIP instead. +3. Open **Plugins → Install from ZIP**, select the archive and review the package. It should + contain only the `parallel-search` HTTP MCP server at the endpoint above, with no credential + variables, Skills or hooks. Select **MCP** and confirm installation. +4. Explicitly enable the installed **parallel-search** plugin. No password or OAuth sign-in is + needed. Check its MCP status card for a running connection and discovered tools. Plugin-owned + servers do not appear in the ordinary MCP settings list. + +## Tools and controls + +The endpoint exposes `web_search` for finding pages and `web_fetch` for reading URLs. Under the +discovered tool schemas, `web_search` accepts arguments such as: + +```json +{ + "objective": "Find the Python documentation for virtual environments", + "search_queries": ["Python virtual environment documentation"] +} +``` + +Then call `web_fetch` with a URL from the result: + +```json +{ + "urls": ["https://docs.python.org/3/library/venv.html"], + "objective": "Explain how to create a virtual environment" +} +``` + +Inspect the returned content. Discovery alone does not prove a tool call succeeded. This package +uses DeepChat's existing tool and permission controls and does not configure external ACP agents. + +Disable the plugin to stop its integration, or uninstall it to remove its local configuration. +Use **Review update** to import changes; editing your source checkout does not update an installed +snapshot. Uninstalling does not remove previous conversation records. + +If a call is rate limited, wait for the service's retry time before trying again. For connection +errors, check access to the endpoint and the plugin's diagnostic. Do not add an Authorization +header to this anonymous example. For service limits and support, see the +[Parallel Search MCP guide](https://docs.parallel.ai/integrations/mcp/search-mcp); for installation +behavior, see DeepChat's [user-plugin guide](../../../docs/features/user-plugins/authoring.md). + +These example files use DeepChat's [Apache-2.0 license](./LICENSE). Parallel operates the hosted +service separately. I work at Parallel. diff --git a/test/main/plugin/userPluginLifecycle.test.ts b/test/main/plugin/userPluginLifecycle.test.ts index 8b7c65c518..259366f928 100644 --- a/test/main/plugin/userPluginLifecycle.test.ts +++ b/test/main/plugin/userPluginLifecycle.test.ts @@ -506,3 +506,67 @@ it('clears interrupted-update state even when restoring MCP settings fails', asy await new UserPlugins(f.deps).initialize() expect(f.store.pending()).toBeNull() }) + +it('installs the anonymous Parallel ZIP without changing existing MCP settings', async () => { + const f = fixture() + const source = path.resolve('examples/user-plugins/parallel-search') + const archive = path.join(f.root, 'parallel-search.zip') + fs.writeFileSync( + archive, + zipSync( + Object.fromEntries( + fs + .readdirSync(source, { recursive: true, encoding: 'utf8' }) + .filter((relative) => fs.statSync(path.join(source, relative)).isFile()) + .map((relative) => [ + relative.split(path.sep).join('/'), + fs.readFileSync(path.join(source, relative)) + ]) + ) + ) + ) + const existing = await f.mcpSettings.getMcpServers() + const inspected = await f.service.inspect({ kind: 'zip', path: archive }, randomUUID()) + expect(inspected.package).toMatchObject({ + name: 'parallel-search', + skills: [], + hooks: [], + findings: [], + mcpServers: [ + { + name: 'parallel-search', + type: 'http', + url: 'https://search.parallel.ai/mcp', + headers: { + 'User-Agent': 'DeepChat-Parallel-Search/0.1.0 (https://github.com/ThinkInAIXYZ/deepchat)' + }, + requiredVariables: [] + } + ] + }) + const installed = await f.service.install({ + operationId: inspected.operationId, + selection: { skills: false, hooks: false, mcp: true } + }) + expect(installed.ok).toBe(true) + expect(installed.status).toMatchObject({ enabled: false }) + expect(await f.mcpSettings.getMcpServers()).toEqual(existing) + const id = installed.status!.id + expect((await f.service.enable(id)).ok).toBe(true) + const key = `${id}.parallel-search` + const enabled = await f.mcpSettings.getMcpServers() + expect(enabled[key]).toMatchObject({ + type: 'http', + baseUrl: 'https://search.parallel.ai/mcp', + customHeaders: { + 'User-Agent': 'DeepChat-Parallel-Search/0.1.0 (https://github.com/ThinkInAIXYZ/deepchat)' + }, + environmentVariables: [] + }) + expect(f.mcpSettings.getMcpVariableBindings(enabled[key])).toEqual({}) + for (const [name, config] of Object.entries(existing)) expect(enabled[name]).toEqual(config) + expect((await f.service.disable(id)).ok).toBe(true) + expect((await f.mcpSettings.getMcpServers())[key].enabled).toBe(false) + expect((await f.service.uninstall(id)).ok).toBe(true) + expect(await f.mcpSettings.getMcpServers()).toEqual(existing) +})