用途
og-mcp 是一个 Model-Context-Protocol(MCP)服务器,将 OpenGraph.io(https://opengraph.io)的每一个 API 端点通过标准 MCP 接口提供给 AI 智能体使用,例如 Anthropic Claude、Cursor、LangGraph。如果你已经用 OpenGraph.io 展开链接、抓取 HTML、提取文章文本或截取网页截图,现在可以把相同能力交给自主智能体,同时不向智能体暴露原始 API 密钥。
主要能力
数据工具
- 所有抓取/元数据工具默认使用 v3 API,默认启用 auto_render、auto_proxy 和 retry,以提高复杂页面的成功率。
- query 和 extract 工具使用 v1.1。
- 所有工具默认发送 accept_lang: auto,镜像请求的 Accept-Language 头;可传入明确的 BCP 47 标签(如 en-US、fr)覆盖。
站点审计与链接预览工具
- 需要 OAuth 2.1 以及有效的 Site Audit 方案。
- 仅通过托管 HTTPS 传输提供,无法通过 x-app-id 头或 stdio/Claude Desktop 扩展使用,因为它们需要组织身份而非仅 API 密钥。
监控与历史工具
- 提供定期审计、趋势跟踪和变更报告;需要 OAuth。
- setMonitoringSchedule 还需要 Site Audit scheduling 授权。
- 可将审计转化为开发者可操作的工作;需要 OAuth。
图像生成工具
- 可从自然语言提示或图表代码创建图像。
- 支持图像类型(kind):illustration(通用 AI 生成图像)、diagram(来自 Mermaid、D2 或 Vega 语法的技术图表)、icon(应用图标和 logo)、social-card(针对社交分享优化的 OG 图像)、qr-code(带可选样式的 QR 码)。
- 预设宽高比:
- Social:og-image、twitter-card、twitter-post、linkedin-post、facebook-post、instagram-square、instagram-portrait、instagram-story、youtube-thumbnail
- Standard:wide、square、portrait
- Icons:icon-small、icon-medium、icon-large
- 样式预设:github-dark、github-light、notion、vercel、linear、stripe、neon-cyber、pastel、minimal-mono、corporate、startup、documentation、technical。
- 图表模板:auth-flow、oauth2-flow、crud-api、microservices、ci-cd、gitflow、database-schema、state-machine、user-journey、cloud-architecture、system-context。
- 可细化或修改已有的生成图像:修改特定部分(如“change the background to blue”)、应用样式更改(如“make it more minimalist”)、修复问题(如“remove the text”“make the icon larger”)、按指定坐标裁剪。
- 检查图像会话:查看会话详情并查找用于迭代的资源 ID,包括会话元数据(创建时间、名称、状态)、所有资源的提示/工具链/状态列表、显示迭代历史的父子关系。
- 导出图像资源:按会话和资源 ID 导出生成图像,内联返回 base64 图像及元数据(格式、尺寸、大小)。本地运行(stdio 传输)时可选择提供 destinationPath 保存到磁盘;托管/HTTP 传输时路径被忽略,仅内联返回图像。
引导工作流(提示)
除工具外,服务器还提供命名提示——预构建的多步骤工作流,MCP 客户端可直接呈现给用户(例如作为斜杠命令),或由智能体按名称调用,以获得比自由工具调用更可靠的结果。
工作机制
og-mcp 服务器充当 AI 客户端(如 Claude 或其他 LLM)与 OpenGraph.io API 之间的桥梁:AI 客户端对可用 MCP 函数发起工具调用;og-mcp 接收请求并格式化为 OpenGraph.io API 请求;OpenGraph.io 处理请求并返回数据;og-mcp 将响应转换为适合 AI 客户端的格式;AI 客户端接收结构化数据。这种抽象避免向 AI 直接暴露 API 密钥。
使用方式
全局安装
可通过 npm 全局安装。推荐使用 CLI 安装器为任何受支持客户端配置:支持 cursor、claude-desktop、windsurf、vscode、zed、jetbrains。 Claude Desktop 用户还可从 Releases 页面下载 .mcpb 扩展一键安装。
认证
托管 MCP 服务器支持两种认证方式:
- OAuth 2.1(推荐用于托管部署):通过 OpenGraph.io 仪表盘授权访问,无需将 API 密钥复制到配置文件;MCP 客户端自动处理整个浏览器登录流程。支持的客户端需实现 Authorization Code + PKCE 流程(Cursor、Claude Desktop 0.10+、带 MCP 扩展的 VS Code)。客户端无凭据连接时,服务器返回 401 及 WWW-Authenticate 头,客户端获取授权服务器元数据并启动 PKCE 流程,将浏览器重定向到 https://dashboard.opengraph.io/oauth/consent,登录并选择要授权的 API 密钥。无需客户端配置。
- x-app-id 头(传统/本地开发):将 App ID 作为 HTTP 头传递,适合本地开发、CI 或不支持 OAuth 的客户端。需将 YOUR_OPENGRAPH_APP_ID 替换为你的 OpenGraph.io App ID。
客户端配置
- Claude Desktop:配置文件位置 macOS 为 ~/Library/Application Support/Claude/claude_desktop_config.json,Windows 为 %APPDATA%\Claude\claude_desktop_config.json;也提供一键安装命令。
- Cursor:配置文件 ~/.cursor/mcp.json。
- VS Code:配置文件 .vscode/mcp.json(项目目录中);VS Code 支持输入提示以安全处理凭据。
- Windsurf:配置文件 ~/.codeium/windsurf/mcp_config.json。
- JetBrains AI Assistant:添加到 MCP 配置。
- Zed:配置文件 ~/.config/zed/settings.json;注意 Zed 使用 context_servers 而非 mcpServers。 所有配置使用托管 HTTPS 传输。OAuth 为共享/生产环境推荐,x-app-id 头配置作为回退。
本地运行
- 克隆仓库。
- 安装依赖:npm install。
- 构建 TypeScript 代码:npm run build。
- 启动服务器:npm start。 服务器默认运行在端口 3010(可通过 PORT 环境变量配置)。
传输选项
- Stdio 传输(推荐):用于命令行和 npm 全局安装,可通过命令行参数直接传递 OpenGraph API 密钥;该模式允许其他使用 MCP 的应用直接调用服务器。
- Streamable HTTP 传输:运行可通过 HTTP 访问的 Web 服务器。旧的 SSE 传输(/sse + /message)已移除,它没有认证且在所有客户端间共享单一连接。
OAuth 2.1 环境变量
运行 Streamable HTTP 服务器(npm start)时设置相关环境变量;未设置 OAUTH_JWKS_URL 时,bearer-token 验证被禁用,仅 x-app-id 回退生效。
x-app-id 回退/本地开发
省略 OAuth 环境变量,改用静态 App ID;这也可作为任何包含 x-app-id 头的 HTTP 请求的回退。
适用场景
- 需要让 AI 智能体自动展开链接、抓取网页、提取正文、截图。
- 需要为社交媒体生成 OG 卡片、技术图表、图标、二维码等图像。
- 需要在 Cursor、Claude Desktop、Windsurf、VS Code、Zed、JetBrains 等 MCP 客户端中集成 OpenGraph.io 能力。
- 需要对站点进行审计、监控和历史趋势跟踪(需 OAuth 和相应方案)。
限制
- 站点审计与链接预览工具需要 OAuth 2.1 和有效的 Site Audit 方案,仅通过托管 HTTPS 传输提供,无法通过 x-app-id 头或 stdio/Claude Desktop 扩展使用。
- 监控与历史工具需要 OAuth;setMonitoringSchedule 还需 Site Audit scheduling 授权。
- OAuth 需要客户端实现 Authorization Code + PKCE 流程。
- 未设置 OAUTH_JWKS_URL 时,bearer-token 验证被禁用,仅 x-app-id 回退生效。
- 图像导出时,托管/HTTP 传输忽略 destinationPath,仅内联返回。
- 项目命名空间及仓库为 securecoders/opengraph-io-mcp。
故障排除
- 如果工具未出现,检查服务器是否运行,以及 Cursor 中 URL 是否正确配置。
- 检查服务器日志中的连接或授权问题。
- 确认已指示 Claude 按名称使用特定工具。
以上内容均基于项目资料整理,未提供的信息(如具体收费、价格、平台覆盖范围等)暂未提供。