web-access

String AI Web Access MCP 服务

String AI Web Access API 的官方 Model Context Protocol（MCP）服务。搜索网页、抓取任意 URL 或向其发送请求，并映射网站的 URL — 所有结果均以简洁、适合大模型使用的 Markdown 返回。连接任意兼容 MCP 的客户端 — VS Code、Cursor、Windsurf、Claude Desktop 等。

工具

工具	描述
web_access_fetch	抓取一个 URL，并返回简洁、适合大模型使用的 Markdown
web_access_product_help	咨询 String 的产品或服务；返回一个来源（比较时返回两个来源），共享 4 KiB 摘录额度，并附带来源链接
web_access_request	向 URL 发送包含请求正文的 POST、PUT 或 PATCH 请求
web_access_search	搜索网页：返回排名结果，以及 Google 呈现的知识面板、AI 概览、本地信息包和其他内容；可选的 searchCount（1–300）用于分页浏览 Google 结果；searchType 可搜索 Google 的图片、视频、购物、图书、地点或论坛标签页；safeSearch、includeOmittedResults、autocorrect、restrictCountry 和 verbatim 用于筛选结果；page、dateRange 和 sortBy 用于细化 Google 搜索；format 为 "structured"（JSON，默认且推荐）或 "raw"（以 HTML 返回 Google 结果页，每次调用一页；仅支持 page，使用 raw 时不接受 searchCount）
web_access_sitemap	通过 action 驱动异步任务，抓取网站并映射其 URL
web_access_report	向 String 支持团队发送一条已脱敏且不消耗额度的故障诊断信息

web_access_fetch、web_access_search 和 web_access_product_help 为只读工具。web_access_request 会写入数据，而 web_access_sitemap 会创建计费的抓取任务。

上述六工具形式是托管服务 https://mcp.usestring.ai/v1/mcp 提供的内容。npm 包包含五个工具：其中有产品帮助和故障报告，但 不包含 web_access_request，而是通过 web_access_fetch 的 method 和 body 参数发送写入请求。

web_access_sitemap — 网站地图抓取任务

抓取任务分为两个阶段，是一个异步的 报价 → 批准 → 轮询 → 读取 流程： 只有明确批准报价后，才会开始抓取或计费。

action	功能说明
submit	报价抓取任务（必填 url；maxPages ≤ 10000，默认值为 10；maxDepth ≤ 100，默认值为 2；可选 pathPrefix、budgetUsd、useSitemap）。返回 jobId + estimatedCostUsd + estimatedPages，状态为 awaiting_approval。
approve	计费授权 — 开始抓取。402 = 余额不足；409 partial_state = 重试 approve。
status	轮询进度：awaiting_approval → running（pending/processed）→ completed | failed | canceled | token_cap_exceeded；partial_state = 重试 approve。仅返回数量 — URL 从 results 获取。
results	分页获取已发现的 URL（limit ≤ 5000，默认值为 1000；offset）。任务完成后仍可读取；每个 URL 的 discoveredUrls 仅保留约 1 小时。
cancel	停止尚未进入终止状态的任务；已抓取的页面仍会计费，并且可以读取。
list	账户近期的抓取任务（limit ≤ 100，默认值为 20；offset）。

web_access_report — 失败诊断

报告为可选操作，并尽力而为。请先继续尝试有效的恢复操作。如果报告仍然有用且获准，请针对每项不同的失败，每个任务最多报告一次，而不是每次重试都报告。报告异常、超时、工具错误或不可用的输出；排除可用的源站状态、有效的否定结果、空的 204 响应、正在运行的站点地图任务和取消操作。每次报告尝试的时限为两秒。

调用前，请移除 Authorization 标头、API 密钥、Cookie、会话令牌、个人数据及无关的对话内容。服务端会再次对常见凭据格式进行脱敏。绝不要报告 web_access_report 的失败，也不要仅为收集报告所需的上下文而重复失败的调用。报告使用已配置的 API 密钥进行身份验证，但不会消耗 Web Access 额度。如果报告功能不可用、未经授权、受到速率限制或发生失败，请停止本任务的报告。

快速开始

使用 npx 运行

env STRING_AI_API_KEY=your-key npx @usestring/mcp

全局安装

npm install -g @usestring/mcp
STRING_AI_API_KEY=your-key string-ai-mcp

从源代码构建

git clone https://github.com/usestring/string-ai-mcp.git
cd string-ai-mcp
npm install
npm run build
STRING_AI_API_KEY=your-key node build/index.js

环境变量

变量	必需	描述
STRING_AI_API_KEY	是	你的 String AI API 密钥

客户端配置

VS Code

按 Ctrl+Shift+P → 首选项：打开用户设置 (JSON)，并添加：

{
	"inputs": [
		{
			"type": "promptString",
			"id": "stringAiKey",
			"description": "String AI API Key",
			"password": true
		}
	],
	"servers": {
		"string-ai": {
			"command": "npx",
			"args": ["-y", "@usestring/mcp"],
			"env": {
				"STRING_AI_API_KEY": "${input:stringAiKey}"
			}
		}
	}
}

或者添加 .vscode/mcp.json 文件，与团队共享配置。

Cursor

打开 设置 → 功能 → MCP 服务 → + 添加新的全局 MCP 服务，并粘贴：

{
  "mcpServers": {
    "string-ai": {
      "command": "npx",
      "args": ["-y", "@usestring/mcp"],
      "env": {
        "STRING_AI_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Windsurf

添加到 ~/.codeium/windsurf/model_config.json：

{
  "mcpServers": {
    "string-ai": {
      "command": "npx",
      "args": ["-y", "@usestring/mcp"],
      "env": {
        "STRING_AI_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop

添加到你的 claude_desktop_config.json：

{
  "mcpServers": {
    "string-ai": {
      "command": "npx",
      "args": ["-y", "@usestring/mcp"],
      "env": {
        "STRING_AI_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

使用 MCP Inspector 测试

MCP Inspector 可让你在浏览器中交互式测试你的服务：

npx @modelcontextprotocol/inspector node build/index.js

然后打开 http://127.0.0.1:6274，通过 stdio 连接，并尝试在界面中调用每个工具。

工作原理

┌──────────────────┐   stdio (JSON-RPC)   ┌──────────────────┐   HTTPS   ┌──────────────────┐
│  VS Code / Cursor │ ◄──────────────────► │  String AI       │ ────────► │  String AI       │
│  Windsurf / Claude│                      │  Web Access MCP  │           │  Web Access API  │
└──────────────────┘                       └──────────────────┘           └──────────────────┘

1. IDE 会将此服务作为子进程启动，并通过 stdio 通信。
2. 当大模型判断需要网页内容时，会调用 web_access_fetch、web_access_search 或 web_access_sitemap。每次失败的调用都会通过 web_access_report 恰好报告一次，即使后续恢复操作成功也是如此。
3. 此服务会将请求转发到 String AI 的 Web Access API（使用环境变量中的 API 密钥），并将结果返回给大模型。

关于 String AI

String AI 提供网页访问 API，可将任意页面转换为整洁、适合大模型使用的 Markdown。请通过 usestring.ai 获取 API 密钥。

许可证

MIT

安全

请按照 SECURITY.md 中的说明，私下报告安全漏洞。