MCP Server for SearXNG 项目启动与配置教程

MCP Server for SearXNG 项目启动与配置教程

mcp-searxng MCP Server for SearXNG 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-searxng

1. 项目目录结构及介绍

MCP Server for SearXNG 是一个开源项目，旨在实现一个集成了 SearXNG API 的 MCP 服务器，提供网页搜索功能。项目的目录结构如下：

• .github/: 存放 GitHub Actions 工作流文件。
• scripts/: 包含项目的一些脚本文件。
• .dockerignore: 定义了 Docker 构建时应当排除的文件和目录。
• .gitignore: 定义了 Git 忽略的文件和目录。
• Dockerfile: 用于构建 Docker 容器的文件。
• LICENSE: 项目使用的 MIT 许可证文件。
• README.md: 项目说明文件。
• index.ts: 项目的主要执行文件。
• package.json: 定义了项目的依赖、脚本和元数据。
• smithery.yaml: Smithery 配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.ts，它包含了主要的逻辑和功能实现。以下是启动文件的一些关键点：

• 引入必要的模块和依赖。
• 配置 SearXNG URL 和认证信息（如果需要的话）。
• 实现搜索功能，包括查询、分页、时间过滤、语言选择和安全搜索。
• 提供从 URL 读取内容并转换为 Markdown 格式的方法。

3. 项目的配置文件介绍

项目的配置主要通过环境变量进行，以下是一些主要的配置项：

• SEARXNG_URL: SearXNG 实例的 URL，默认值为 http://localhost:8080。
• AUTH_USERNAME: 如果使用密码保护的 SearXNG 实例，需要设置 HTTP Basic Auth 的用户名。
• AUTH_PASSWORD: 如果使用密码保护的 SearXNG 实例，需要设置 HTTP Basic Auth 的密码。

项目的配置可以在项目的环境变量设置中指定，或者在 package.json 中的 scripts 部分进行配置。

启动项目前，确保已经正确设置了环境变量，然后可以使用以下命令启动：

npm start

或者在 Docker 环境中，可以使用以下命令运行：

docker run -i --rm -e SEARXNG_URL=mcp-searxng:latest

确保将 YOUR_SEARXNG_INSTANCE_URL 替换为你的 SearXNG 实例 URL。

mcp-searxng MCP Server for SearXNG 项目地址: https://gitcode.com/gh_mirrors/mcp/mcp-searxng