API 参考

API 参考

覆盖运行时、浏览器适配层、聊天组件与框架集成的公开接口。

@page-mcp/core

API	说明
`new EventBus({ timeout? })`	面向同页或共享上下文场景的内存 RPC 传输。
`new PageMcpHost({ name, version, strictProtocol?, bus?, transport?, skills? })`	在页面侧注册工具、资源、Prompt 与技能。
`host.registerTool()/unregisterTool()`	管理页面暴露的工具能力。
`host.registerResource()/unregisterResource()`	按 URI 管理可读页面资源。
`host.registerPrompt()/unregisterPrompt()`	管理可复用 Prompt 条目。
`host.registerSkill()/unregisterSkill()`	管理 Page MCP 扩展的多步骤技能。
`host.start()/destroy()`	启动或销毁 host 运行时。
`new PageMcpClient({ bus?, transport?, connectTimeout? })`	创建页面能力调用端。
`client.connect()/disconnect()`	建立或关闭 client 连接。
`client.listTools()/callTool()`	发现并调用工具。
`client.listResources()/readResource()`	列出并读取页面资源。
`client.listPrompts()/getPrompt()`	列出 Prompt 并解析 Prompt 内容。
`Extensions.createSkillsClient(client)`	创建用于 Page MCP skill 扩展的技能客户端。

@page-mcp/webmcp-adapter

API	说明
`installWebMcpPolyfill(host, opts?)`	为 PageMcpHost 暴露浏览器侧 modelContext polyfill。
`isWebMcpSupported()`	检测浏览器是否已提供原生 WebMCP 接口。
`toWebMcpTool()/fromWebMcpTool()`	在 WebMCP 风格工具对象与 Page MCP 定义之间转换。

@page-mcp/chat

API	说明
`init(config)`	挂载聊天组件并绑定到 Page MCP 运行时。
`getInstance()/destroy()`	读取或销毁当前单例 widget。
`config.openai`	直连 OpenAI 兼容接口时使用的 apiKey、model、baseURL 等配置。
`config.endpoint`	通过自有后端 endpoint 转发请求，替代浏览器直连模式。
`config.bus/defaultAttachedResources`	复用共享 bus，并为聊天组件预选资源。
`config.theme/position/expandMode`	配置外观与交互行为。
`widget.open()/close()/destroy()`	以编程方式控制组件生命周期。

适配层与集成

API	说明
`@page-mcp/react PageMcpProvider/usePageMcp*`	在 React 组件中提供并访问 host、client、bus。
`@page-mcp/react useRegisterTool/useRegisterResource/useRegisterPrompt/useRegisterSkill`	通过 React 生命周期声明式注册能力。
`@page-mcp/react usePageMcpSkills()`	在 React 中访问 Page MCP 的 skills 扩展客户端。
`@page-mcp/vue3 PageMcpPlugin/PageMcpProvider/composables`	把 Page MCP 集成到 Vue 3 应用中。
`@page-mcp/vue2 PageMcpPlugin/pageMcpMixin`	把 Page MCP 集成到 Vue 2 应用中。