@godwit/magpie-agent 0.0.0-stage → 1.37.0

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @godwit/magpie-agent
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Connects [Godwit](https://godwit.email) to [magpie](https://usemagpie.ai): Godwit's Wit can then use magpie's models, the MCP servers in magpie's library (memory, web search, browser and the tools of magpie's plugins), its skills and its instructions.
+
+```sh
+magpie plugin add @godwit/magpie-agent
+```
+
+Then turn Godwit on in magpie's Agents page and choose a model (or `magpie godwit <model>`). In magpie's Library, give Godwit the MCP servers, skills and instructions you want it to have: like every agent, it gets only those given to it.
+
+## What it writes
+
+magpie writes into `~/.godwit/external/`, and Godwit (of this package's version or later) mirrors it:
+
+| File | In Godwit |
+|---|---|
+| `models.json` | A model service named `magpie`, with every model magpie gives Godwit, written as magpie describes them; Godwit takes their names and context windows (routing groups included). The model chosen in magpie is Godwit's default model while connected; Godwit reads it from the file and keeps your own default beneath it. |
+| `mcp.json` | magpie's MCP servers. Each starts without a grant: Godwit asks you to grant it in Settings → Extensions before it runs. |
+| `skills/` | magpie's skills (linked from magpie's library), beside your own. A skill of yours with the same name wins. |
+| `AGENTS.md` | Your instructions from magpie's library, added to Wit's system prompt. |
+
+Godwit shows each of them as managed by magpie: change them in magpie, not in Godwit. Requests to the model go through magpie's gateway on this computer, and Godwit masks them the same as for any model service.
+
+## Disconnecting
+
+Turn Godwit off in magpie (or `magpie godwit default`): magpie restores the file, Godwit removes the `magpie` model service, and your own default model is the default again. The library's MCP servers, skills and instructions follow magpie's Library, as for any agent: take them from Godwit there and Godwit removes them too.

package/agent.js

@@ -0,0 +1,42 @@
+// The Godwit agent for magpie (https://usemagpie.ai/docs/plugins#agents).
+// magpie writes these files and restores them when the user disconnects;
+// Godwit mirrors them as read-only settings (ADR 0041 in the Godwit repo).
+// One path on every system: this file runs in moejs and cannot tell them apart.
+// Godwit creates the folder when it starts, which is how magpie finds it installed.
+const dir = "~/.godwit/external"
+
+export const agent = {
+  id: "godwit",
+  name: "Godwit",
+  icon: "https://godwit.email/icon.png", // on the agent itself: a plugin loaded from a folder has no package icon
+  bin: "godwit",
+  dir,
+  config: `${dir}/models.json`,
+  model: "magpie.model", // the default model Godwit switches to
+  ua: ["godwit"],
+  notice: "Godwit picks this up within a few seconds.",
+  library: {
+    instructions: `${dir}/AGENTS.md`,
+    mcp: `${dir}/mcp.json`,
+    mcpFormat: "claude",
+    skills: `${dir}/skills`,
+  },
+}
+
+// connect is the service Godwit adds: the gateway's address, this agent's own
+// key and every model magpie gives it, as magpie describes them (name, context
+// window, efforts…); Godwit takes what it uses. Key by key, not one object:
+// magpie tells it is connected by the key holding its key, and the model key
+// sits beside them. magpie calls it again when the models change.
+export function connect({ gateway, model, models }) {
+  if (!gateway?.v1 || !gateway?.key) throw new Error("magpie gave no gateway address or key")
+  const list = [...(models ?? [])]
+  if (model?.id && !list.some((m) => m.id === model.id)) list.push(model) // the chosen one is always offered
+  return {
+    "magpie.by": "magpie",
+    "magpie.baseURL": gateway.v1,
+    "magpie.apiKey": gateway.key,
+    "magpie.kind": "openai",
+    "magpie.models": list,
+  }
+}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@godwit/magpie-agent",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.37.0",
+  "description": "Connect Godwit to magpie: its models, MCP servers, skills and instructions",
+  "license": "Apache-2.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/godwit-email/godwit.git",
+    "directory": "packages/magpie-agent"
+  },
+  "homepage": "https://github.com/godwit-email/godwit/tree/main/packages/magpie-agent",
+  "keywords": [
+    "magpie",
+    "magpie-agent",
+    "magpie-plugin",
+    "llm-gateway",
+    "godwit"
+  ],
+  "files": [
+    "agent.js",
+    "README.md"
+  ],
+  "magpie": {
+    "agent": "./agent.js",
+    "name": "Godwit",
+    "icon": "https://godwit.email/icon.png",
+    "summary": {
+      "en": "Use magpie's models, MCP servers, skills and instructions in Godwit's Wit.",
+      "zh": "在 Godwit 的 Wit 里使用 magpie 的模型、MCP 服务器、技能和指令。"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}