diff --git a/overrides/claude/root/README.md b/overrides/claude/root/README.md index c344e06..50cd9d9 100644 --- a/overrides/claude/root/README.md +++ b/overrides/claude/root/README.md @@ -8,15 +8,41 @@ 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 Desktop, chat and Cowork + +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. -## ⚠️ 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 + +- A Glean account with MCP access +- 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) 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 +86,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..61bd30a 100644 --- a/overrides/codex/glean/README.md +++ b/overrides/codex/glean/README.md @@ -1,7 +1,32 @@ # 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. + +## Where it works + +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 +``` + +{{> glean-readme-local-server}} ## Setup @@ -14,34 +39,30 @@ 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 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 - [Codex](https://developers.openai.com/codex) with plugin support +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access -## Support +## Privacy -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) +The plugin connects only to Glean: -## License +- 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`. -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}} 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..57fe57f 100644 --- a/overrides/cursor/glean/README.md +++ b/overrides/cursor/glean/README.md @@ -1,7 +1,27 @@ # 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. + +## 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. + +{{> glean-readme-local-server}} ## Setup @@ -11,38 +31,29 @@ 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 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. - -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`). +{{> glean-readme-skills}} ## Requirements - [Cursor](https://cursor.com) (latest version) +- [Node.js](https://nodejs.org) 22 or later - A Glean account with MCP access -## Support +## Privacy -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) +The plugin connects only to Glean: -## License +- 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`. -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}} 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/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-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..f8056d9 100644 --- a/shared/glean/README.md +++ b/shared/glean/README.md @@ -1,56 +1,75 @@ # Glean -Official Glean plugin for supported AI hosts — enterprise search, code -exploration, and people discovery in your development workflow. +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. + +## Where it works + +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. + +{{> glean-readme-local-server}} ## 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. +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 -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. +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 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. - -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. +{{> glean-readme-skills}} ## Requirements -- A current supported AI host that supports plugins and MCP - 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)) +- For Glean tools in Claude Code: [Node.js](https://nodejs.org) 22 or later -## Support +## Privacy -- [Glean MCP Documentation](https://docs.glean.com/mcp) -- [Glean Support](https://help.glean.com) -- [GitHub Issues](https://github.com/gleanwork/agent-plugins/issues) +The plugin connects only to Glean: -## License +- 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`. -MIT — see [LICENSE](LICENSE) for details. +{{> glean-readme-support}}