星战科技xingzhan.cloud
返回市场
搜索API-MCP服务器

搜索API-MCP服务器

作者：mrgoonie11 星标更新：2025-10-28
安装使用来源：spider==github.com

项目介绍

SearchAPI.site - MCP Server

该项目提供了一个模型上下文协议（MCP）服务器，通过SearchAPI.site连接AI助手与外部数据源（如Google、Bing等）。

作者: Claude

<a href="https://glama.ai/mcp/servers/@mrgoonie/searchapi-mcp-server"> <img width="380" height="200" src="https://gips0.baidu.com/it/u=2328134860,1106581612&fm=3081&app=3081&f=PNG?w=760&h=400" alt="SearchAPI Server MCP server" /> </a>

支持的平台

  • Google - 网页搜索
  • Google - 图片搜索
  • Google - YouTube搜索
  • Google - 地图搜索
  • Bing - 网页搜索
  • Bing - 图片搜索
  • Reddit
  • X/Twitter
  • Facebook搜索
  • Facebook群组搜索
  • Instagram
  • TikTok

SearchAPI.site

支持的传输方式

  • ["stdio"]传输 - 默认用于CLI使用的传输方式
  • ["可流式HTTP"]传输 - 适用于基于Web的客户端
    • 实现认证（"Authorization"头部带有Bearer <token>）
  • "sse"传输 (已弃用)
  • 编写测试

如何使用

CLI

# 通过CLI进行Google搜索
npm run dev:cli -- search-google --query "你的搜索查询" --api-key "你的API密钥"

# 通过CLI进行Google图片搜索
npm run dev:cli -- search-google-images --query "你的搜索查询" --api-key "你的API密钥"

# 通过CLI进行YouTube搜索
npm run dev:cli -- search-youtube --query "你的搜索查询" --api-key "你的API密钥" --max-results 5

MCP设置

对于本地配置使用stdio传输：

{
  "mcpServers": {
    "searchapi": {
      "command": "node",
      "args": ["/path/to/searchapi-mcp-server/dist/index.js"],
      "transportType": "stdio"
    }
  }
}

对于远程HTTP配置：

{
  "mcpServers": {
    "searchapi": {
      "type": "http",
      "url": "http://mcp.searchapi.site/mcp"
    }
  }
}

HTTP传输环境变量：

你可以使用这些环境变量来配置HTTP服务器：

  • MCP_HTTP_HOST: 绑定的主机（默认：127.0.0.1）
  • MCP_HTTP_PORT: 监听的端口（默认：8080）
  • MCP_HTTP_PATH: 端点路径（默认：/mcp）

源码概述

什么是MCP？

模型上下文协议（MCP）是一个开放标准，允许AI系统安全且有上下文地连接到外部工具和数据源。

此样板实现了MCP规范，具有清晰分层的架构，可以扩展以构建任何API或数据源的自定义MCP服务器。

为什么使用这个样板？

  • 生产就绪架构：遵循已发布的MCP服务器模式，明确区分CLI、工具、控制器和服务。
  • 类型安全性：使用TypeScript构建，提高开发者体验、代码质量和可维护性。
  • 工作示例：包括一个完整的IP查找工具，展示了从CLI到API集成的完整模式。
  • 测试框架：包含单元测试和CLI集成测试的测试基础设施，包括覆盖率报告。
  • 开发工具：包括预配置的ESLint、Prettier、TypeScript和其他质量工具，用于MCP服务器开发。

快速开始

前提条件

  • Node.js (>=18.x): 下载
  • Git: 用于版本控制

第一步：克隆并安装

# 克隆仓库
git clone https://github.com/mrgoonie/searchapi-mcp-server.git
cd searchapi-mcp-server

# 安装依赖
npm install

第二步：运行开发服务器

在开发模式下启动服务器，默认使用stdio传输：

npm run dev:server

或者使用可流式HTTP传输：

npm run dev:server:http

这会启动带有热重载的MCP服务器，并在http://localhost:5173启用MCP Inspector。

⚙️ 代理服务器监听端口6277 🔍 MCP Inspector正在运行于http://127.0.0.1:6274

当使用HTTP传输时，默认情况下服务器将在http://127.0.0.1:8080/mcp可用。

第三步：测试示例工具

从CLI运行示例IP查找工具：

# 在开发模式下使用CLI
npm run dev:cli -- search-google --query "你的搜索查询" --api-key "你的API密钥"

# 或者指定特定IP
npm run dev:cli -- search-google --query "你的搜索查询" --api-key "你的API密钥" --limit 10 --offset 0 --sort "date:d" --from_date "2023-01-01" --to_date "2023-12-31"

架构

此样板遵循清晰分层的架构模式，分离关注点并促进可维护性。

项目结构

src/
├── cli/              # 命令行接口
├── controllers/      # 业务逻辑
├── resources/        # MCP资源：从你的服务器向LLMs暴露数据和内容
├── services/         # 外部API交互
├── tools/            # MCP工具定义
├── types/            # 类型定义
├── utils/            # 共享实用工具
└── index.ts          # 入口点

层级和职责

CLI层（src/cli/*.cli.ts）

  • 目的：定义命令行接口，解析参数并调用控制器
  • 命名：文件应命名为<特性>.cli.ts
  • 测试：CLI集成测试在<特性>.cli.test.ts

工具层（src/tools/*.tool.ts）

  • 目的：定义MCP工具，带有AI助手的模式和描述
  • 命名：文件应命名为<特性>.tool.ts，类型在<特性>.types.ts
  • 模式：每个工具应使用zod进行参数验证

控制器层（src/controllers/*.controller.ts）

  • 目的：实现业务逻辑，处理错误并格式化响应
  • 命名：文件应命名为<特性>.controller.ts
  • 模式：应返回标准化的ControllerResponse对象

服务层（src/services/*.service.ts）

  • 目的：与外部API或数据源交互
  • 命名：文件应命名为<特性>.service.ts
  • 模式：纯粹的API交互，逻辑最少

实用工具层（src/utils/*.util.ts）

  • 目的：在整个应用程序中提供共享功能
  • 关键实用工具：
    • logger.util.ts: 结构化日志记录
    • error.util.ts: 错误处理和标准化
    • formatter.util.ts: Markdown格式化助手

开发指南

开发脚本

# 在开发模式下启动服务器（热重载及检查器）
npm run dev:server

# 在开发模式下运行CLI
npm run dev:cli -- [命令] [参数]

# 构建项目
npm run build

# 在生产模式下启动服务器
npm run start:server

# 在生产模式下运行CLI
npm run start:cli -- [命令] [参数]

测试

# 运行所有测试
npm test

# 运行特定测试
npm test -- src/path/to/test.ts

# 生成测试覆盖率报告
npm run test:coverage

评估

Evals包加载一个mcp客户端，然后运行index.ts文件，因此在测试之间无需重新构建。可以通过在npx命令前添加环境变量来加载它们。完整文档可以在这里找到。

OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/tools/searchapi.tool.ts

代码质量

# 检查代码
npm run lint

# 使用Prettier格式化代码
npm run format

# 检查类型
npm run typecheck

构建自定义工具

按照以下步骤将你自己的工具添加到服务器：

1. 定义服务层

在src/services/创建一个新的服务以与你的外部API交互：

// src/services/example.service.ts
import { Logger } from '../utils/logger.util.js';

const logger = Logger.forContext('services/example.service.ts');

export async function getData(param: string): Promise<any> {
	logger.debug('获取数据', { param });
	// API交互代码在此处
	return { result: '示例数据' };
}

2. 创建控制器

在src/controllers/添加一个控制器以处理业务逻辑：

// src/controllers/example.controller.ts
import { Logger } from '../utils/logger.util.js';
import * as exampleService from '../services/example.service.js';
import { formatMarkdown } from '../utils/formatter.util.js';
import { handleControllerError } from '../utils/error-handler.util.js';
import { ControllerResponse } from '../types/common.types.js';

const logger = Logger.forContext('controllers/example.controller.ts');

export interface GetDataOptions {
	param?: string;
}

export async function getData(
	options: GetDataOptions = {},
): Promise<ControllerResponse> {
	try {
		logger.debug('使用选项获取数据', options);

		const data = await exampleService.getData(options.param || '默认值');

		const content = formatMarkdown(data);

		return { content };
	} catch (error) {
		throw handleControllerError(error, {
			entityType: 'ExampleData',
			operation: 'getData',
			source: 'controllers/example.controller.ts',
		});
	}
}

3. 实现MCP工具

在src/tools/创建一个工具定义：

// src/tools/example.tool.ts
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
import { z } from 'zod';
import { Logger } from '../utils/logger.util.js';
import { formatErrorForMcpTool } from '../utils/error.util.js';
import * as exampleController from '../controllers/example.controller.js';

const logger = Logger.forContext('tools/example.tool.ts');

const GetDataArgs = z.object({
	param: z.string().optional().describe('可选参数'),
});

type GetDataArgsType = z.infer<typeof GetDataArgs>;

async function handleGetData(args: GetDataArgsType) {
	try {
		logger.debug('工具get_data被调用', args);

		const result = await exampleController.getData({
			param: args.param,
		});

		return {
			content: [{ type: 'text' as const, text: result.content }],
		};
	} catch (error) {
		logger.error('工具get_data失败', error);
		return formatErrorForMcpTool(error);
	}
}

export function register(server: McpServer) {
	server.tool(
		'get_data',
		`从示例API获取数据，可选使用\`param\`。
使用此工具获取示例数据。返回格式化的Markdown数据。`,
		GetDataArgs.shape,
		handleGetData,
	);
}

4. 添加CLI支持

在src/cli/创建一个CLI命令：

// src/cli/example.cli.ts
import { program } from 'commander';
import { Logger } from '../utils/logger.util.js';
import * as exampleController from '../controllers/example.controller.js';
import { handleCliError } from '../utils/error-handler.util.js';

const logger = Logger.forContext('cli/example.cli.ts');

program
	.command('get-data')
	.description('获取示例数据')
	.option('--param <值>', '可选参数')
	.action(async (选项) => {
		try {
			logger.debug('CLI get-data被调用', 选项);

			const result = await exampleController.getData({
				param: 选项.param,
			});

			console.log(result.content);
		} catch (error) {
			handleCliError(error);
		}
	});

5. 注册组件

更新入口点以注册新的组件：

// 在src/cli/index.ts中
import '../cli/example.cli.js';

// 在src/index.ts（对于工具）
import exampleTool from './tools/example.tool.js';
// 然后在registerTools函数中：
exampleTool.register(server);

调试工具

MCP检查器

访问可视化的MCP检查器以测试你的工具并查看请求/响应详情：

  1. 运行npm run dev:server
  2. 在浏览器中打开http://localhost:5173
  3. 在UI中直接测试你的工具并查看日志

服务器日志

为开发启用调试日志：

# 设置环境变量
DEBUG=true npm run dev:server

# 或在~/.mcp/configs.json中配置

发布你的MCP服务器

当你准备好发布自定义MCP服务器时：

  1. 更新package.json中的详细信息
  2. 更新README.md中的工具文档
  3. 构建项目：npm run build
  4. 测试生产构建：npm run start:server
  5. 发布到npm：npm publish

许可证

ISC许可证

{
	"searchapi": {
		"environments": {
			"DEBUG": "true",
			"SEARCHAPI_API_KEY": "值"
		}
	}
}

注意：为了兼容性，如果未找到searchapi键，服务器还将识别完整包名（searchapi-mcp-server）或无作用域包名（searchapi-mcp-server）下的配置。然而，建议新配置使用短searchapi键。

合著者

  • Claude Code (Claude AI助手)
  • Goon