API REFERENCE
API 参考
来自 @page-mcp/core、@page-mcp/chat、@page-mcp/react 的公开接口。
@page-mcp/core
| API | Description |
|---|
new EventBus({ timeout? }) | Host 与 Client 之间的 RPC 通道。 |
new PageMcpHost({ name, version, bus? }) | 页面侧能力注册中心。 |
host.registerTool(def) | 注册 MCP 对齐的工具动作。 |
host.registerResource(def) | 按 URI 注册可读取资源。 |
host.registerSkill(def) | 注册多步骤技能流程。 |
host.registerPrompt(def) | 注册聊天组件可用的提示卡片。 |
host.start() | 启动 RPC 监听并广播就绪状态。 |
new PageMcpClient({ bus?, connectTimeout? }) | AI 侧调用客户端。 |
client.connect() | 连接并获取 HostInfo。 |
client.listTools()/callTool() | 发现并调用工具。 |
client.listResources()/readResource() | 读取页面资源。 |
client.listSkills()/executeSkill() | 执行技能并返回 SkillResult。 |
installWebMcpPolyfill(host, opts?) | 在非原生浏览器中注入 modelContext polyfill。 |
@page-mcp/chat
| API | Description |
|---|
init(config) | 挂载聊天组件并连接 OpenAI 兼容后端。 |
config.openai | 直接 OpenAI 配置(apiKey/baseURL/model)。 |
config.endpoint | 通过后端代理端点替代直连模式。 |
config.theme/position/expandMode | 外观和交互行为配置。 |
widget.open()/close()/destroy() | 编程式生命周期控制。 |
@page-mcp/react
| API | Description |
|---|
<PageMcpProvider name version> | 通过 React Context 提供 host/client/bus。 |
usePageMcpHost/usePageMcpClient/usePageMcpBus | 在组件中访问 MCP 实例。 |
useRegisterTool/useRegisterResource/useRegisterSkill/useRegisterPrompt | 声明式注册能力。 |