API REFERENCE
API Reference
Public APIs exported from @page-mcp/core, @page-mcp/chat, and @page-mcp/react.
@page-mcp/core
| API | Description |
|---|
new EventBus({ timeout? }) | RPC transport between host and client. |
new PageMcpHost({ name, version, bus? }) | Page-side capability registry. |
host.registerTool(def) | Register MCP-aligned tool action. |
host.registerResource(def) | Register readable resource by URI. |
host.registerSkill(def) | Register multi-step workflow. |
host.registerPrompt(def) | Register prompt cards for AI widget. |
host.start() | Start RPC listener and publish readiness. |
new PageMcpClient({ bus?, connectTimeout? }) | AI-side invocation client. |
client.connect() | Connect and get HostInfo. |
client.listTools()/callTool() | Discover and invoke tools. |
client.listResources()/readResource() | Read exposed page resources. |
client.listSkills()/executeSkill() | Run skills and receive SkillResult. |
installWebMcpPolyfill(host, opts?) | Polyfill navigator.modelContext in non-native browsers. |
@page-mcp/chat
| API | Description |
|---|
init(config) | Mount chat widget and connect OpenAI-compatible backend. |
config.openai | Direct OpenAI config (apiKey/baseURL/model). |
config.endpoint | Proxy endpoint alternative to direct OpenAI mode. |
config.theme/position/expandMode | Visual and behavior controls. |
widget.open()/close()/destroy() | Programmatic lifecycle control. |
@page-mcp/react
| API | Description |
|---|
<PageMcpProvider name version> | Provides host/client/bus through React context. |
usePageMcpHost/usePageMcpClient/usePageMcpBus | Access MCP instances in components. |
useRegisterTool/useRegisterResource/useRegisterSkill/useRegisterPrompt | Declarative registration hooks. |