From 4a1843053aa4ea59e9ce2a4f1e0544a858ad0f81 Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 28 Oct 2026 16:56:08 -0700 Subject: [PATCH 1/4] docs: clarify plugin READMEs for public listings List the features the glean plugin adds: email sign-in, approval before writes, built-in Glean tools, and access to the organization's skills and tools. Add a short Privacy section that says what the plugin sends to Glean and what it keeps on the user's computer, including the Glean MCP servers that the Claude Code hook reports. Fix setup text that was wrong or stale. The Claude READMEs no longer tell Claude chat and Cowork users to run the plugin's setup, which can't work there; they point to a custom connector instead. Setup steps describe email sign-in, and the requirements list Node.js 22 or later. The v3.0.0 migration notes move below the quick start, and the Cursor root README drops its stale "What's new in v3.0.0" section. Point the developer docs READMEs at developers.glean.com and give the MCP setup command for Claude Code and Cursor. --- overrides/claude/root/README.md | 75 +++++++++++------------- overrides/codex/glean-dev-docs/README.md | 4 +- overrides/codex/glean/README.md | 36 ++++++++++-- overrides/codex/root/README.md | 5 +- overrides/cursor/glean/README.md | 35 ++++++++--- overrides/cursor/root/README.md | 17 +++--- shared/glean-dev-docs/README.md | 22 +++++-- shared/glean/README.md | 58 ++++++++++++------ 8 files changed, 160 insertions(+), 92 deletions(-) diff --git a/overrides/claude/root/README.md b/overrides/claude/root/README.md index c344e06..1f0718d 100644 --- a/overrides/claude/root/README.md +++ b/overrides/claude/root/README.md @@ -8,15 +8,40 @@ Official Glean plugins for [Claude](https://claude.com) — enterprise knowledge, search, people, code, and meetings. -> **Surface support:** The shared skills are designed to work across Claude Code, -Claude Desktop chat, and Claude Cowork. Hooks and supporting agents require host -support: Claude Code and Cowork support them, while Claude Desktop chat does not -run them. The plugin provides a local Glean MCP server where the host supports -bundled MCP; otherwise, configure the remote server in the host's MCP settings. -The automated checks validate package structure, not full runtime parity in every -host. +## Quick start (new install) + +### Claude Code + +``` +/plugin marketplace add gleanwork/claude-plugins +/plugin install glean@glean-plugins +/plugin install glean-dev-docs@glean-plugins +``` + +Then ask Claude: `Set up Glean for me`. Enter your work email when asked, then +finish signing in in your browser. Skills auto-trigger by task. + +### Claude chat and Cowork + +The `glean` plugin's Glean tools run in Claude Code only. In Claude chat and +Cowork, add Glean as a custom connector instead, using your Glean MCP server +URL. -## ⚠️ v3.0.0 — plugins consolidated (one-time migration) +## Plugins + +| Plugin | Description | +|--------|-------------| +| **[glean](plugins/glean)** | Enterprise knowledge — search docs/Slack/email, cross-repo code exploration, people & experts, meeting prep & catch-up, onboarding, productivity. | +| **[glean-dev-docs](plugins/glean-dev-docs)** | Search Glean's public developer documentation — APIs, SDKs, MCP, and integration guides. | + +## Requirements + +- [Claude Code](https://claude.com/claude-code) +- [Node.js](https://nodejs.org) 22 or later +- A Glean account with MCP access +- For Claude chat and Cowork, your Glean MCP server URL (find it at [app.glean.com/admin/about-glean](https://app.glean.com/admin/about-glean)); format: `[server-url]/mcp/[server-name]` + +## Upgrading from v2 (one-time migration) The commands below are for Claude Code. In Claude Desktop or Cowork, use **Customize → Plugins** to remove the old marketplace and install the consolidated @@ -60,40 +85,6 @@ Restart Claude Code if prompted. `glean` carries everything the old plugins did. -## Quick start (new install) - -### Claude Code - -``` -/plugin marketplace add gleanwork/claude-plugins -/plugin install glean@glean-plugins -/plugin install glean-dev-docs@glean-plugins -``` - -Then set up Glean by prompting the harness, for example: `Set up Glean for me`. -Complete the browser OAuth flow when prompted. Skills auto-trigger by task. - -### Claude Desktop or Cowork - -Open **Customize → Plugins**, choose **Add marketplace**, and add -`gleanwork/claude-plugins`. Install **Glean** and **Glean Developer Docs**. - -Then ask Claude to `Set up Glean for me` and complete the browser OAuth flow -when prompted. Skills auto-trigger by task. - -## Plugins - -| Plugin | Description | -|--------|-------------| -| **[glean](plugins/glean)** | Enterprise knowledge — search docs/Slack/email, cross-repo code exploration, people & experts, meeting prep & catch-up, onboarding, productivity. | -| **[glean-dev-docs](plugins/glean-dev-docs)** | Search Glean's public developer documentation — APIs, SDKs, MCP, and integration guides. | - -## Requirements - -- A current Claude host that supports plugins: [Claude Code](https://claude.com/claude-code), [Claude Desktop](https://claude.com/download), or [Claude Cowork](https://claude.com/product/cowork) -- A Glean account with MCP access -- Your Glean MCP server URL (find it at [app.glean.com/admin/about-glean](https://app.glean.com/admin/about-glean)); format: `[server-url]/mcp/[server-name]` - ## Support - [Glean MCP Documentation](https://docs.glean.com/mcp) diff --git a/overrides/codex/glean-dev-docs/README.md b/overrides/codex/glean-dev-docs/README.md index ce0eca7..269024d 100644 --- a/overrides/codex/glean-dev-docs/README.md +++ b/overrides/codex/glean-dev-docs/README.md @@ -1,6 +1,6 @@ # Glean Developer Docs -Search the public [Glean developer documentation](https://docs.glean.com) — APIs, SDKs, +Search the public [Glean developer documentation](https://developers.glean.com) — APIs, SDKs, MCP, authentication, indexing, and integration guides for building *with* Glean. This is a separate, focused plugin for people building on the Glean platform. For @@ -31,7 +31,7 @@ It searches the public developer documentation and returns cited answers. ## Support -- [Glean Developer Documentation](https://docs.glean.com) +- [Glean Developer Documentation](https://developers.glean.com) - [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) ## License diff --git a/overrides/codex/glean/README.md b/overrides/codex/glean/README.md index adead58..1a7ee0b 100644 --- a/overrides/codex/glean/README.md +++ b/overrides/codex/glean/README.md @@ -1,7 +1,19 @@ # Glean for Codex -Official Glean plugin for [Codex](https://developers.openai.com/codex) — enterprise search, -code exploration, and people discovery directly in your development workflow. +Official Glean plugin for [Codex](https://developers.openai.com/codex). Search +your company's knowledge, explore code across repos, find people and experts, +and prepare for meetings, right in your terminal. + +## Features + +- **Email sign-in.** Set up with your work email. The plugin finds your Glean + instance and signs you in through your browser. +- **Approval before writes.** Tools that change data, such as sending a message + or creating a ticket, ask you to Allow, Always Allow or Deny first. +- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, + memory, user activity, employee search and meeting lookup. +- **Your organization's tools.** Find and run the skills and tools your Glean + admin has connected. ## Setup @@ -14,9 +26,9 @@ codex plugin add glean@glean-codex-plugins ### 2. Set up Glean -Start a new Codex task and prompt the harness: `Set up Glean for me`. Complete -the browser OAuth flow when prompted, then start a new task so both the bundled -skills and Glean MCP tools are available. +Start a new Codex task and ask: `Set up Glean for me`. Enter your work email +when asked, then finish signing in in your browser. Start a new task so both +the bundled skills and Glean tools are available. ## What's Included @@ -34,8 +46,22 @@ per-skill install. They cover: ## Requirements - [Codex](https://developers.openai.com/codex) with plugin support +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access +The Codex IDE extension doesn't support plugins. There, add your Glean MCP +server URL (`[server-url]/mcp/[server-name]`, available from your +[Glean admin](https://app.glean.com/admin/about-glean)) as an MCP server instead. + +## Privacy + +The plugin connects only to Glean: + +- During setup, it sends your work email to `app.glean.com` to find your Glean + instance. +- Requests to your Glean instance include the plugin and Codex versions. +- Sign-in tokens and caches stay on your computer, in `~/.glean`. + ## Support - [Glean MCP Documentation](https://docs.glean.com/mcp) diff --git a/overrides/codex/root/README.md b/overrides/codex/root/README.md index 0c15419..4fe5096 100644 --- a/overrides/codex/root/README.md +++ b/overrides/codex/root/README.md @@ -17,8 +17,8 @@ codex plugin add glean@glean-codex-plugins codex plugin add glean-dev-docs@glean-codex-plugins ``` -Start Codex and prompt the harness to set up Glean, for example: `Set up Glean -for me`. Complete the browser OAuth flow when prompted. +Start Codex and ask: `Set up Glean for me`. Enter your work email when asked, +then finish signing in in your browser. The **Glean developer docs** plugin uses a separate public MCP server. If you installed that plugin, add it before starting a new Codex task: @@ -36,6 +36,7 @@ Then start a new Codex task so the bundled skills and MCP tools are available. ## Requirements - [Codex](https://developers.openai.com/codex) with plugin support +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access (for the `glean` plugin) ## Support diff --git a/overrides/cursor/glean/README.md b/overrides/cursor/glean/README.md index c2f76bc..cc6a444 100644 --- a/overrides/cursor/glean/README.md +++ b/overrides/cursor/glean/README.md @@ -1,7 +1,19 @@ # Glean for Cursor -Official Glean plugin for [Cursor](https://cursor.com) — enterprise search, code exploration, -and people discovery directly in your development workflow. +Official Glean plugin for [Cursor](https://cursor.com). Search your company's +knowledge, explore code across repos, find people and experts, and prepare for +meetings, right in your editor. + +## Features + +- **Email sign-in.** Set up with your work email. The plugin finds your Glean + instance and signs you in through your browser. +- **Approval before writes.** Tools that change data, such as sending a message + or creating a ticket, ask you to Allow, Always Allow or Deny first. +- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, + memory, user activity, employee search and meeting lookup. +- **Your organization's tools.** Find and run the skills and tools your Glean + admin has connected. ## Setup @@ -11,9 +23,8 @@ Install from the [Cursor marketplace](https://cursor.com/marketplace/glean). ### 2. Set up Glean -Start Cursor and prompt the harness to set up Glean, for example: `Set up -Glean for me`. Complete the browser OAuth flow when prompted, then return to -Cursor. +Ask the agent: `Set up Glean for me`. Enter your work email when asked, then +finish signing in in your browser. ## What's Included @@ -28,15 +39,21 @@ auto-trigger by task — there's no per-skill install. They cover: - **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. - **Skill authoring** — discover automation opportunities and generate new skills. -The plugin provides a local Glean MCP server. If no Glean tools are visible, -ask the user to set up Glean by prompting the harness (for example, `Set up -Glean for me`). - ## Requirements - [Cursor](https://cursor.com) (latest version) +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access +## Privacy + +The plugin connects only to Glean: + +- During setup, it sends your work email to `app.glean.com` to find your Glean + instance. +- Requests to your Glean instance include the plugin and Cursor versions. +- Sign-in tokens and caches stay on your computer, in `~/.glean`. + ## Support - [Glean MCP Documentation](https://docs.glean.com/mcp) diff --git a/overrides/cursor/root/README.md b/overrides/cursor/root/README.md index b656d59..010174d 100644 --- a/overrides/cursor/root/README.md +++ b/overrides/cursor/root/README.md @@ -8,19 +8,12 @@ Official Glean plugins for [Cursor](https://cursor.com) — enterprise knowledge, search, code exploration, and people discovery, right in your editor. -## What's new in v3.0.0 - -- The **`glean`** plugin is refreshed with the latest consolidated skills and - agents (search, code exploration, people, meetings, onboarding, productivity). - Your existing `glean` install updates in place — no migration needed. -- A new **`glean-dev-docs`** plugin searches Glean's public developer - documentation (APIs, SDKs, MCP) — install it if you build *with* Glean. - ## Install Add the **`gleanwork/cursor-plugins`** marketplace in Cursor, then install the **`glean`** plugin (and **`glean-dev-docs`** if you build with Glean). Once -installed, ask Cursor to "set up Glean" and complete the browser OAuth flow. +installed, ask Cursor to `Set up Glean for me`, enter your work email, and +finish signing in in your browser. ## Plugins @@ -29,6 +22,12 @@ installed, ask Cursor to "set up Glean" and complete the browser OAuth flow. | **[glean](glean)** | Enterprise knowledge — search docs/Slack/email, cross-repo code exploration, people & experts, meetings, onboarding, productivity. | | **[glean-dev-docs](glean-dev-docs)** | Search Glean's public developer documentation — APIs, SDKs, MCP, and integration guides. | +## Requirements + +- [Cursor](https://cursor.com) (latest version) +- [Node.js](https://nodejs.org) 22 or later +- A Glean account with MCP access (for the `glean` plugin) + ## License MIT License - see [LICENSE](LICENSE) for details. diff --git a/shared/glean-dev-docs/README.md b/shared/glean-dev-docs/README.md index 3d4fbc0..287988e 100644 --- a/shared/glean-dev-docs/README.md +++ b/shared/glean-dev-docs/README.md @@ -1,6 +1,6 @@ # Glean Developer Docs -Search the public [Glean developer documentation](https://docs.glean.com) — APIs, SDKs, +Search the public [Glean developer documentation](https://developers.glean.com) — APIs, SDKs, MCP, authentication, indexing, and integration guides for building *with* Glean. This is a separate, focused plugin for people building on the Glean platform. For @@ -14,8 +14,22 @@ Install from your host's plugin marketplace (Claude Code or Cursor). ### 2. Configure the Glean Dev Docs MCP server -This plugin uses the public Glean Developer Docs MCP server. See your host's MCP -setup to add it; no Glean account is required. +This plugin uses the public Glean Developer Docs MCP server. No Glean account is +required. In Claude Code, add it with: + +```bash +claude mcp add --transport http glean-dev-docs https://developers.glean.com/mcp +``` + +In Cursor, add it to `~/.cursor/mcp.json`: + +```json +{ + "mcpServers": { + "glean-dev-docs": { "url": "https://developers.glean.com/mcp" } + } +} +``` ## What's Included @@ -25,7 +39,7 @@ It searches the public developer documentation and returns cited answers. ## Support -- [Glean Developer Documentation](https://docs.glean.com) +- [Glean Developer Documentation](https://developers.glean.com) - [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) ## License diff --git a/shared/glean/README.md b/shared/glean/README.md index 1098ac7..64f4f4f 100644 --- a/shared/glean/README.md +++ b/shared/glean/README.md @@ -1,24 +1,33 @@ # Glean -Official Glean plugin for supported AI hosts — enterprise search, code -exploration, and people discovery in your development workflow. +Official Glean plugin for [Claude Code](https://claude.com/claude-code). Search +your company's knowledge, explore code across repos, find people and experts, +and prepare for meetings, without leaving Claude. + +## Features + +- **Email sign-in.** Set up with your work email. The plugin finds your Glean + instance and signs you in through your browser. +- **Approval before writes.** Tools that change data, such as sending a message + or creating a ticket, ask you to Allow, Always Allow or Deny first. +- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, + memory, user activity, employee search and meeting lookup. +- **Your organization's tools.** Find and run the skills and tools your Glean + admin has connected. ## Setup ### 1. Install the plugin -Install from your host's plugin marketplace. This plugin's shared skills work -across Claude Code, Claude Desktop chat, Claude Cowork, Cursor, and Codex; hooks -and supporting agents depend on host support. +``` +/plugin marketplace add gleanwork/claude-plugins +/plugin install glean@glean-plugins +``` ### 2. Set up Glean -Use the host's Glean setup flow. In Claude Code or Cowork, prompt the harness, -for example: `Set up Glean for me`, then complete the browser OAuth flow when -prompted. For hosts that do not start the bundled local server, register the -Glean MCP endpoint in the host's MCP configuration and follow that host's -authentication flow. Some hosts, such as Codex, require an explicit MCP login -step. +Ask Claude: `Set up Glean for me`. Enter your work email when asked, then +finish signing in in your browser. ## What's Included @@ -33,17 +42,28 @@ by task — there's no per-skill install. They cover: - **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. - **Skill authoring** — discover automation opportunities and generate new skills. -The plugin provides a local Glean MCP server where the host supports bundled -MCP. If no Glean tools are visible, use the host's Glean setup flow described -above. Otherwise, Glean tools use whatever Glean MCP server is connected in the -current host. - ## Requirements -- A current supported AI host that supports plugins and MCP +- [Claude Code](https://claude.com/claude-code) +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access -- A Glean MCP endpoint if your host requires remote configuration (get it from - the [Glean admin settings](https://app.glean.com/admin/about-glean)) + +The plugin's Glean tools run in Claude Code only. In Claude chat, Cowork and +cloud sessions, add Glean as a custom connector instead, using your Glean MCP +server URL (`[server-url]/mcp/[server-name]`, available from your +[Glean admin](https://app.glean.com/admin/about-glean)). + +## Privacy + +The plugin connects only to Glean: + +- During setup, it sends your work email to `app.glean.com` to find your Glean + instance. +- Requests to your Glean instance include the plugin and Claude Code versions, + and the Glean MCP servers configured in Claude Code. Other MCP servers are + counted, not named. +- Sign-in tokens and caches stay on your computer, in Claude Code's plugin data + folder or `~/.glean`. ## Support From 16949f288ca68ac9312c7b6f6d9cfb8ba5ebf60c Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 28 Oct 2026 17:01:27 -0700 Subject: [PATCH 2/4] docs: show where the plugin's skills and tools work Replace the Features list with a "Where it works" section in each plugin README. It separates the skills, which load wherever the host loads plugins, from the Glean tools, which come from the plugin's local MCP server. A table shows both for each surface, and says when to add Glean as a custom connector or MCP server instead. Add the two reasons for the local server: email sign-in, because each Glean instance has its own MCP URL, and approval prompts for hosts on MCP versions before 2026-07-28. In the Claude root README, give install steps for Claude Desktop, chat and Cowork, and stop implying the plugin works only in Claude Code. --- overrides/claude/root/README.md | 15 ++++---- overrides/codex/glean/README.md | 43 +++++++++++++++------- overrides/cursor/glean/README.md | 36 +++++++++++++----- shared/glean/README.md | 63 +++++++++++++++++++++----------- 4 files changed, 106 insertions(+), 51 deletions(-) diff --git a/overrides/claude/root/README.md b/overrides/claude/root/README.md index 1f0718d..50cd9d9 100644 --- a/overrides/claude/root/README.md +++ b/overrides/claude/root/README.md @@ -21,11 +21,13 @@ search, people, code, and meetings. Then ask Claude: `Set up Glean for me`. Enter your work email when asked, then finish signing in in your browser. Skills auto-trigger by task. -### Claude chat and Cowork +### Claude Desktop, chat and Cowork -The `glean` plugin's Glean tools run in Claude Code only. In Claude chat and -Cowork, add Glean as a custom connector instead, using your Glean MCP server -URL. +Open **Customize → Plugins**, add the `gleanwork/claude-plugins` marketplace, +and install **Glean** and **Glean Developer Docs**. The skills load here, but +the `glean` plugin's Glean tools run only in Claude Code. Add Glean as a custom +connector, using your Glean MCP server URL, and the skills use it. The +[glean plugin README](plugins/glean) shows what works on each surface. ## Plugins @@ -36,10 +38,9 @@ URL. ## Requirements -- [Claude Code](https://claude.com/claude-code) -- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access -- For Claude chat and Cowork, your Glean MCP server URL (find it at [app.glean.com/admin/about-glean](https://app.glean.com/admin/about-glean)); format: `[server-url]/mcp/[server-name]` +- For Glean tools in Claude Code: [Node.js](https://nodejs.org) 22 or later +- For Claude chat and Cowork: your Glean MCP server URL (find it at [app.glean.com/admin/about-glean](https://app.glean.com/admin/about-glean)); format: `[server-url]/mcp/[server-name]` ## Upgrading from v2 (one-time migration) diff --git a/overrides/codex/glean/README.md b/overrides/codex/glean/README.md index 1a7ee0b..87617d8 100644 --- a/overrides/codex/glean/README.md +++ b/overrides/codex/glean/README.md @@ -4,16 +4,37 @@ Official Glean plugin for [Codex](https://developers.openai.com/codex). Search your company's knowledge, explore code across repos, find people and experts, and prepare for meetings, right in your terminal. -## Features +## Where it works -- **Email sign-in.** Set up with your work email. The plugin finds your Glean - instance and signs you in through your browser. -- **Approval before writes.** Tools that change data, such as sending a message - or creating a ticket, ask you to Allow, Always Allow or Deny first. -- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, - memory, user activity, employee search and meeting lookup. -- **Your organization's tools.** Find and run the skills and tools your Glean - admin has connected. +The plugin has two parts: + +- **Skills** that Codex loads from the plugin. +- **Glean tools** from a local MCP server that the plugin starts. + +| Surface | Skills | Glean tools | +| -------------------------------- | ----------------- | ------------------------- | +| Codex CLI | Yes | Yes, from the plugin | +| Codex in the ChatGPT desktop app | Not supported yet | Not supported yet | +| Codex IDE extension | No | Add your Glean MCP server | + +The Codex IDE extension doesn't support plugins. To add your Glean MCP server +there, use its URL (`[server-url]/mcp/[server-name]`, available from your +[Glean admin](https://app.glean.com/admin/about-glean)): + +```bash +codex mcp add glean --url [server-url]/mcp/[server-name] +codex mcp login glean +``` + +### Why a local server? + +It does two things that hosts can't do with Glean yet: + +- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds + yours from your work email and signs you in through your browser. +- **Approval before writes.** Glean asks you to approve tools that change data, + such as sending a message or creating a ticket. Hosts on MCP versions before + 2026-07-28 can't show Glean's prompt, so the local server shows it instead. ## Setup @@ -49,10 +70,6 @@ per-skill install. They cover: - [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access -The Codex IDE extension doesn't support plugins. There, add your Glean MCP -server URL (`[server-url]/mcp/[server-name]`, available from your -[Glean admin](https://app.glean.com/admin/about-glean)) as an MCP server instead. - ## Privacy The plugin connects only to Glean: diff --git a/overrides/cursor/glean/README.md b/overrides/cursor/glean/README.md index cc6a444..0519cb6 100644 --- a/overrides/cursor/glean/README.md +++ b/overrides/cursor/glean/README.md @@ -4,16 +4,32 @@ Official Glean plugin for [Cursor](https://cursor.com). Search your company's knowledge, explore code across repos, find people and experts, and prepare for meetings, right in your editor. -## Features - -- **Email sign-in.** Set up with your work email. The plugin finds your Glean - instance and signs you in through your browser. -- **Approval before writes.** Tools that change data, such as sending a message - or creating a ticket, ask you to Allow, Always Allow or Deny first. -- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, - memory, user activity, employee search and meeting lookup. -- **Your organization's tools.** Find and run the skills and tools your Glean - admin has connected. +## Where it works + +The plugin has two parts: + +- **Skills, agents and rules** that Cursor loads from the plugin. +- **Glean tools** from a local MCP server that the plugin starts. + +| Surface | Skills | Glean tools | +| ------------------------------ | ----------------- | ------------------------------- | +| Cursor editor and Agent Window | Yes | Yes, from the plugin | +| Cursor CLI | Not supported yet | Add your Glean MCP server | +| Cursor Cloud Agents | Not supported yet | Add your Glean MCP server | + +To add your Glean MCP server, put its URL (`[server-url]/mcp/[server-name]`, +available from your [Glean admin](https://app.glean.com/admin/about-glean)) in +Cursor's MCP settings. + +### Why a local server? + +It does two things that hosts can't do with Glean yet: + +- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds + yours from your work email and signs you in through your browser. +- **Approval before writes.** Glean asks you to approve tools that change data, + such as sending a message or creating a ticket. Hosts on MCP versions before + 2026-07-28 can't show Glean's prompt, so the local server shows it instead. ## Setup diff --git a/shared/glean/README.md b/shared/glean/README.md index 64f4f4f..74b0dd2 100644 --- a/shared/glean/README.md +++ b/shared/glean/README.md @@ -1,33 +1,60 @@ # Glean -Official Glean plugin for [Claude Code](https://claude.com/claude-code). Search -your company's knowledge, explore code across repos, find people and experts, -and prepare for meetings, without leaving Claude. +Official Glean plugin for [Claude](https://claude.com). Search your company's +knowledge, explore code across repos, find people and experts, and prepare for +meetings. -## Features +## Where it works -- **Email sign-in.** Set up with your work email. The plugin finds your Glean - instance and signs you in through your browser. -- **Approval before writes.** Tools that change data, such as sending a message - or creating a ticket, ask you to Allow, Always Allow or Deny first. -- **Built-in Glean tools.** Search, read documents, chat with Glean Assistant, - memory, user activity, employee search and meeting lookup. -- **Your organization's tools.** Find and run the skills and tools your Glean - admin has connected. +The plugin has two parts, and they work in different places: + +- **Skills** load wherever Claude loads plugins. Agents run in Claude Code and + Cowork. +- **Glean tools** come from a local MCP server that the plugin starts. Glean + supports it in Claude Code. + +| Surface | Skills | Glean tools | +| -------------------------- | ------ | ------------------------------- | +| Claude Code | Yes | Yes, from the plugin | +| Cowork | Yes | Add Glean as a custom connector | +| Claude chat | Yes | Add Glean as a custom connector | +| Claude Code cloud sessions | No | Add Glean as a custom connector | + +For a custom connector, use your Glean MCP server URL +(`[server-url]/mcp/[server-name]`, available from your +[Glean admin](https://app.glean.com/admin/about-glean)). The skills use +whichever Glean tools are connected. + +### Why a local server? + +It does two things that hosts can't do with Glean yet: + +- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds + yours from your work email and signs you in through your browser. +- **Approval before writes.** Glean asks you to approve tools that change data, + such as sending a message or creating a ticket. Hosts on MCP versions before + 2026-07-28 can't show Glean's prompt, so the local server shows it instead. ## Setup ### 1. Install the plugin +In Claude Code: + ``` /plugin marketplace add gleanwork/claude-plugins /plugin install glean@glean-plugins ``` +In Claude Desktop or Cowork, open **Customize → Plugins**, add the +`gleanwork/claude-plugins` marketplace, and install **Glean**. + ### 2. Set up Glean -Ask Claude: `Set up Glean for me`. Enter your work email when asked, then -finish signing in in your browser. +In Claude Code, ask Claude: `Set up Glean for me`. Enter your work email when +asked, then finish signing in in your browser. + +Everywhere else, add Glean as a custom connector. ## What's Included @@ -44,14 +71,8 @@ by task — there's no per-skill install. They cover: ## Requirements -- [Claude Code](https://claude.com/claude-code) -- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access - -The plugin's Glean tools run in Claude Code only. In Claude chat, Cowork and -cloud sessions, add Glean as a custom connector instead, using your Glean MCP -server URL (`[server-url]/mcp/[server-name]`, available from your -[Glean admin](https://app.glean.com/admin/about-glean)). +- For Glean tools in Claude Code: [Node.js](https://nodejs.org) 22 or later ## Privacy From 15953813b5d431d7caa890896b6fec54b6f5c32e Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 28 Oct 2026 17:05:27 -0700 Subject: [PATCH 3/4] docs: give the approval relay as the local server's reason The "Why a local server?" section listed sign-in as a reason. The server is there to show Glean's approval prompt on hosts that use MCP versions before 2026-07-28, so say only that. --- overrides/codex/glean/README.md | 10 +++------- overrides/cursor/glean/README.md | 10 +++------- shared/glean/README.md | 10 +++------- 3 files changed, 9 insertions(+), 21 deletions(-) diff --git a/overrides/codex/glean/README.md b/overrides/codex/glean/README.md index 87617d8..eb4f51d 100644 --- a/overrides/codex/glean/README.md +++ b/overrides/codex/glean/README.md @@ -28,13 +28,9 @@ codex mcp login glean ### Why a local server? -It does two things that hosts can't do with Glean yet: - -- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds - yours from your work email and signs you in through your browser. -- **Approval before writes.** Glean asks you to approve tools that change data, - such as sending a message or creating a ticket. Hosts on MCP versions before - 2026-07-28 can't show Glean's prompt, so the local server shows it instead. +Glean asks you to approve tools that change data, such as sending a message or +creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's +prompt, so the plugin's local server shows it instead. ## Setup diff --git a/overrides/cursor/glean/README.md b/overrides/cursor/glean/README.md index 0519cb6..dd3dc1a 100644 --- a/overrides/cursor/glean/README.md +++ b/overrides/cursor/glean/README.md @@ -23,13 +23,9 @@ Cursor's MCP settings. ### Why a local server? -It does two things that hosts can't do with Glean yet: - -- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds - yours from your work email and signs you in through your browser. -- **Approval before writes.** Glean asks you to approve tools that change data, - such as sending a message or creating a ticket. Hosts on MCP versions before - 2026-07-28 can't show Glean's prompt, so the local server shows it instead. +Glean asks you to approve tools that change data, such as sending a message or +creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's +prompt, so the plugin's local server shows it instead. ## Setup diff --git a/shared/glean/README.md b/shared/glean/README.md index 74b0dd2..e3bfb2a 100644 --- a/shared/glean/README.md +++ b/shared/glean/README.md @@ -27,13 +27,9 @@ whichever Glean tools are connected. ### Why a local server? -It does two things that hosts can't do with Glean yet: - -- **Sign-in.** Each Glean instance has its own MCP URL. The local server finds - yours from your work email and signs you in through your browser. -- **Approval before writes.** Glean asks you to approve tools that change data, - such as sending a message or creating a ticket. Hosts on MCP versions before - 2026-07-28 can't show Glean's prompt, so the local server shows it instead. +Glean asks you to approve tools that change data, such as sending a message or +creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's +prompt, so the plugin's local server shows it instead. ## Setup From 23e378b64cc1eb7b91b224ec7a6cdfbd42a5edba Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Wed, 28 Oct 2026 17:07:40 -0700 Subject: [PATCH 4/4] docs: share common plugin README text through partials The Claude, Cursor and Codex plugin READMEs repeated the same "Why a local server?" section, skills list, and Support and License sections. Move each into a pluginpack partial under partials/ and include it with a {{> name}} tag, so the text is edited in one place. The generated output is unchanged: diff -r of dist/ before and after is empty. --- overrides/codex/glean/README.md | 24 +++--------------------- overrides/cursor/glean/README.md | 24 +++--------------------- partials/glean-readme-local-server.md | 5 +++++ partials/glean-readme-skills.md | 7 +++++++ partials/glean-readme-support.md | 9 +++++++++ pluginpack.config.ts | 2 ++ shared/glean/README.md | 24 +++--------------------- 7 files changed, 32 insertions(+), 63 deletions(-) create mode 100644 partials/glean-readme-local-server.md create mode 100644 partials/glean-readme-skills.md create mode 100644 partials/glean-readme-support.md diff --git a/overrides/codex/glean/README.md b/overrides/codex/glean/README.md index eb4f51d..61bd30a 100644 --- a/overrides/codex/glean/README.md +++ b/overrides/codex/glean/README.md @@ -26,11 +26,7 @@ codex mcp add glean --url [server-url]/mcp/[server-name] codex mcp login glean ``` -### Why a local server? - -Glean asks you to approve tools that change data, such as sending a message or -creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's -prompt, so the plugin's local server shows it instead. +{{> glean-readme-local-server}} ## Setup @@ -52,13 +48,7 @@ the bundled skills and Glean tools are available. The plugin ships a library of skills that auto-trigger by task — there's no per-skill install. They cover: -- **Enterprise search & knowledge** — find documents, Slack messages, and email; vet results for freshness and authority. -- **Code across repos** — explore implementations, find usage examples and similar code, identify code owners, and gather architectural context. -- **People & org** — find experts by contribution, and identify stakeholders for a change or project. -- **Meetings** — prep for upcoming meetings and catch up on what you missed. -- **Onboarding & projects** — ramp up on a team or area, read quick project status, and generate comprehensive project handoffs. -- **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. -- **Skill authoring** — discover automation opportunities and generate new skills. +{{> glean-readme-skills}} ## Requirements @@ -75,12 +65,4 @@ The plugin connects only to Glean: - Requests to your Glean instance include the plugin and Codex versions. - Sign-in tokens and caches stay on your computer, in `~/.glean`. -## Support - -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) - -## License - -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}} diff --git a/overrides/cursor/glean/README.md b/overrides/cursor/glean/README.md index dd3dc1a..57fe57f 100644 --- a/overrides/cursor/glean/README.md +++ b/overrides/cursor/glean/README.md @@ -21,11 +21,7 @@ To add your Glean MCP server, put its URL (`[server-url]/mcp/[server-name]`, available from your [Glean admin](https://app.glean.com/admin/about-glean)) in Cursor's MCP settings. -### Why a local server? - -Glean asks you to approve tools that change data, such as sending a message or -creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's -prompt, so the plugin's local server shows it instead. +{{> glean-readme-local-server}} ## Setup @@ -43,13 +39,7 @@ finish signing in in your browser. The plugin ships a library of skills (plus supporting agents and rules) that auto-trigger by task — there's no per-skill install. They cover: -- **Enterprise search & knowledge** — find documents, Slack messages, and email; vet results for freshness and authority. -- **Code across repos** — explore implementations, find usage examples and similar code, identify code owners, and gather architectural context. -- **People & org** — find experts by contribution, and identify stakeholders for a change or project. -- **Meetings** — prep for upcoming meetings and catch up on what you missed. -- **Onboarding & projects** — ramp up on a team or area, read quick project status, and generate comprehensive project handoffs. -- **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. -- **Skill authoring** — discover automation opportunities and generate new skills. +{{> glean-readme-skills}} ## Requirements @@ -66,12 +56,4 @@ The plugin connects only to Glean: - Requests to your Glean instance include the plugin and Cursor versions. - Sign-in tokens and caches stay on your computer, in `~/.glean`. -## Support - -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) - -## License - -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}} diff --git a/partials/glean-readme-local-server.md b/partials/glean-readme-local-server.md new file mode 100644 index 0000000..ac0cc29 --- /dev/null +++ b/partials/glean-readme-local-server.md @@ -0,0 +1,5 @@ +### Why a local server? + +Glean asks you to approve tools that change data, such as sending a message or +creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's +prompt, so the plugin's local server shows it instead. diff --git a/partials/glean-readme-skills.md b/partials/glean-readme-skills.md new file mode 100644 index 0000000..e6aba80 --- /dev/null +++ b/partials/glean-readme-skills.md @@ -0,0 +1,7 @@ +- **Enterprise search & knowledge** — find documents, Slack messages, and email; vet results for freshness and authority. +- **Code across repos** — explore implementations, find usage examples and similar code, identify code owners, and gather architectural context. +- **People & org** — find experts by contribution, and identify stakeholders for a change or project. +- **Meetings** — prep for upcoming meetings and catch up on what you missed. +- **Onboarding & projects** — ramp up on a team or area, read quick project status, and generate comprehensive project handoffs. +- **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. +- **Skill authoring** — discover automation opportunities and generate new skills. diff --git a/partials/glean-readme-support.md b/partials/glean-readme-support.md new file mode 100644 index 0000000..a1142c6 --- /dev/null +++ b/partials/glean-readme-support.md @@ -0,0 +1,9 @@ +## Support + +- [Glean MCP Documentation](https://docs.glean.com/mcp) +- [Glean Support](https://help.glean.com) +- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) + +## License + +MIT — see [LICENSE](LICENSE) for details. diff --git a/pluginpack.config.ts b/pluginpack.config.ts index 49be212..27ef337 100644 --- a/pluginpack.config.ts +++ b/pluginpack.config.ts @@ -7,6 +7,8 @@ const gleanPluginDescription = export default defineConfig({ name: "glean-plugins", version: pkg.version, + // Shared README text, included with {{> name}} tags. + source: { partials: "partials" }, metadata: { author: { name: "Glean", diff --git a/shared/glean/README.md b/shared/glean/README.md index e3bfb2a..f8056d9 100644 --- a/shared/glean/README.md +++ b/shared/glean/README.md @@ -25,11 +25,7 @@ For a custom connector, use your Glean MCP server URL [Glean admin](https://app.glean.com/admin/about-glean)). The skills use whichever Glean tools are connected. -### Why a local server? - -Glean asks you to approve tools that change data, such as sending a message or -creating a ticket. Hosts on MCP versions before 2026-07-28 can't show Glean's -prompt, so the plugin's local server shows it instead. +{{> glean-readme-local-server}} ## Setup @@ -57,13 +53,7 @@ Everywhere else, add Glean as a custom connector. The plugin ships a library of skills (plus supporting agents) that auto-trigger by task — there's no per-skill install. They cover: -- **Enterprise search & knowledge** — find documents, Slack messages, and email; vet results for freshness and authority. -- **Code across repos** — explore implementations, find usage examples and similar code, identify code owners, and gather architectural context. -- **People & org** — find experts by contribution, and identify stakeholders for a change or project. -- **Meetings** — prep for upcoming meetings and catch up on what you missed. -- **Onboarding & projects** — ramp up on a team or area, read quick project status, and generate comprehensive project handoffs. -- **Personal productivity** — summarize your own activity, prep status updates, and surface what needs your attention. -- **Skill authoring** — discover automation opportunities and generate new skills. +{{> glean-readme-skills}} ## Requirements @@ -82,12 +72,4 @@ The plugin connects only to Glean: - Sign-in tokens and caches stay on your computer, in Claude Code's plugin data folder or `~/.glean`. -## Support - -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) - -## License - -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}}