@devries-cameron20 / composio Mirror · read-only / commits / cf5d57bcc
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 04:45 UTC

docs: link Gmail parameter guidance to its schema catalog (DEVREL-312) (#5379)

> Written by an AI agent on behalf of Brendan O'Leary, following his spec. Brendan has not reviewed it yet. ## Summary The Gmail KB guide discusses send parameters without linking readers to the public tool schema. Add that link where readers prepare a send call, so they can check actual tool slugs and parameter tables. Related issue: [DEVREL-312: Tool slugs and schemas hard to confirm](https://linear.app/composio/issue/DEVREL-312/tool-slugs-and-schemas-hard-to-confirm). Designated reviewer: @jkomyno. The historical `/tools/gmail` route already redirects to the current catalog and supports Markdown negotiation. This PR adds the missing KB link; it does not change routing or tool schemas. The framework landing-page update is being handled separately in `ComposioHQ/landing`. ## Changes - Link the Gmail KB's send section to `/toolkits/gmail.md` in its maintained article and regenerated MDX page. - Keep the catalog as the schema source instead of adding another copy of its fields. | Reader action | Base branch | This branch | | --- | --- | --- | | Read the Gmail KB's send-parameters section | No catalog link in that section | Direct link to the public Markdown catalog | ## Type of change - [ ] Bug fix - [ ] New feature - [ ] Refactor/Chore - [x] Documentation - [ ] Breaking change ## How Has This Been Tested? From `docs/`, using existing dependencies without installing packages: - `bun test tests/static/kb-generation.test.ts tests/static/markdown-negotiation.test.ts`: 23 passed, 0 failed. - `bun run check:kb`: passed, 124 published guides and 127 generated files are current. - `bun run lint`: passed with existing warnings in unrelated files. - Rendered the generated Gmail MDX with `@mdx-js/mdx` and React server rendering: the catalog link becomes an HTML anchor pointing at `/toolkits/gmail.md`. - `git diff --check`: passed. - `bun run lint:links`: blocked by `Cannot find module 'fumadocs-mdx:collections/server'` in this checkout. No dependency installation or `next build` was run. Direct production HTTP checks returned 200 for the canonical catalog and all three legacy Markdown forms: `/tools/gmail` with `Accept: text/markdown` or `text/plain`, and `/tools/gmail.md`. All returned the same body SHA-256 as `/toolkits/gmail.md`, including `GMAIL_SEND_EMAIL`, the parameter-table header, and the `recipient_email` row. An HTML request retained the toolkit UI. These checks verify existing production behavior, not deployment of this PR. ### Gauge replay Ran one pass with Gauge CLI 0.26.0, organization `f4ab0a1b-9d09-4f8f-b67d-320922b81aef`, optimization `cmwf3mubd005z01l55mlph03l`, launch `cmwf3n21v004701lvpof20gax`. All three reruns retained the source prompt, harness/model, and eval revision `bdb13b1a16e2`. The launch reported `changed: []`; no page overrides, branch content, or extra task instructions were injected. Gauge warned that the sources have no recorded inference, so these are fresh reruns rather than exact continuations. | Source session | Rerun | Result at the three-minute bound | Recorded page/schema exposure | | --- | --- | --- | --- | | `cmvtk2xiq000201fyyw2nuijf` | `cmwf3n22n004901lvz4q8n1yq` | Running at bound, subsequently canceled | No fetched pages; no target URL or schema-table markers in captured trace | | `cmvfzamhp00af01nuk6r5zmkm` | `cmwf3n242004c01lvdun6kqj6` | Running at bound, subsequently canceled | One search, no fetched pages; no target URL or schema-table markers in captured trace | | `cmvtk2xiq000701fy1r1gp2v0` | `cmwf3n25o004f01lvo1bw7xvg` | Finished and analyzed | Three searches, no fetched pages; no target URL or schema-table markers in captured trace | `optimizations watch --timeout 3` ended with 1/3 finished and analyzed. Cancellation was requested once for each unfinished run and both reached `CANCELED`; no second launch or watch loop was started. Checked each run with `run web` and inspected its captured raw trace for `docs.composio.dev/tools/gmail`, `docs.composio.dev/toolkits/gmail`, `/kb/guide/toolkits-gmail`, the parameter-table header, and the `recipient_email` table row. None appeared. The two stopped runs provide incomplete evidence only. Gauge also judged their partial work: the Claude run received three failures and one ungraded criterion; the other Codex run received one pass, two failures, and one ungraded criterion. These canceled-run grades are not completed-run comparisons. The completed run received one passing criterion and three failing criteria: the judge passed implementation completeness, but failed SDK API usage, runtime tool selection, and avoidance of a hard-coded tool. Relative to that source's verdicts, SDK usage changed from pass to fail; the other verdicts stayed the same. Findings include a mis-keyed session `tools` configuration, hard-coded Gmail routing, a Node engine mismatch, and no live send without credentials. It also recovered from deprecated auth and type-file discovery friction. These are baseline observations, not findings attributable to this PR. The original schema complaint was not emitted in the completed run, but that run never read the catalog or the changed guide. **No exact target URL/schema-table exposure was established, no original finding is marked resolved, and no improvement or absence of new material findings is claimed.** This branch is not deployed, so the pass cannot test its added KB link; at most it checks baseline discovery. ## Screenshots (if applicable) No layout changes. The before/after link comparison and rendered-anchor check above cover this prose-only edit. ## Checklist - [ ] I have read the Code of Conduct and this PR adheres to it - [x] I have read and understand every line of this diff, including any LLM-generated code - [x] Any third-party docs links or promotional content follow the third-party links policy - [ ] I ran linters/tests locally and they passed - [x] I updated documentation as needed - [x] I added tests or explain why not applicable - [ ] I added a changeset if this change affects published packages The agent inspected the complete four-line addition. The author should review the full diff before merge. New tests and a changeset are unnecessary for a prose link; existing rendering/generation checks were used. The combined checks box remains unchecked because link lint could not run successfully. ## Additional context In plain terms: the troubleshooting guide now points to the page that lists the real tool names and fields. Readers can check those fields before writing a call. A passing agent-behavior result for the new link still requires exposure to the deployed change.

Brendan O'Leary committed Nov 13, 2026 at 10:21 UTC cf5d57bcc2cebd9b2c496291d87f8b1fa0c8fe1e
2 files changed +4
docs/content/kb/guide/toolkits-gmail.mdx
+2
@@ -30,6 +30,8 @@ The Gmail metadata scope cannot be used when requesting full email content. Remo
30
31 ## Address and send Gmail messages
32
33 +Check tool slugs and input parameter tables in the [Gmail toolkit catalog](/toolkits/gmail.md) before writing a tool call.
34 +
35 **Use `me` for the authenticated user.** For Gmail tool calls, `me` can be used as the `user_id` to refer to the authenticated connected account.
36
37 **Provide at least one recipient channel.** `GMAIL_SEND_EMAIL` no longer needs a single required recipient field. At least one recipient channel such as `to` / `recipient_email`, `cc`, or `bcc` can be supplied, which keeps the tool flexible for different email composition flows.
docs/kb/articles/toolkits-gmail.md
+2
@@ -18,6 +18,8 @@ The Gmail metadata scope cannot be used when requesting full email content. Remo
18
19 ## Address and send Gmail messages
20
21 +Check tool slugs and input parameter tables in the [Gmail toolkit catalog](/toolkits/gmail.md) before writing a tool call.
22 +
23 **Use `me` for the authenticated user.** For Gmail tool calls, `me` can be used as the `user_id` to refer to the authenticated connected account.
24
25 **Provide at least one recipient channel.** `GMAIL_SEND_EMAIL` no longer needs a single required recipient field. At least one recipient channel such as `to` / `recipient_email`, `cc`, or `bcc` can be supplied, which keeps the tool flexible for different email composition flows.