openbird 1.0.0

package/examples/basic-usage.mjs

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+/**
+ * OpenBird Basic Usage Example
+ *
+ * This example demonstrates the two integration surfaces OpenBird provides:
+ *
+ *   1. Webhook server  — receives real-time Feishu messages via HTTP POST
+ *   2. MCP client      — calls Feishu API tools (send message, search, etc.)
+ *
+ * ── Quick start ──────────────────────────────────────────────────────
+ *
+ *   # 1. Copy .env.example and fill in your cookie
+ *   cp .env.example .env
+ *   # edit .env → set OPENBIRD_COOKIE
+ *
+ *   # 2. Run this example (it sets OPENBIRD_WEBHOOK_URL automatically)
+ *   node examples/basic-usage.mjs
+ *
+ * ── What happens ─────────────────────────────────────────────────────
+ *
+ *   • openbird-webhooks starts an HTTP server on a free port.
+ *   • OpenBird is spawned as a child process with OPENBIRD_WEBHOOK_URL
+ *     pointing at that server.
+ *   • The MCP client connects to OpenBird over stdio.
+ *   • Incoming Feishu messages are printed to the console.
+ *   • After startup, the available MCP tools are listed, and
+ *     `get_calendar_events` is called as a demo.
+ *
+ * ─────────────────────────────────────────────────────────────────────
+ */
+
+import 'dotenv/config';
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js';
+import { createServer } from 'openbird-webhook-node';
+
+// ── 0. Preflight check ──────────────────────────────────────────────
+
+if (!process.env.OPENBIRD_COOKIE) {
+  console.error('Error: OPENBIRD_COOKIE is not set.');
+  console.error('Copy .env.example to .env and paste your Feishu cookie.');
+  process.exit(1);
+}
+
+// ── 1. Start webhook receiver (openbird-webhooks) ────────────────────
+
+const receiver = createServer();
+
+receiver.on('im.message.*', (event) => {
+  const { data } = event;
+  const sender = data.sender?.id ?? '?';
+  const chat = data.conversation?.id ?? '?';
+  const chatType = data.conversation?.type ?? '?';
+  const contentType = data.content?.type ?? '?';
+  const text = data.content?.text ?? '';
+  const preview = text.length > 80 ? text.slice(0, 80) + '...' : text;
+
+  console.log(
+    `[message] ${chatType} | chat=${chat} | from=${sender} | ${contentType}: ${preview}`
+  );
+});
+
+receiver.on('system.*', (event) => {
+  console.log(`[event] ${event.type}`, JSON.stringify(event.data).slice(0, 120));
+});
+
+// Listen on a random free port
+const httpServer = await receiver.listen(0, '127.0.0.1');
+const webhookPort = httpServer.address().port;
+const webhookUrl = `http://127.0.0.1:${webhookPort}/`;
+
+// ── 2. Spawn OpenBird & connect MCP client ───────────────────────────
+
+const transport = new StdioClientTransport({
+  command: 'npx',
+  args: ['openbird'],
+  env: {
+    ...process.env,
+    OPENBIRD_COOKIE: process.env.OPENBIRD_COOKIE,
+    OPENBIRD_WEBHOOK_URL: webhookUrl,
+  },
+  stderr: 'inherit',  // OpenBird logs go to our stderr
+});
+
+const client = new Client({ name: 'example-client', version: '1.0.0' });
+await client.connect(transport);
+console.log('[example] MCP client connected to OpenBird');
+
+// ── 3. List available tools ──────────────────────────────────────────
+
+const { tools } = await client.listTools();
+console.log(`[example] ${tools.length} tools available:`);
+for (const tool of tools) {
+  console.log(`  - ${tool.name}: ${tool.description}`);
+}
+
+// ── 4. Demo: call a tool ─────────────────────────────────────────────
+
+console.log('\n[example] Calling get_calendar_events ...');
+try {
+  const result = await client.callTool({ name: 'get_calendar_events', arguments: {} });
+  console.log('[example] Result:', JSON.stringify(result.content, null, 2));
+} catch (err) {
+  console.error('[example] Tool call failed:', err.message);
+}
+
+// ── 5. Wait for incoming messages ────────────────────────────────────
+
+console.log('\n[example] Listening for incoming Feishu messages (Ctrl+C to quit) ...\n');
+
+process.on('SIGINT', async () => {
+  console.log('\n[example] Shutting down ...');
+  await client.close();
+  await receiver.close();
+  process.exit(0);
+});

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "openbird",
+  "version": "1.0.0",
+  "description": "Feishu infrastructure service — WebSocket event forwarding + MCP Server",
+  "type": "module",
+  "bin": {
+    "openbird": "./bin/openbird.js"
+  },
+  "main": "src/index.js",
+  "scripts": {
+    "start": "node bin/openbird.js",
+    "generate:proto": "protoc --plugin=protoc-gen-es=node_modules/.bin/protoc-gen-es --proto_path=src/core/proto --es_out=src/core/proto src/core/proto/proto.proto"
+  },
+  "keywords": [
+    "feishu",
+    "lark",
+    "mcp",
+    "websocket",
+    "openbird"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@bufbuild/protobuf": "^2.11.0",
+    "@modelcontextprotocol/sdk": "^1.12.1",
+    "axios": "^1.13.3",
+    "dotenv": "^17.2.3",
+    "pako": "^2.1.0",
+    "ws": "^8.14.0",
+    "zod": "^3.24.0"
+  },
+  "devDependencies": {
+    "@bufbuild/protoc-gen-es": "^2.11.0",
+    "openbird-webhook-node": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}