@fre4x/jules 1.0.30 → 1.0.42

package/README.md

@@ -1,71 +1,68 @@
-# Jules MCP Server
+# jules — The Coding Agent Bridge
 
-An MCP server implementation for [Jules API](https://developers.google.com/jules/api), allowing LLMs to interact directly with your automated Jules workflows.
+> *Autonomous code changes, PR generation, and session management. The swarm's hands.*
 
-## Prerequisites
+Part of **[FRE4X-B1TE](../)** — a monorepo of MCP servers built for autonomous agents.
 
-1.  **Jules API Key**: Get your API Key from the Jules [Settings page](https://jules.google.com/settings#api).
-    *   *Note: Currently, Jules is migrating its authentication methods. If you receive a `401 Unauthorized` indicating "API keys are not supported by this API," you may need to wait for further updates from the Jules platform or supply an OAuth2 Token in place of the API key if supported.*
+[Google Jules](https://jules.google.com/) is an autonomous coding agent. This B1TE exposes its full API as MCP tools — so your agent can spawn Jules sessions, approve plans, and get PRs merged without a human in the loop.
 
-## Installation & Usage
+## Tools
 
-You can use the server directly via `npx` without installing it globally:
+| Tool | What it does |
+|------|-------------|
+| `jules_list_sources` | List connected GitHub repos available as sources |
+| `jules_create_session` | Start a new Jules coding session with a prompt, source, and optional config |
+| `jules_list_sessions` | List all sessions and their status (e.g. PR links) |
+| `jules_approve_plan` | Approve a session's execution plan (when `requirePlanApproval=true`) |
 
-```bash
-npx jules-mcp
-```
+### `jules_create_session` parameters
 
-### Environment Variables
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `source` | string | Source resource name, e.g. `sources/github/owner/repo` |
+| `title` | string | Session title |
+| `prompt` | string | Task description for Jules |
+| `startingBranch` | string | Branch to start from (default: `main`) |
+| `automationMode` | string | `AUTO_CREATE_PR` or `NONE` (default: `NONE`) |
+| `requirePlanApproval` | boolean | If true, pause for `jules_approve_plan` before executing (default: false) |
 
-The server requires the following environment variables:
+## Requirements
 
--   `JULES_API_KEY`: Your Jules API Key or Authentication Token.
+A [Jules API key](https://jules.google.com/settings#api) — set as `JULES_API_KEY`.
 
-## Configuration for Claude Desktop
+## Mock Mode
 
-To use this server with the Claude Desktop app, you need to add it to your configuration file.
+Run without an API key (returns fixture data of identical shape):
 
-**Config file locations:**
--   **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
--   **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+```bash
+MOCK=true npx @fre4x/jules
+```
 
-Add the following to your configuration, replacing `<YOUR_API_KEY>` with your actual Jules API key:
+## Deploy
 
 ```json
 {
   "mcpServers": {
     "jules": {
       "command": "npx",
-      "args": [
-        "-y",
-        "jules-mcp"
-      ],
+      "args": ["-y", "@fre4x/jules"],
       "env": {
-        "JULES_API_KEY": "<YOUR_API_KEY>"
+        "JULES_API_KEY": "your_api_key_here"
       }
     }
   }
 }
 ```
 
-## Available Tools
-
-The server implements the following tools:
-
--   `jules_list_sources`: Find the IDs of sources (e.g., connected GitHub repos) you can interact with.
--   `jules_create_session`: Start a new Jules coding session with a specific prompt and source context.
--   `jules_list_sessions`: Check the status and output links (e.g., Pull Requests) of your sessions.
--   `jules_approve_plan`: Approve a session's execution plan (if it was created with `requirePlanApproval=true`).
-
 ## Development
 
 ```bash
-# Install dependencies
 npm install
+npm run dev      # tsx, no build
+npm run build    # esbuild → dist/
+npm test         # vitest unit tests
+```
 
-# Build the project
-npm run build
+## License
 
-# Run via MCP Inspector for testing
-npm run inspector
-```
+MIT — **WE ARE THE FRE4X.**