Stepfun Mcp

npm version npm downloads License: MIT GitHub stars

StepFun 搜索服务的 MCP (Model Context Protocol) 服务器，用于 Claude Code 的 TypeScript/Node.js 实现。

✨ 特性

• 🔍 通过 StepFun API 提供强大的网络搜索功能
• 🗂️ 支持场景化搜索分类（编程、学术、政务、商业）
• 📦 npm 全局安装：npm install -g stepfun-mcp
• 🔗 Claude Code 原生集成：通过 ~/.claude.json 配置一行 key 即可使用
• ⚡ 基于官方 @modelcontextprotocol/sdk 构建
• ✅ 完整的参数验证和错误处理
• 🌐 支持中英文搜索

📦 安装

方式一：npm 全局安装（推荐）

npm install -g stepfun-mcp

方式二：源码安装（开发）

git clone https://github.com/Daiyimo/Stepfun-mcp.git
cd Stepfun-mcp
npm install
npm run build
npm link

⚙️ 配置

只需配置 STEPFUN_API_KEY，服务即可运行（STEPFUN_API_HOST 默认为 https://api.stepfun.com，可不填）。MCP 服务器支持三种配置方式：

方式一：Claude Code ~/.claude.json（推荐）

编辑用户级配置文件 ~/.claude.json（Windows 下为 C:\Users\<用户名>\.claude.json）：

{
  "mcpServers": {
    "StepFun": {
      "command": "stepfun-mcp",
      "env": {
        "STEPFUN_API_KEY": "your_api_key_here"
      }
    }
  }
}

💡 提示：将 your_api_key_here 替换为你的真实 StepFun API Key。API Key 在 StepFun 开放平台 获取。

方式二：环境变量

Linux/macOS:

export STEPFUN_API_KEY="your_api_key"
export STEPFUN_API_HOST="https://api.stepfun.com"
stepfun-mcp

Windows (PowerShell):

$env:STEPFUN_API_KEY="your_api_key"
$env:STEPFUN_API_HOST="https://api.stepfun.com"
stepfun-mcp

方式三：.env 文件

在项目根目录创建 .env 文件：

# StepFun API 配置
STEPFUN_API_KEY=your_api_key_here
STEPFUN_API_HOST=https://api.stepfun.com

# 可选：日志级别（默认：WARNING）
# FASTMCP_LOG_LEVEL=INFO

🚀 使用方法

配置完成后，重启 Claude Code，即可在对话中使用 web_search 工具。

工具描述

Claude 会自动发现并使用以下工具：

You MUST use this tool whenever you need to search for real-time or external information on the web.

A web search API based on StepFun search engine. Supports scenario-specific optimization via the category parameter.

Args:

• query (string, required): The search query. Aim for 3-5 keywords for best results.
• n (integer, optional): Number of search results to return. Defaults to 10, max 20.
• category (string, optional): Search scenario: "programming", "research", "gov", or "business".

Returns:

{
    "query": "string",
    "n": "int",
    "results": [
        {
            "url": "string",
            "position": "int",
            "title": "string",
            "time": "string (ISO date)",
            "snippet": "string",
            "content": "string"
        }
    ]
}

使用示例

基础搜索：

用户: 搜索一下 TypeScript 5.5 的新特性
Claude: 自动调用 web_search({ query: "TypeScript 5.5 新特性", n: 5 })

场景化搜索（category 参数）：

用户: 帮我查一下 React hooks 的最佳实践
Claude: 自动调用 web_search({ query: "React hooks 最佳实践", category: "programming" })

返回结果示例：

{
  "query": "React hooks 最佳实践",
  "n": 10,
  "results": [
    {
      "url": "https://example.com/react-hooks",
      "position": 1,
      "title": "React Hooks 完整指南",
      "time": "2026-03-22T00:00:00Z",
      "snippet": "详细介绍 useState、useEffect 等常用 hooks 的最佳实践...",
      "content": "完整正文内容..."
    }
  ]
}

📖 API 文档

web_search

使用 StepFun 搜索引擎进行网络搜索，支持场景化优化。

参数

参数名	类型	必填	描述
query	string	✅	搜索查询，建议 3-5 个关键词。时效性话题建议附带日期
n	number	❌	返回结果数量（1-20，默认 10）
category	string	❌	搜索场景，见下表

category 取值

值	场景	适用场合
programming	代码编程	技术文档、代码问题、开发工具
research	学术研究	论文、学术资料、专业知识
gov	政务研究	政策法规、政府信息
business	商业财经	市场动态、财经数据、企业信息
(不填)	通用搜索	默认，适合一般性查询

返回结构

{
  "query": "搜索关键词",
  "n": 10,
  "results": [
    {
      "url": "https://example.com",
      "position": 1,
      "title": "结果标题",
      "time": "2026-03-22T00:00:00Z",
      "snippet": "摘要内容",
      "content": "完整正文"
    }
  ]
}

字段说明

• query: 原始搜索词
• n: 实际返回的结果数量
• results: 结果数组，按相关性排序
  • url: 文章来源链接
  • position: 排名位置（从 1 开始）
  • title: 文章标题
  • time: 网页索引时间（ISO 8601 格式）
  • snippet: 摘要/描述
  • content: 完整正文内容

🔧 开发

项目结构

stepfun-mcp/
├── src/
│   ├── index.ts          # CLI 入口
│   ├── server.ts         # MCP 服务器
│   ├── client.ts         # StepFun API 客户端
│   ├── tools.ts          # 工具实现
│   ├── types.ts          # 类型定义
│   └── errors.ts         # 异常类
├── dist/                 # 编译输出
├── .env.example          # 环境变量示例
├── package.json
├── tsconfig.json
└── README.md

常用命令

# 安装依赖
npm install

# 编译 TypeScript
npm run build

# 启动服务器（生产）
npm start

# 开发模式（使用 tsx）
npm run dev

❓ 常见问题

1. 安装后命令找不到？

确保 npm 全局 bin 目录在 PATH 中：

# 查看 npm 全局 bin 路径
npm bin -g
# 将该路径添加到系统 PATH

2. 如何获取 StepFun API Key？

访问 StepFun 开放平台 注册并创建应用。

3. 搜索结果为空？

检查：

• API Key 是否正确
• API Host 是否为 https://api.stepfun.com
• 网络连接是否正常

4. 如何调试？

查看日志输出（会输出到 stderr）：

export FASTMCP_LOG_LEVEL=DEBUG
stepfun-mcp

🐛 错误处理

错误类型	说明	处理方式
缺少 API Key/Host	服务器启动失败	检查环境变量配置
认证失败	HTTP 401	检查 API Key 是否正确
网络错误	连接失败	检查网络和 API Host
参数错误	参数验证失败	检查 query、n、category 的值
API 错误	StepFun 返回错误	查看具体错误信息

📝 更新日志

v1.1.0 (2026-03-26)

• ✨ 新增 category 参数，支持场景化搜索（编程/学术/政务/商业）
• 🔧 修正 n 参数（原 num_results），范围对齐官方 API（1-20）
• 📄 完善 README 文档和参数说明

v1.0.0 (2026-03-26)

• ✨ 首次发布
• ✅ 实现 web_search 工具
• ✅ 完整的 MCP 协议支持
• ✅ 参数验证和错误处理

🤝 贡献

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建特性分支 git checkout -b feature/AmazingFeature
3. 提交更改 git commit -m 'Add some AmazingFeature'
4. 推送到分支 git push origin feature/AmazingFeature
5. 开启 Pull Request

📄 License

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情

🔗 相关链接

• GitHub: https://github.com/Daiyimo/Stepfun-mcp
• npm: https://www.npmjs.com/package/stepfun-mcp
• StepFun 开放平台: https://platform.stepfun.com/
• StepFun API 文档: https://platform.stepfun.com/docs/zh/api-reference/Search/search

---

📈 Star History

Star History Chart

---

Made with ❤️ by Daiyimo