@mcp-b/extension-tools 0.0.1 → 0.1.2

package/README.md

@@ -6,6 +6,8 @@ Chrome Extension API tools for Model Context Protocol (MCP) - provides MCP-compa
 
 This package provides a comprehensive set of tool classes that expose Chrome Extension APIs through the Model Context Protocol (MCP). Each API is wrapped in a dedicated class that handles permission checking, error handling, and tool registration.
 
+Currently, **62 out of 74** Chrome Extension APIs have been implemented and are ready to use. See the [API Implementation Status](#api-implementation-status) section below for a complete list of available and pending APIs.
+
 ## Installation
 
 ```bash
@@ -16,22 +18,99 @@ pnpm add @b-mcp/extension-tools @modelcontextprotocol/sdk
 yarn add @b-mcp/extension-tools @modelcontextprotocol/sdk
 ```
 
-## Available API Tools
+## API Implementation Status
 
-- `TabsApiTools` - Create, update, query, and manage browser tabs
-- `WindowsApiTools` - Control browser windows
+### ✅ Available API Tools (62 APIs)
+
+The following Chrome Extension APIs have been fully implemented and are ready to use:
+
+- `AlarmsApiTools` - Set and manage alarms
+- `AudioApiTools` - Audio device management
 - `BookmarksApiTools` - Manage browser bookmarks
-- `StorageApiTools` - Access extension storage (local, sync, session)
+- `BrowsingDataApiTools` - Clear browsing data
+- `CertificateProviderApiTools` - Provide certificates for TLS authentication
+- `CommandsApiTools` - Manage keyboard shortcuts
+- `ContentSettingsApiTools` - Manage content settings
+- `ContextMenusApiTools` - Create context menu items
+- `CookiesApiTools` - Manage browser cookies
+- `DebuggerApiTools` - Debug network and JavaScript
+- `DeclarativeContentApiTools` - Take actions based on content
+- `DeclarativeNetRequestApiTools` - Modify network requests
+- `DesktopCaptureApiTools` - Capture desktop content
+- `DevtoolsInspectedWindowApiTools` - Interact with inspected window
+- `DevtoolsNetworkApiTools` - Retrieve network information
+- `DevtoolsPanelsApiTools` - Create DevTools panels
+- `DocumentScanApiTools` - Scan documents
+- `DomApiTools` - Access DOM from extensions
+- `DownloadsApiTools` - Control file downloads
+- `EnterpriseDeviceAttributesApiTools` - Access enterprise device attributes
+- `EnterpriseHardwarePlatformApiTools` - Access enterprise hardware info
+- `EnterpriseNetworkingAttributesApiTools` - Access enterprise network attributes
+- `EnterprisePlatformKeysApiTools` - Enterprise platform keys
+- `ExtensionApiTools` - Extension utilities
+- `FileBrowserHandlerApiTools` - Handle file browser events
+- `FileSystemProviderApiTools` - Provide file systems
+- `FontSettingsApiTools` - Manage font settings
+- `GcmApiTools` - Google Cloud Messaging
 - `HistoryApiTools` - Search and manage browsing history
+- `I18nApiTools` - Internationalization utilities
+- `IdentityApiTools` - OAuth2 authentication
+- `IdleApiTools` - Detect idle state
+- `InputImeApiTools` - Input method editor
+- `InstanceIDApiTools` - Instance ID operations
+- `LoginStateApiTools` - Read login state
+- `ManagementApiTools` - Manage extensions
 - `NotificationsApiTools` - Create system notifications
-- `ScriptingApiTools` - Execute scripts and inject CSS
-- `CookiesApiTools` - Manage browser cookies
-- `AlarmsApiTools` - Set and manage alarms
+- `OffscreenApiTools` - Manage offscreen documents
+- `OmniboxApiTools` - Customize address bar
+- `PageCaptureApiTools` - Save pages as MHTML
+- `PermissionsApiTools` - Request optional permissions
+- `PlatformKeysApiTools` - Platform-specific keys
+- `PowerApiTools` - Power management
+- `PrintingApiTools` - Print documents
+- `PrintingMetricsApiTools` - Printing metrics
+- `ProxyApiTools` - Manage proxy settings
+- `ReadingListApiTools` - Access reading list
 - `RuntimeApiTools` - Access extension runtime information
-- `CommandsApiTools` - Manage keyboard shortcuts
-- `DownloadsApiTools` - Control file downloads
-- `TtsApiTools` - Text-to-speech functionality
+- `ScriptingApiTools` - Execute scripts and inject CSS
+- `SearchApiTools` - Search via default provider
+- `SessionsApiTools` - Query and restore browser sessions
+- `SidePanelApiTools` - Control side panel
+- `StorageApiTools` - Access extension storage (local, sync, session)
+- `SystemCpuApiTools` - Query CPU information
+- `SystemLogApiTools` - Add system log entries
+- `SystemMemoryApiTools` - Get memory information
+- `SystemStorageApiTools` - Query storage devices
+- `TabCaptureApiTools` - Capture tab media streams
 - `TabGroupsApiTools` - Manage tab groups
+- `TabsApiTools` - Create, update, query, and manage browser tabs
+- `TopSitesApiTools` - Access top sites
+- `TtsApiTools` - Text-to-speech functionality
+- `TtsEngineApiTools` - Implement TTS engine
+- `UserScriptsApiTools` - Execute user scripts
+- `VpnProviderApiTools` - Implement VPN client
+- `WallpaperApiTools` - Set wallpaper
+- `WebAuthenticationProxyApiTools` - Web authentication proxy
+- `WebNavigationApiTools` - Monitor web navigation
+- `WebRequestApiTools` - Intercept and modify requests
+- `WindowsApiTools` - Control browser windows
+
+### 🚧 APIs Under Development (12 APIs)
+
+The following Chrome Extension APIs are not yet implemented or need additional work:
+
+- `AccessibilityFeaturesApiTools` - Manage accessibility features
+- `ActionApiTools` - Control extension's action button
+- `DevtoolsPerformanceApiTools` - Access performance data
+- `DevtoolsRecorderApiTools` - DevTools recorder panel
+- `DnsApiTools` - DNS resolution
+- `EventsApiTools` - Common event handling
+- `ExtensionTypesApiTools` - Extension type definitions
+- `PrinterProviderApiTools` - Provide printers
+- `PrivacyApiTools` - Control privacy features
+- `ProcessesApiTools` - Interact with browser processes
+- `SystemDisplayApiTools` - Query display information
+- `TypesApiTools` - Chrome type definitions
 
 ## Usage
 
@@ -188,28 +267,74 @@ interface TabsOptions {
 
 ## Permission Requirements
 
-Each Chrome API requires specific permissions in your extension's manifest.json:
+Each Chrome API requires specific permissions in your extension's manifest.json. Here are some common permissions:
 
 ```json
 {
   "manifest_version": 3,
   "permissions": [
-    "tabs",
+    "activeTab",
+    "alarms",
+    "audio",
     "bookmarks",
-    "storage",
-    "history",
-    "notifications",
+    "browsingData",
+    "certificateProvider",
+    "contentSettings",
+    "contextMenus",
     "cookies",
-    "alarms",
+    "debugger",
+    "declarativeContent",
+    "declarativeNetRequest",
+    "desktopCapture",
     "downloads",
-    "tts"
+    "fontSettings",
+    "gcm",
+    "history",
+    "identity",
+    "idle",
+    "management",
+    "notifications",
+    "offscreen",
+    "pageCapture",
+    "permissions",
+    "platformKeys",
+    "power",
+    "printing",
+    "printingMetrics",
+    "proxy",
+    "readingList",
+    "scripting",
+    "search",
+    "sessions",
+    "sidePanel",
+    "storage",
+    "system.cpu",
+    "system.memory",
+    "system.storage",
+    "tabCapture",
+    "tabGroups",
+    "tabs",
+    "topSites",
+    "tts",
+    "ttsEngine",
+    "unlimitedStorage",
+    "vpnProvider",
+    "wallpaper",
+    "webAuthenticationProxy",
+    "webNavigation",
+    "webRequest"
   ],
   "host_permissions": [
-    "<all_urls>" // Required for scripting API
+    "<all_urls>" // Required for scripting API and some other APIs
+  ],
+  "optional_permissions": [
+    // Add any permissions you want to request at runtime
   ]
 }
 ```
 
+**Note:** Not all APIs require permissions. Some APIs like `i18n`, `runtime`, and `extension` are available without explicit permissions. Enterprise APIs require the extension to be force-installed via enterprise policy.
+
 ## Tool Examples
 
 ### Tab Management