@opentabs-dev/opentabs-plugin-discord 0.0.76 → 0.0.78

package/README.md

@@ -1,138 +1,91 @@
-# opentabs-plugin-discord
+# Discord
 
-OpenTabs plugin for Discord
+OpenTabs plugin for Discord — gives AI agents access to Discord through your authenticated browser session.
 
-## Project Structure
+## Install
 
-```
-discord/
-├── package.json          # Plugin metadata (name, opentabs field, dependencies)
-├── icon.svg              # Optional custom icon (square SVG, max 8KB)
-├── icon-inactive.svg     # Optional manual inactive icon override
-├── src/
-│   ├── index.ts          # Plugin class (extends OpenTabsPlugin)
-│   └── tools/            # One file per tool (using defineTool)
-│       └── example.ts
-└── dist/                 # Build output (generated)
-    ├── adapter.iife.js   # Bundled adapter injected into matching tabs
-    └── tools.json        # Tool schemas for MCP registration
+```bash
+opentabs plugin install discord
 ```
 
-## Configuration
+Or install globally via npm:
 
-Plugin metadata is defined in `package.json` under the `opentabs` field:
-
-```json
-{
-  "name": "opentabs-plugin-discord",
-  "main": "dist/adapter.iife.js",
-  "opentabs": {
-    "displayName": "Discord",
-    "description": "OpenTabs plugin for Discord",
-    "urlPatterns": ["*://discord.com/*"]
-  }
-}
+```bash
+npm install -g @opentabs-dev/opentabs-plugin-discord
 ```
 
-- **`main`** — entry point for the bundled adapter IIFE
-- **`opentabs.displayName`** — human-readable name shown in the side panel
-- **`opentabs.description`** — short description of what the plugin does
-- **`opentabs.urlPatterns`** — Chrome match patterns for tabs where the adapter is injected
+## Setup
 
-## Custom Icons
+1. Open [discord.com](https://discord.com/channels/@me) in Chrome and log in
+2. Open the OpenTabs side panel — the Discord plugin should appear as **ready**
 
-By default, the side panel shows a colored letter avatar for your plugin. To use a custom icon, place an `icon.svg` file in the plugin root (next to `package.json`):
+## Tools (26)
 
-```
-discord/
-├── package.json
-├── icon.svg              ← custom icon (optional)
-├── icon-inactive.svg     ← manual inactive override (optional, requires icon.svg)
-├── src/
-│   └── ...
-```
+### Messages (8)
 
-**How it works:**
+| Tool | Description | Type |
+|---|---|---|
+| `send_message` | Send a message to a channel | Write |
+| `edit_message` | Edit an existing message | Write |
+| `delete_message` | Delete a message from a channel | Write |
+| `read_messages` | Read recent messages from a channel | Read |
+| `read_thread` | Read messages from a thread | Read |
+| `search_messages` | Search messages in a server | Read |
+| `get_message` | Get a message by ID | Read |
+| `list_pinned_messages` | List pinned messages in a channel | Read |
 
-- `opentabs-plugin build` reads `icon.svg`, validates it, auto-generates a grayscale inactive variant, and embeds both in `dist/tools.json`
-- To override the auto-generated inactive icon, provide `icon-inactive.svg` (must use only grayscale colors)
-- If no `icon.svg` is provided, the letter avatar is used automatically
+### Servers (3)
 
-**Icon requirements:**
+| Tool | Description | Type |
+|---|---|---|
+| `list_guilds` | List servers the user belongs to | Read |
+| `get_guild_info` | Get detailed info about a server | Read |
+| `list_roles` | List roles in a server | Read |
 
-- Square SVG with a `viewBox` attribute (e.g., `viewBox="0 0 32 32"`)
-- Maximum 8 KB file size
-- No embedded `<image>`, `<script>`, or event handler attributes (`onclick`, etc.)
-- Manual `icon-inactive.svg` must use only achromatic (grayscale) colors
+### Channels (6)
 
-## Development
+| Tool | Description | Type |
+|---|---|---|
+| `list_channels` | List channels in a server | Read |
+| `get_channel_info` | Get detailed information about a channel | Read |
+| `create_channel` | Create a new channel in a server | Write |
+| `edit_channel` | Edit a channel's name, topic, or settings | Write |
+| `delete_channel` | Delete a channel permanently | Write |
+| `create_thread` | Create a new thread | Write |
 
-```bash
-npm install
-npm run build       # tsc && opentabs-plugin build
-npm run dev         # watch mode (tsc --watch + opentabs-plugin build --watch)
-npm run type-check  # tsc --noEmit
-npm run lint        # biome
-```
+### Users (2)
 
-## Adding Tools
-
-Create a new file in `src/tools/` using `defineTool`:
-
-```ts
-import { z } from 'zod';
-import { defineTool } from '@opentabs-dev/plugin-sdk';
-
-export const myTool = defineTool({
-  name: 'my_tool',
-  displayName: 'My Tool',
-  description: 'What this tool does',
-  icon: 'wrench',
-  input: z.object({ /* ... */ }),
-  output: z.object({ /* ... */ }),
-  handle: async (params) => {
-    // Tool implementation runs in the browser tab context
-    return { /* ... */ };
-  },
-});
-```
+| Tool | Description | Type |
+|---|---|---|
+| `list_members` | List members in a server | Read |
+| `get_user_profile` | Get a user's profile information | Read |
 
-Then register it in `src/index.ts` by adding it to the `tools` array.
+### DMs (2)
 
-## Shared Schemas
+| Tool | Description | Type |
+|---|---|---|
+| `list_dms` | List open direct message channels | Read |
+| `open_dm` | Open a direct message conversation | Write |
 
-When 3 or more tools share the same input or output shape, extract common Zod schemas into a shared file to avoid duplication:
+### Reactions (4)
 
-```ts
-// src/schemas/channel.ts
-import { z } from 'zod';
+| Tool | Description | Type |
+|---|---|---|
+| `add_reaction` | Add an emoji reaction to a message | Write |
+| `remove_reaction` | Remove an emoji reaction from a message | Write |
+| `pin_message` | Pin a message in a channel | Write |
+| `unpin_message` | Unpin a message from a channel | Write |
 
-export const channelSchema = z.object({
-  id: z.string().describe('Channel ID'),
-  name: z.string().describe('Channel name'),
-});
+### Files (1)
 
-export type Channel = z.infer<typeof channelSchema>;
-```
+| Tool | Description | Type |
+|---|---|---|
+| `upload_file` | Upload a file to a channel | Write |
 
-Then import and reuse in your tools:
-
-```ts
-// src/tools/list-channels.ts
-import { channelSchema } from '../schemas/channel.js';
-
-export const listChannels = defineTool({
-  name: 'list_channels',
-  displayName: 'List Channels',
-  description: 'List all available channels',
-  icon: 'list',
-  input: z.object({}),
-  output: z.object({ channels: z.array(channelSchema) }),
-  handle: async () => {
-    // ...
-    return { channels: [] };
-  },
-});
-```
+## How It Works
+
+This plugin runs inside your Discord tab through the [OpenTabs](https://opentabs.dev) Chrome extension. It uses your existing browser session — no API tokens or OAuth apps required. All operations happen as you, with your permissions.
+
+## License
 
-This keeps your tool schemas DRY and makes it easy to evolve shared types in one place.
+MIT

package/dist/adapter.iife.js

@@ -291,6 +291,8 @@
      * (e.g., 'https://github.com'), not a match pattern.
      */
     homepage;
+    /** Typed configuration schema — declares settings that users provide via config.json or the side panel. */
+    configSchema;
   };
 
   // src/discord-api.ts
@@ -15169,7 +15171,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
   };
   var src_default = new DiscordPlugin();
 
-  // dist/_adapter_entry_391d0397-f432-4821-bcd1-f4d8bf6321f2.ts
+  // dist/_adapter_entry_ab833463-23a5-4149-9b09-1ebe7ece188f.ts
   if (!globalThis.__openTabs) {
     globalThis.__openTabs = {};
   } else {
@@ -15385,5 +15387,5 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     };
     delete src_default.onDeactivate;
   }
-})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["discord"]){var a=o.adapters["discord"];a.__adapterHash="6034396fc82208dc894add1329f2c0bc9184c8490c5a57ec63ebe26b819bd5d6";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"discord",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
+})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["discord"]){var a=o.adapters["discord"];a.__adapterHash="7c910f8eaa726cb7dbce1447ac4904c7679b9499ea0211f367b691c56c10dc60";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"discord",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
 //# sourceMappingURL=adapter.iife.js.map