Open
Conversation
Avinash-Kamath
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
Contributor
WalkthroughAdds comprehensive setup and usage documentation to nine Google agent connector pages: imports image assets, adds OAuth redirect-URI and OAuth client configuration steps, API enablement and credentials guidance with screenshots, and includes language-specific usage examples (Python active, Node.js commented). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 25
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/reference/agent-connectors/gmail.mdx`:
- Around line 165-237: Wrap the happy-path SDK calls in a try/catch (or
try/except) to demonstrate error handling: surround the authentication call
(connectedAccounts.getMagicLinkForConnectedAccount in Node and
actions.get_authorization_link in Python) and the proxy request
(actions.request) with error handling that logs/prints the error and
returns/handles failure gracefully; ensure the catch/except shows how to extract
and display the error message and status so readers know how to surface SDK
errors.
- Around line 202-236: Add a title attribute to the Python fenced code block
that starts with "```python" (the block containing import scalekit.client,
ScalekitClient and the actions.request example) so it becomes e.g. ```python
title="example.py"; this keeps code-blocks consistent with other docs and helps
readers identify the example file.
- Around line 167-199: Update the fenced TypeScript code block in the Gmail
connector docs (the triple-backtick block that begins with "```typescript") to
include a title attribute such as title="example.ts" (or another contextual
filename) so the block follows the code block convention; edit the code block
header in src/content/docs/reference/agent-connectors/gmail.mdx to change
```typescript to ```typescript title="example.ts".
- Around line 241-313: Remove the duplicated 3-column table blocks for the Gmail
tools (gmail_fetch_mails, gmail_get_attachment_by_id, gmail_get_contacts,
gmail_get_message_by_id, gmail_list_drafts, gmail_search_people) that appear
before the correct auto-generated 4-column sections and delete the entire
repeated chunk (the block using "Properties | Description | Type" with "| null"
appended); keep only the properly formatted 4-column "Name | Type | Required |
Description" tool documentation that follows to resolve the duplication and
formatting inconsistency.
In `@src/content/docs/reference/agent-connectors/google_ads.mdx`:
- Around line 157-189: The TypeScript fenced code blocks (the samples that
create a ScalekitClient and call
connectedAccounts.getMagicLinkForConnectedAccount and actions.request using
connectionName and identifier) are missing the required title metadata; update
each fenced block to include a title attribute (e.g. ```typescript
title="path/to/file.ts"```) showing the file path/name so both the block
containing ScalekitClient/connectedAccounts and the second block (the one later
in the file that also demonstrates actions.request) include title="..." per the
documentation guideline.
- Around line 100-120: The Steps block is using plain numbered list items
instead of the repo-required step-heading format; update each step inside the
<Steps> component (including the other Steps blocks in this file) to use the "1.
## Step title" pattern and indent all step body content by exactly 3 spaces;
locate the block starting with the <Steps> tag and replace each numeric line
(e.g., "1. In Scalekit dashboard...") with a heading-style entry like "1. ##
<concise title>" and ensure the explanatory lines (images, links, and
subsections) are indented by three spaces consistently for parsing/styling by
the Steps renderer.
- Around line 157-225: Update both SDK snippets to include explicit error
handling and a short security rationale: wrap the authorization/link and proxy
request calls in try/catch (JS: around
connectedAccounts.getMagicLinkForConnectedAccount and actions.request) and
try/except (Python: around actions.get_authorization_link and actions.request),
log or surface errors cleanly, and ensure you do not print or persist secrets or
tokens; also add a concise security comment near ScalekitClient and the
authorization link usage describing the threat (exposing OAuth links or tokens,
replay/CSRF risks when presenting links, and proxying sensitive API requests),
why validating identifiers and using secure transport is required, and what can
go wrong if omitted (unauthorized access or leaked credentials).
- Around line 155-227: Add two new TabItem blocks labeled "Go" and "Java"
mirroring the Node.js/Python examples: use the variable name scalekitClient (not
ScalekitClient) in both, show retrieving an authorization link (use the
language-appropriate method on scalekitClient.actions, analogous to
connectedAccounts.getMagicLinkForConnectedAccount /
actions.get_authorization_link) with connectionName/identifier variables, prompt
for user authorization, then call scalekitClient.actions.request (or the
SDK-equivalent request method) to GET "/v17/customers" and print the result;
ensure the Go and Java snippets follow the same variable names (connectionName,
identifier, scalekitClient) and overall flow as the existing examples.
In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx`:
- Line 99: Update the MDX subsection headings in
src/content/docs/reference/agent-connectors/googlecalendar.mdx to use sentence
case: change "Configure Redirect URL" to "Configure redirect URL", "Enable
Google Calendar API" (ensure only the first word is capitalized and keep "API"
uppercase), and "Add Credentials" to "Add credentials"; apply these exact string
changes at the headings referenced (including the other occurrences noted around
the file at the indicated areas).
- Around line 160-232: The doc currently uses <Tabs syncKey="tech-stack"> with
only TabItem label="Node.js" and label="Python"; add TabItem entries for
label="Go" and label="Java" to match standards, and within each language tab
extend the snippets to show both the authorization-link flow and a request call
with explicit success and error handling (for Node.js reference
connectedAccounts.getMagicLinkForConnectedAccount and actions.request, for
Python reference actions.get_authorization_link and actions.request; for Go/Java
use the equivalent Scalekit client methods), ensuring each tab logs or returns a
success path and catches/logs errors for the authorization and request steps.
In `@src/content/docs/reference/agent-connectors/googledocs.mdx`:
- Around line 100-120: The Steps block uses plain numbered list items instead of
the required step-title pattern; update each step inside the <Steps> component
to follow the exact "1. ## Title" pattern and ensure all step body lines are
indented with exactly three spaces; specifically transform the current numbered
lines (e.g., "1. In Scalekit dashboard..." and subsequent items) into titled
steps like "1. ## <Short Title>" followed by the step content on the next line
with 3-space indentation, and apply this change to every <Steps> instance in the
file (including the other block noted around lines 126–149) so every step
matches the repo guideline.
- Around line 157-225: Update both the TypeScript and Python examples to include
explicit error handling and security commentary: validate env vars and fail-fast
if SCALEKIT_* are missing, wrap the auth flow (ScalekitClient construction and
connectedAccounts.getMagicLinkForConnectedAccount /
actions.get_authorization_link) in try/catch (or try/except) and handle/log
errors without leaking secrets, check the magic/link response for expected
fields before printing, add guidance comments about threats (exposed client
secrets, phishing links, token theft) and required mitigations (do not log
secrets, use secure storage, implement token refresh/revocation), and wrap
actions.request calls in error handling to surface HTTP/SDK errors and show safe
retry/fallback behavior; reference ScalekitClient,
connectedAccounts.getMagicLinkForConnectedAccount,
actions.get_authorization_link, and actions.request when making these changes.
- Around line 155-227: Add two additional TabItem entries labeled "Go" and
"Java" inside the existing <Tabs syncKey="tech-stack"> so all four SDK examples
are present; each new tab should mirror the Node.js/Python flow: initialize the
Scalekit client with the same credentials pattern (matching process/env usage
shown), call the connector authorization link method (analogous to
connectedAccounts.getMagicLinkForConnectedAccount /
actions.get_authorization_link) using connectionName and identifier, wait for
user authorization, then call the proxy request method (analogous to
actions.request) to GET "/docs/v1/documents"; keep the same variable names
(connectionName, identifier, actions/request) and ensure TabItem labels and
syncKey remain unchanged.
In `@src/content/docs/reference/agent-connectors/googledrive.mdx`:
- Around line 155-227: Add missing Go and Java tabs and include file title
attributes: update the <Tabs syncKey="tech-stack"> block so it contains four
<TabItem> entries (labels "Node.js", "Python", "Go", "Java"); for the existing
Node.js and Python code fences, add title attributes (e.g., ```typescript
title="app.ts" and ```python title="main.py"); add new TabItem blocks for Go and
Java with appropriate code fences (```go title="main.go" and ```java
title="App.java") that follow the same SDK usage pattern as the Node.js/Python
examples (authenticate via connectedAccounts/get_authorization_link and call
actions.request/actions.request equivalent).
In `@src/content/docs/reference/agent-connectors/googleforms.mdx`:
- Line 74: Remove the unused imports from the Starlight components import line:
drop Code (and also remove Card and CardGrid since they are not used in this
file) from the import statement that currently reads "import { Card, CardGrid,
Tabs, TabItem, Badge, Steps, Aside, Code } from
'@astrojs/starlight/components'"; leave only the components actually used (e.g.,
Tabs, TabItem, Badge, Steps, Aside) to eliminate the unused-import warning.
- Line 75: Remove the unused import of Accordion and AccordionItem from the
import statement that currently reads "import { Accordion, AccordionItem } from
'accessible-astro-components'"; either delete the entire import line if nothing
else is imported from 'accessible-astro-components' or remove Accordion and
AccordionItem from the named imports so there are no unused symbols.
- Line 98: The headings use title case; change them to sentence case so only the
first word and proper nouns are capitalized. Update the heading "Configure
Redirect URL" to "Configure redirect URL" and make the same sentence-case
adjustment for the other two headings referenced (lines 124 and 136) while
preserving proper nouns like "Google Forms API" as-is; search for those exact
heading strings in the file (e.g., "Configure Redirect URL") and replace with
their sentence-case equivalents.
- Around line 155-227: The docs are missing Go and Java usage tabs, lack error
handling in Node.js/Python examples, and code blocks need title attributes; add
two new TabItem entries labeled "Go" and "Java" that mirror the Node.js/Python
flows (authenticate via a magic link/authorization link and then call
actions.request / actions.request(...) equivalents), include try/catch (Node:
around connectedAccounts.getMagicLinkForConnectedAccount and actions.request)
and try/except (Python: around actions.get_authorization_link and
actions.request) showing success and error paths, and add title="index.ts" to
the Node block and title="main.py" to the Python block (and appropriate titles
for Go/Java like "main.go"/"Main.java"); reference existing symbols
ScalekitClient, connectedAccounts.getMagicLinkForConnectedAccount,
actions.request, and actions.get_authorization_link when inserting the error
handling and new examples.
In `@src/content/docs/reference/agent-connectors/googlemeet.mdx`:
- Around line 155-227: Add missing Go and Java TabItem blocks and enhance each
language example (Node.js: ScalekitClient,
connectedAccounts.getMagicLinkForConnectedAccount, actions.request; Python:
scalekit.client.ScalekitClient, actions.get_authorization_link, actions.request)
to include a title attribute on the fenced code block (e.g.,
title="app.ts"/"app.py"), explicit success and error paths (try/catch or error
handling branches) showing handling of HTTP/auth errors, and brief comments near
the OAuth magic-link steps describing threats mitigated (e.g., token leakage,
CSRF) and recommended protections; replicate equivalent patterns for Go and Java
SDK usage (initialize client, get authorization link, wait for user, perform
actions.request) with both success and error handling in each TabItem.
In `@src/content/docs/reference/agent-connectors/googlesheets.mdx`:
- Around line 155-227: The SDK docs currently only have Node.js and Python
TabItem blocks and show only the happy path; add TabItem blocks for Go and Java
and update each language example (Node.js: ScalekitClient,
connectedAccounts.getMagicLinkForConnectedAccount, actions.request; Python:
scalekit.client.ScalekitClient, actions.get_authorization_link, actions.request)
to include explicit success and error handling (try/catch or conditional checks,
logging of errors, and graceful failure paths) and include brief security
comments about storing/handling SCALEKIT_CLIENT_ID, SCALEKIT_CLIENT_SECRET and
env URL (do not print secrets, use env vars, validate inputs). Ensure the new Go
and Java snippets mirror the same flow (create client, get authorization link,
wait for auth, request via actions) and include equivalent success/error
handling and security notes.
- Around line 100-120: The <Steps> block uses plain numbered list items instead
of the required "1. ## <Action title>" heading format and inconsistent
indentation; update each step inside the <Steps> block (including other
occurrences around lines 126-134 and 138-149) so the first line of each step is
"1. ## <Action title>" and every subsequent line of that step (including
paragraph text and image lines like useOwnCredentialsImg.src,
oauthWebAppImg.src, addRedirectUriImg.src) is indented by exactly three spaces;
ensure the numbered-heading format is applied to all steps and maintain
consistent 3-space indentation for correct parsing and rendering.
- Around line 77-79: The googlesheets docs import images from the Gmail asset
folder (symbols oauthWebAppImg, addRedirectUriImg, addCredentialsImg in
src/content/docs/reference/agent-connectors/googlesheets.mdx); move those image
files into a Google Sheets or shared Google OAuth asset directory (e.g.,
assets/docs/agent-connectors/googlesheets or
assets/docs/agent-connectors/google-oauth), update the three imports in
googlesheets.mdx to point to the new paths, and remove any remaining
cross-connector references; also search for other docs that import the same
gmail assets and update them to the shared/google-sheets asset location to avoid
coupling.
- Line 98: Update the subsection headings to use sentence case: change the
heading "Configure Redirect URL" to "Configure redirect URL" and change "Add
Credentials" to "Add credentials"; verify "Enable Google Sheets API" follows
sentence case formatting and adjust if needed; ensure all instances of these
headings in the file (the headings with text "Configure Redirect URL", "Enable
Google Sheets API", and "Add Credentials") are updated for consistent
sentence-case styling.
In `@src/content/docs/reference/agent-connectors/googleslides.mdx`:
- Around line 101-121: The Steps component currently uses plain numbered list
items; update each numbered item to the required numbered-heading format by
converting lines like "1. In [Scalekit dashboard]..." into "1. ## In Scalekit
dashboard" and ensure every block of step content (including images and subtext
referencing useOwnCredentialsImg, oauthWebAppImg, addRedirectUriImg, and the
redirect URI example) is indented with exactly three spaces on each line beneath
its step heading; apply this pattern consistently for all steps currently inside
the Steps component (including the entries around the existing redirect URI,
image tags, and steps that span lines noted in the comment) so parsing/rendering
follows the repo guideline.
- Around line 156-228: The docs currently only show Node.js and Python
success-only examples inside the Tabs/TabItem block (using ScalekitClient,
connectedAccounts.getMagicLinkForConnectedAccount, actions.request and
actions.get_authorization_link); add two additional TabItem blocks for Go and
Java with equivalent SDK usage examples, and update every language snippet to
include both a clear success path and explicit error handling (try/catch or
error return checks) around the authentication flow and actions.request call so
failures log/return error details; ensure the Go/Java snippets use the correct
client constructors and methods analogous to ScalekitClient and actions.request
so readers can follow the same authorization + request + error handling pattern.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (16)
src/assets/docs/agent-connectors/gmail/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/add-redirect-uri.gifis excluded by!**/*.gifsrc/assets/docs/agent-connectors/gmail/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/connect-google-app.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/enable-gmail-api.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/oauth-web-app.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/gmail/use-own-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_ads/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_docs/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_drive/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_forms/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_meets/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/google_sheets/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecalendar/use-own-credentials-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googleslides/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (9)
src/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (3)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
🧠 Learnings (20)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:12.772Z
Learning: For agent connector documentation files under src/content/docs/reference/agent-connectors/, prefer CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) for connector logo images rather than storing them locally in src/assets/docs/. This differs from the general guideline to use local assets.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-02-25T18:40:05.360Z
Learning: Journey-Focused Documentation: Product-based documentation (MCP Auth, Agent Auth, Full Stack Auth, Modular SCIM, Modular SSO) MUST follow a journey-focused approach representing a developer's journey toward implementing authentication
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
📚 Learning: 2026-02-26T07:21:32.951Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:32.951Z
Learning: For agent-connectors reference MDX files, use H2 headings (##) for tool sections (e.g., googlesheets_create_spreadsheet, googlesheets_get_values) so they appear in the table of contents. This is a deliberate UX choice and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-26T07:22:49.128Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:49.128Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Do not manually edit the generated MDX files. Update scripts/sync-agent-connectors.js to output a four-column table with headers Name | Type | Required | Description for all parameter tables, ensuring consistency with the coding guidelines. This pattern should apply to all MDX files in that directory.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-26T07:21:09.133Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:82-82
Timestamp: 2026-02-26T07:21:09.133Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, prefer using CDN URLs for connector logos (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/) instead of inlining or storing images in local assets (e.g., src/assets/docs/). This should override the general guideline to use local assets for this specific docs section. Apply this pattern to all mdx files in that directory; use the CDN-hosted logo URLs in image elements or logo references.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-26T07:23:24.179Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:24.179Z
Learning: Do not enforce the 160-character description limit for MDX files under src/content/docs/reference/agent-connectors/. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may contain longer descriptions sourced from the data.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-26T07:20:42.107Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:42.107Z
Learning: In src/content/docs/reference/agent-connectors/**, these auto-generated agent connector reference pages (e.g., googlemeet.mdx) are lookup resources. Do not require or enforce the 'what's next' signal (next link, LinkCard, or concluding paragraph) for these pages; treat them as non-sequential references produced by scripts (scripts/sync-agent-connectors.js).
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-26T07:18:41.518Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:41.518Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, the sidebar.label frontmatter is not required because navigation is auto-generated from this directory via the central sidebar config. Do not rely on or modify sidebar.label in these files; ensure ordering and grouping are defined in the shared sidebar configuration.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for organized content presentation in MDX documentation
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use CardGrid, Card, and LinkCard components for hubs and navigation pages in MDX documentation
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-25T18:40:05.360Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-02-25T18:40:05.360Z
Learning: Follow Astro + Starlight framework conventions, maintain compatibility with Tailwind CSS styling, and ensure Vue 3 and React component compatibility
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to astro.config.mjs : Expressive Code is configured in `astro.config.mjs` with themes 'tokyo-night' (dark) and 'light-plus' (light), JetBrains Mono font, and border radius 0.375rem
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
📚 Learning: 2026-01-13T12:48:19.565Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-01-13T12:48:19.565Z
Learning: Applies to **/*.mdx : Import `{ Code }` from `astrojs/starlight/components` once per `.mdx` file, placing the import below frontmatter
Applied to files:
src/content/docs/reference/agent-connectors/googlecalendar.mdx
📚 Learning: 2026-02-02T05:55:51.251Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/native-app.mdx:72-179
Timestamp: 2026-02-02T05:55:51.251Z
Learning: In the `src/content/docs/authenticate/fsa/multiapp/` directory, the multi-app authentication documentation (native-app.mdx, single-page-app.mdx, web-app.mdx, overview.mdx) currently uses conceptual shell/curl examples instead of multi-language SDK code examples because the Scalekit SDKs have not yet been built/updated for multi-app functionality. Once the SDKs are ready, these files should be updated to include all 4 languages (Node.js, Python, Go, Java) using `<Tabs syncKey="tech-stack">`.
Applied to files:
src/content/docs/reference/agent-connectors/googledocs.mdx
📚 Learning: 2026-02-25T18:40:05.360Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-02-25T18:40:05.360Z
Learning: Applies to src/content/docs/guides/integrations/**/*.mdx : Integration guides located in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages at `sso-integrations/index.mdx`, `social-connections/index.mdx`, and `scim-integrations/index.mdx`
Applied to files:
src/content/docs/reference/agent-connectors/gmail.mdx
🔇 Additional comments (10)
src/content/docs/reference/agent-connectors/googlemeet.mdx (2)
92-149: LGTM!The Setup section is well-structured with proper use of
Stepscomponents, clear navigation paths using bold formatting, and appropriate use of theAsidecomponent for the Google verification caution. Images include descriptive alt text.
76-79: LGTM!Appropriate reuse of shared Google OAuth setup images from the gmail connector, with a connector-specific image for the redirect URI configuration. CDN URL correctly used for the logo per repository conventions.
src/content/docs/reference/agent-connectors/googledrive.mdx (3)
229-269: LGTM!The tool reference sections correctly use H2 headings (intentional for TOC navigation per project conventions) and include properly formatted parameter tables with the required Name | Type | Required | Description columns.
92-149: LGTM!The Setup section is well-structured with:
- Appropriate
<Aside type="caution">for the Google verification warning- Clear
<Steps>components for sequential instructions- Descriptive alt text on all images
- Sentence case headings
76-79: Image asset paths are correctly intentional.All referenced images exist and are properly reused. Lines 77–79 import Gmail OAuth setup screenshots (oauth-web-app.png, add-redirect-uri.png, add-credentials.png) because Google Drive and Gmail share the same OAuth flow — no Google Drive-specific versions of these screenshots are needed. This pattern matches other connector documentation (e.g., googlesheets.mdx).
src/content/docs/reference/agent-connectors/gmail.mdx (2)
82-89: LGTM — CDN URL for logo is correct.Using the CDN URL (
https://cdn.scalekit.com/sk-connect/assets/provider-icons/gmail.svg) follows the established pattern for agent connector documentation. Based on learnings, agent connector docs should prefer CDN URLs over local assets.
94-159: Setup section is well-structured.The Setup section follows good documentation patterns: uses
<Steps>for sequential instructions, includes<Aside>for important notes, and provides clear visual guidance with screenshots. The heading hierarchy is appropriate for agent connector reference pages.src/content/docs/reference/agent-connectors/googlecalendar.mdx (1)
236-351:⚠️ Potential issue | 🟠 MajorRemove the duplicated legacy tool block and keep one canonical table set
The tool sections are duplicated, and the first set uses malformed table structure (3-column header with 4-cell rows). Keep only one set (the 4-column
Name | Type | Required | Descriptiontables) to prevent conflicting docs and broken rendering semantics.Suggested cleanup (remove legacy duplicate block)
-## `googlecalendar_create_event` -... -| Properties | Description | Type | -| --- | --- | --- | -| `attendees_emails` | Attendee email addresses | `array<string>` | null | -... -## `googlecalendar_update_event` -... -| `visibility` | Visibility of the event | string | null | +<!-- Removed duplicate legacy tool tables. Keep the canonical 4-column tables below. -->Based on learnings: parameter tables in
src/content/docs/reference/agent-connectors/**are generated viascripts/sync-agent-connectors.jsand should consistently useName | Type | Required | Description.Also applies to: 352-467
⛔ Skipped due to learnings
Learnt from: saif-at-scalekit Repo: scalekit-inc/developer-docs PR: 448 File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131 Timestamp: 2026-02-26T07:21:37.207Z Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.Learnt from: saif-at-scalekit Repo: scalekit-inc/developer-docs PR: 448 File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141 Timestamp: 2026-02-26T07:22:55.583Z Learning: For MDX files under src/content/docs/reference/agent-connectors/, the parameter tables (showing tool properties) are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Any table format corrections must be made in the generation script, not by manually editing the generated MDX files. The script should be updated to output the required "Name | Type | Required | Description" four-column table format per coding guidelines.Learnt from: saif-at-scalekit Repo: scalekit-inc/developer-docs PR: 448 File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87 Timestamp: 2026-02-26T07:20:46.903Z Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.Learnt from: saif-at-scalekit Repo: scalekit-inc/developer-docs PR: 448 File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3 Timestamp: 2026-02-26T07:23:27.672Z Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.src/content/docs/reference/agent-connectors/googleslides.mdx (2)
95-97: Good placement of a caution callout before OAuth verification steps.This improves task safety and context at the right point in the flow.
As per coding guidelines: "Use Aside component for notes, warnings, and tips in MDX documentation."
77-79: No action needed—Gmail image imports are intentional and shared across all Google connectors.The
oauth-web-app.png,add-redirect-uri.png, andadd-credentials.pngimages are reused across 8 Google connector reference pages (Slides, Sheets, Meets, Forms, Drive, Docs, Ads, Calendar) because they all follow the same Google OAuth setup flow. Consolidating these assets in thegmail/directory avoids duplication and maintains a single source of truth for the standard OAuth configuration steps.
Comment on lines
155
to
227
| <Tabs syncKey="tech-stack"> | ||
| <TabItem label="Node.js"> | ||
| ```typescript | ||
| import { ScalekitClient } from '@scalekit-sdk/node'; | ||
| import 'dotenv/config'; | ||
|
|
||
| const connectionName = 'google_ads'; // get your connection name from connection configurations | ||
| const identifier = 'user_123'; // your unique user identifier | ||
|
|
||
| // Get your credentials from app.scalekit.com → Developers → Settings → API Credentials | ||
| const scalekit = new ScalekitClient( | ||
| process.env.SCALEKIT_ENV_URL, | ||
| process.env.SCALEKIT_CLIENT_ID, | ||
| process.env.SCALEKIT_CLIENT_SECRET | ||
| ); | ||
| const { connectedAccounts, actions } = scalekit; | ||
|
|
||
| // Authenticate the user | ||
| const { link } = await connectedAccounts.getMagicLinkForConnectedAccount({ | ||
| connector: connectionName, | ||
| identifier, | ||
| }); | ||
| console.log('🔗 Authorize Google Ads:', link); // present this link to your user for authorization, or click it yourself for testing | ||
| process.stdout.write('Press Enter after authorizing...'); | ||
| await new Promise(r => process.stdin.once('data', r)); | ||
|
|
||
| // Make a request via Scalekit proxy | ||
| const result = await actions.request({ | ||
| connectionName, | ||
| identifier, | ||
| path: '/v17/customers', | ||
| method: 'GET', | ||
| }); | ||
| console.log(result); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem label="Python"> | ||
| ```python | ||
| import scalekit.client, os | ||
| from dotenv import load_dotenv | ||
| load_dotenv() | ||
|
|
||
| connection_name = "google_ads" # get your connection name from connection configurations | ||
| identifier = "user_123" # your unique user identifier | ||
|
|
||
| # Get your credentials from app.scalekit.com → Developers → Settings → API Credentials | ||
| scalekit_client = scalekit.client.ScalekitClient( | ||
| client_id=os.getenv("SCALEKIT_CLIENT_ID"), | ||
| client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"), | ||
| env_url=os.getenv("SCALEKIT_ENV_URL"), | ||
| ) | ||
| actions = scalekit_client.actions | ||
|
|
||
| # Authenticate the user | ||
| link_response = actions.get_authorization_link( | ||
| connection_name=connection_name, | ||
| identifier=identifier | ||
| ) | ||
| # present this link to your user for authorization, or click it yourself for testing | ||
| print("🔗 Authorize Google Ads:", link_response.link) | ||
| input("Press Enter after authorizing...") | ||
|
|
||
| # Make a request via Scalekit proxy | ||
| result = actions.request( | ||
| connection_name=connection_name, | ||
| identifier=identifier, | ||
| path="/v17/customers", | ||
| method="GET" | ||
| ) | ||
| print(result) | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check if the file exists and examine the specific lines
head -n 230 src/content/docs/reference/agent-connectors/google_ads.mdx | tail -n +155Repository: scalekit-inc/developer-docs
Length of output: 2602
🏁 Script executed:
# Search for all TabItem occurrences in this file
rg -n '^\s*<TabItem label=' src/content/docs/reference/agent-connectors/google_ads.mdxRepository: scalekit-inc/developer-docs
Length of output: 133
🏁 Script executed:
# Examine the generation script referenced in the learnings
cat scripts/sync-agent-connectors.jsRepository: scalekit-inc/developer-docs
Length of output: 19240
🏁 Script executed:
# Check if there are other agent-connector files and how many language tabs they have
fd '\.mdx$' src/content/docs/reference/agent-connectors/ --exec sh -c 'echo "=== {} ==="; rg "TabItem label=" "{}" | head -5'Repository: scalekit-inc/developer-docs
Length of output: 3313
Add Go and Java SDK tabs to complete multi-language coverage.
The SDK usage example at lines 155–227 currently includes only Node.js and Python. The documentation standard requires all four languages (Node.js, Python, Go, Java) in SDK code examples.
Current tabs
<TabItem label="Node.js">
[code]
</TabItem>
<TabItem label="Python">
[code]
</TabItem>
Add <TabItem label="Go"> and <TabItem label="Java"> with equivalent code examples using the standard variable names: scalekitClient for both languages.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/content/docs/reference/agent-connectors/google_ads.mdx` around lines 155
- 227, Add two new TabItem blocks labeled "Go" and "Java" mirroring the
Node.js/Python examples: use the variable name scalekitClient (not
ScalekitClient) in both, show retrieving an authorization link (use the
language-appropriate method on scalekitClient.actions, analogous to
connectedAccounts.getMagicLinkForConnectedAccount /
actions.get_authorization_link) with connectionName/identifier variables, prompt
for user authorization, then call scalekitClient.actions.request (or the
SDK-equivalent request method) to GET "/v17/customers" and print the result;
ensure the Go and Java snippets follow the same variable names (connectionName,
identifier, scalekitClient) and overall flow as the existing examples.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 7
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
src/content/docs/reference/agent-connectors/googlecalendar.mdx (1)
86-86:⚠️ Potential issue | 🟡 MinorUse the connector-docs CDN host for logo assets.
This logo URL points to
cdn.scalekit.com; this section standard useshttps://cdn.scalekit.cloud/sk-connect/assets/provider-icons/....Based on learnings: "For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, prefer using CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/)..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx` at line 86, Update the image src to use the standard CDN host: replace the URL host "cdn.scalekit.com" with "cdn.scalekit.cloud" in the img tag for the Google Calendar logo (the src value "https://cdn.scalekit.com/sk-connect/assets/provider-icons/google_calendar.svg" in the Google Calendar connector doc) so it points to "https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/google_calendar.svg".src/content/docs/reference/agent-connectors/googleforms.mdx (1)
86-86:⚠️ Potential issue | 🟡 MinorUse the agent-connector CDN host for the provider icon URL.
This page uses
cdn.scalekit.cominstead of the connector-docs conventioncdn.scalekit.cloud, which risks inconsistent asset hosting across this section.🔧 Suggested fix
- <img src="https://cdn.scalekit.com/sk-connect/assets/provider-icons/google_forms.svg" width="64" height="64" alt="Google Forms logo" /> + <img src="https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/google_forms.svg" width="64" height="64" alt="Google Forms logo" />Based on learnings: "For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, prefer using CDN URLs (https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/)..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googleforms.mdx` at line 86, The provider icon URL is using the wrong CDN host; update the img element's src attribute that currently points to "https://cdn.scalekit.com/sk-connect/assets/provider-icons/google_forms.svg" so it uses the connector-docs CDN host "https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/google_forms.svg" (i.e., replace cdn.scalekit.com with cdn.scalekit.cloud in the img src).
♻️ Duplicate comments (3)
src/content/docs/reference/agent-connectors/gmail.mdx (3)
220-236:⚠️ Potential issue | 🟡 MinorAdd an explicit error path in the Python SDK example
The sample shows only the happy path. Wrap authorization and proxy calls in
try/exceptand show surfaced error details.Proposed update
- # Authenticate the user - link_response = actions.get_authorization_link( - connection_name=connection_name, - identifier=identifier - ) - # present this link to your user for authorization, or click it yourself for testing - print("🔗 Authorize Gmail:", link_response.link) - input("Press Enter after authorizing...") - - # Make a request via Scalekit proxy - result = actions.request( - connection_name=connection_name, - identifier=identifier, - path="/v1/users/me/profile", - method="GET" - ) - print(result) + try: + # Authenticate the user + link_response = actions.get_authorization_link( + connection_name=connection_name, + identifier=identifier + ) + print("🔗 Authorize Gmail:", link_response.link) + input("Press Enter after authorizing...") + + # Make a request via Scalekit proxy + result = actions.request( + connection_name=connection_name, + identifier=identifier, + path="/v1/users/me/profile", + method="GET" + ) + print(result) + except Exception as err: + print(f"Gmail request failed: {err}")Based on learnings, “Always include error handling in code examples showing both success and error paths.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/gmail.mdx` around lines 220 - 236, The example only shows the happy path for authorization and proxy requests; wrap the calls to actions.get_authorization_link(...) and actions.request(...) in try/except blocks so errors are caught and surfaced—catch exceptions around the get_authorization_link call to log or print the exception and handle failed authorization, and wrap the actions.request call to print the response on success or print the exception details on failure; ensure both error paths include the exception message and context (e.g., which call failed and the connection_name/identifier) so users can see how to handle failures in the SDK example.
204-204:⚠️ Potential issue | 🟡 MinorAdd a
titleto the Python code blockPlease add a contextual title (for example,
title="gmail-usage.py") to align with code block standards.As per coding guidelines, “Code blocks MUST have a
title=attribute showing the file path” and “Label code blocks with titles for context.”Also applies to: 237-237
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/gmail.mdx` at line 204, Update the Python code fences in the Gmail connector doc to include a title attribute: replace the opening backtick fences that start with ```python with ```python title="gmail-usage.py" (and add a similarly descriptive title for the other Python block referenced nearby) so every code block has a title showing the file path per the guidelines.
247-315:⚠️ Potential issue | 🟠 MajorRemove duplicated 3-column tool tables and keep the generated 4-column schema only
This block duplicates the same tool sections already present below and uses the wrong table format (
Properties | Description | Type). Keep only the canonicalName | Type | Required | Descriptionsections.Based on learnings, “For MDX files under
src/content/docs/reference/agent-connectors, parameter tables are auto-generated… Do not manually edit the generated MDX files. Updatescripts/sync-agent-connectors.jsto output a four-column table with headers Name | Type | Required | Description.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/gmail.mdx` around lines 247 - 315, The MDX contains duplicated 3-column parameter tables for tools like gmail_list_messages, gmail_get_attachment_by_id, gmail_get_contacts, gmail_get_message_by_id, gmail_list_drafts and gmail_search_people; remove these manual 3-column sections and instead update the generator script scripts/sync-agent-connectors.js so it emits the canonical 4-column table header "Name | Type | Required | Description" for all generated tool parameter blocks; specifically change the table generation logic in sync-agent-connectors.js to map each parameter to the four-column schema (name, type, required boolean, description) and ensure the script rewrites the MDX (including the gmail connector) to replace the old 3-column tables with the new 4-column output so no manual edits remain in the MDX files.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/reference/agent-connectors/gmail.mdx`:
- Around line 165-239: The docs currently only expose a Python TabItem and have
the Node.js example commented out; add back the full four-language SDK usage
tabs (TabItem label="Node.js", TabItem label="Python", TabItem label="Go",
TabItem label="Java") inside the existing Tabs syncKey="tech-stack" block so all
four SDK examples appear; restore and uncomment the Node.js TabItem content
shown in the diff, and add equivalent Go and Java TabItem blocks with concise
example snippets matching the Python/Node patterns and referencing the same
connection_name/identifier and actions.request/get_authorization_link methods so
the Tabs contain Node.js, Python, Go, and Java examples.
- Around line 102-159: Reformat every Steps block in this diff to use the
required numbered step-heading pattern: replace plain numbered list items with
the pattern "1. ## <Action title>" and ensure all content inside each step
(descriptions, images, Asides, nested lists) is indented with exactly 3 spaces;
update the first Steps (Agent Auth → Create Connection flow), the "Enable Gmail
API" Steps, and the "Add Credentials" Steps so each step uses "1. ## Title" and
all nested lines (e.g., the Aside block, image tags like useOwnCredentialsImg,
oauthWebAppImg, addRedirectUriImg, enableGmailApiImg, addCredentialsImg, and
bullet lists for Client ID/Secret/Permissions) are consistently indented by
three spaces to satisfy the parser/layout requirements.
- Around line 100-146: Change the two headings from title case to sentence case:
replace "### Configure Redirect URL" with "### Configure redirect URL" and "###
Add Credentials" with "### Add credentials" in
src/content/docs/reference/agent-connectors/gmail.mdx so they follow the docs'
sentence-case heading style; update any identical heading instances in this file
if present to maintain consistency.
In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx`:
- Around line 101-125: The Steps block currently uses plain numbered lines;
update both Steps components (the one around the Google Calendar setup and the
one at lines mentioned 131-154) to use the required "1. ## <Action title>" step
structure and ensure every line of content under each step is indented with
exactly three spaces; specifically replace each top-level numbered item with a
header-style step (e.g., "1. ## <Action title>") and re-indent the subsequent
paragraph text, images, and Aside content to three spaces so the Steps component
and its children (the Steps element, its step headers, the Aside and img
elements) conform to the coding guideline.
In `@src/content/docs/reference/agent-connectors/googledrive.mdx`:
- Around line 100-120: Replace the procedural list inside the Steps component
with the required heading-style step entries: for each step turn the numbered
item into the "1. ## <Step title>" form and ensure every line of that step's
body is indented with exactly three spaces; update the block that currently
shows "1. In Scalekit dashboard..." etc. to use a title (e.g., "1. ## Create
Google Drive connection") followed by the step content indented by three spaces,
and apply the same transformation to the other Steps blocks referenced (the
additional Steps blocks noted in the comment). Ensure you modify the Steps
component content (the <Steps> block) only, preserving images and links but
reformatting the list items to the heading-style step format with 3-space
indentation.
In `@src/content/docs/reference/agent-connectors/googleforms.mdx`:
- Around line 100-120: The Steps block is using plain numbered list items;
convert each step to the required numbered-heading pattern by replacing each "N.
<full sentence>" with "1. ## <Action title>" followed by the step body indented
with exactly three spaces; update the Google Forms Steps block (the <Steps>
component and its other occurrences in this file) so titles are concise headings
(e.g., "## Create Google Forms connection", "## Configure OAuth client") and
move the explanatory sentences and images onto the next lines each prefixed with
exactly three spaces of indentation to match the coding guideline.
In `@src/content/docs/reference/agent-connectors/googlemeet.mdx`:
- Around line 100-120: Replace the current <Steps> block with the
repository-required numbered step-heading format: each step must begin with "1.
## <Title>" and every line of the step body must have exactly 3 spaces of
indentation; update all occurrences within the Google Meet guide (the <Steps>
component containing the redirected-URI instruction and the image refs
useOwnCredentialsImg, oauthWebAppImg, addRedirectUriImg) to follow this pattern,
ensuring consistent 3-space indentation for lines 100–120 and the other affected
ranges (126–134, 138–149).
---
Outside diff comments:
In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx`:
- Line 86: Update the image src to use the standard CDN host: replace the URL
host "cdn.scalekit.com" with "cdn.scalekit.cloud" in the img tag for the Google
Calendar logo (the src value
"https://cdn.scalekit.com/sk-connect/assets/provider-icons/google_calendar.svg"
in the Google Calendar connector doc) so it points to
"https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/google_calendar.svg".
In `@src/content/docs/reference/agent-connectors/googleforms.mdx`:
- Line 86: The provider icon URL is using the wrong CDN host; update the img
element's src attribute that currently points to
"https://cdn.scalekit.com/sk-connect/assets/provider-icons/google_forms.svg" so
it uses the connector-docs CDN host
"https://cdn.scalekit.cloud/sk-connect/assets/provider-icons/google_forms.svg"
(i.e., replace cdn.scalekit.com with cdn.scalekit.cloud in the img src).
---
Duplicate comments:
In `@src/content/docs/reference/agent-connectors/gmail.mdx`:
- Around line 220-236: The example only shows the happy path for authorization
and proxy requests; wrap the calls to actions.get_authorization_link(...) and
actions.request(...) in try/except blocks so errors are caught and
surfaced—catch exceptions around the get_authorization_link call to log or print
the exception and handle failed authorization, and wrap the actions.request call
to print the response on success or print the exception details on failure;
ensure both error paths include the exception message and context (e.g., which
call failed and the connection_name/identifier) so users can see how to handle
failures in the SDK example.
- Line 204: Update the Python code fences in the Gmail connector doc to include
a title attribute: replace the opening backtick fences that start with ```python
with ```python title="gmail-usage.py" (and add a similarly descriptive title for
the other Python block referenced nearby) so every code block has a title
showing the file path per the guidelines.
- Around line 247-315: The MDX contains duplicated 3-column parameter tables for
tools like gmail_list_messages, gmail_get_attachment_by_id, gmail_get_contacts,
gmail_get_message_by_id, gmail_list_drafts and gmail_search_people; remove these
manual 3-column sections and instead update the generator script
scripts/sync-agent-connectors.js so it emits the canonical 4-column table header
"Name | Type | Required | Description" for all generated tool parameter blocks;
specifically change the table generation logic in sync-agent-connectors.js to
map each parameter to the four-column schema (name, type, required boolean,
description) and ensure the script rewrites the MDX (including the gmail
connector) to replace the old 3-column tables with the new 4-column output so no
manual edits remain in the MDX files.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (9)
src/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
ravibits
approved these changes
Feb 27, 2026
…eading case, and duplicate sections - Add ## action title headings to all <Steps> blocks across 9 connector docs - Fix title-case subsection headings to sentence case (Configure redirect URL, Add credentials) - Remove duplicate 3-column tool tables from gmail.mdx and googlecalendar.mdx Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (9)
src/content/docs/reference/agent-connectors/googledocs.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorFinish the SDK usage section per repo standards before merge.
The section currently renders only Python (Node.js is commented) and still lacks Go/Java tabs. It also misses required explicit error-path/security rationale and code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs: Node.js, Python, Go, Java," "Always include error handling in code examples showing both success and error paths," and "Code blocks MUST have a
title=attribute showing the file path."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googledocs.mdx` around lines 183 - 257, Uncomment and restore the Node.js TabItem (using ScalekitClient, connectedAccounts.getMagicLinkForConnectedAccount and actions.request) and add two new TabItem blocks for Go and Java that demonstrate equivalent flows (authorize link retrieval and actions.request), ensure each code block includes both success and explicit error-handling paths (catch/except/if err) and a short security rationale comment, and add title="path/to/example.(js|py|go|java)" attributes to every fenced code block within the Tabs component so each tab shows the file path per repo standards.src/content/docs/reference/agent-connectors/google_ads.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorUsage examples are still incomplete for SDK documentation standards.
The section still renders only Python, lacks Go/Java tabs, and does not include explicit success/error paths with security rationale comments or code-block
titlemetadata.As per coding guidelines: "ALL code examples that show SDK usage MUST include all four language tabs," "Show both success path AND error path in every code example," and "Code blocks MUST have a
title=attribute showing the file path."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/google_ads.mdx` around lines 183 - 257, The docs only include a Python TabItem under Tabs(syncKey="tech-stack"); add the missing TabItem blocks for Node.js, Go, and Java with full success and error paths, include security rationale comments (e.g., why to store client secrets safely and to validate redirect flow) inside each code block, and ensure every triple-backtick code block has a title="path/to/example.(js|py|go|java)" attribute; update the Node.js example to use the ScalekitClient methods shown (e.g., connectionName/identifier, connectedAccounts.getMagicLinkForConnectedAccount, actions.request) and mirror the Python call sites (get_authorization_link, actions.request) for Go/Java equivalents so all four languages show both successful response handling and error handling.src/content/docs/reference/agent-connectors/googlesheets.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorUsage examples remain below required SDK documentation standard.
Only Python is visible, Node.js is commented out, and Go/Java tabs are missing. The snippets also skip required explicit error handling/security rationale and omit code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs," "Always include error handling in code examples showing both success and error paths," and "Code blocks MUST have a
title=attribute showing the file path."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googlesheets.mdx` around lines 183 - 257, Uncomment and restore the missing language tabs and add Go and Java TabItem entries so all four SDK examples are present (the Tabs/TabItem components around the Node.js and Python snippets), ensure each code block has a title="..." attribute indicating the file path, and update each snippet (Node.js ScalekitClient usage and actions.request, Python actions.get_authorization_link/actions.request and their equivalents in Go/Java) to include explicit error handling showing both success and error paths and a brief security rationale comment (e.g., handling missing env vars, try/catch or exception handling and not logging secrets); keep the Node.js block uncommented and function/class names intact (ScalekitClient, connectedAccounts.getMagicLinkForConnectedAccount, actions.request, actions.get_authorization_link) so reviewers can locate and verify changes.src/content/docs/reference/agent-connectors/googleslides.mdx (1)
184-258:⚠️ Potential issue | 🟠 MajorComplete the usage tabs and error-path guidance for SDK samples.
The block still exposes only Python (Node.js remains commented), without Go/Java tabs, and omits required explicit error-path/security commentary plus code-block
titlemetadata.As per coding guidelines: "ALL code examples that show SDK usage MUST include all four language tabs," "Show both success path AND error path in every code example," and "Code blocks MUST have a
title=attribute."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googleslides.mdx` around lines 184 - 258, The docs tab block is missing Node.js/Go/Java tabs, lacks explicit error-path examples and security/error-handling guidance, and code fences are missing required title= metadata; update the <Tabs syncKey="tech-stack"> block to include all four TabItem entries (Node.js, Python, Go, Java) using the existing Python/Node examples as templates, add for each language a short success path and a matching error-path example (showing try/catch or error return handling and logging), include a brief security note about storing credentials and handling tokens (e.g., re-auth on 401), and ensure every triple-backtick code block includes title="..." attributes to satisfy the code-block title requirement.src/content/docs/reference/agent-connectors/googledrive.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorSDK usage documentation is still incomplete and missing required safeguards.
Only Python is active, Node.js remains commented, and Go/Java tabs are still missing. The snippets also lack explicit error-path handling/security rationale and code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs," "Show both success path AND error path in every code example," and "Code blocks MUST have a
title=attribute."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googledrive.mdx` around lines 183 - 257, The docs tab block under Tabs (syncKey="tech-stack") is incomplete: Node.js is commented out and Go/Java tabs are missing, examples lack error-path handling and title metadata; update the Tabs/TabItem entries to include all four languages (Node.js, Python, Go, Java), restore or replace the Node.js TabItem containing ScalekitClient and actions.request, and add corresponding Go/Java snippets that call the same public methods (e.g., ScalekitClient / scalekit.client.ScalekitClient, actions.get_authorization_link or connectedAccounts.getMagicLinkForConnectedAccount, and actions.request). For every language snippet add explicit success and error handling flows (try/catch or conditional error checks) and a brief security rationale comment about storing credentials and validation, and ensure every code block (the fenced triple-backtick blocks inside each TabItem) includes a title="..." attribute.src/content/docs/reference/agent-connectors/googlemeet.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorComplete the SDK usage section to match required production-ready format.
Only Python renders right now (Node.js is commented out), Go/Java tabs are missing, and the example omits required error-path and security rationale coverage plus code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs: Node.js, Python, Go, Java," "Always include error handling in code examples showing both success and error paths," and "Code blocks MUST have a
title=attribute showing the file path."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googlemeet.mdx` around lines 183 - 257, The Tabs block (Tabs syncKey="tech-stack") currently only renders Python (Node.js is commented out via TabItem label="Node.js") and lacks Go/Java examples; update this Tabs to include four TabItem entries (labels: "Node.js", "Python", "Go", "Java"), uncomment and restore the Node.js TabItem content (referencing the ScalekitClient usage and actions.request/getMagicLinkForConnectedAccount flow), and add equivalent Go and Java examples; for every code block add title="path/to/example" metadata, and ensure each language example shows both success and error paths (try/catch or error handling around actions.request and the auth link retrieval) plus a brief one-line security rationale comment about storing/handling client secrets and tokens.src/content/docs/reference/agent-connectors/googleforms.mdx (1)
183-257:⚠️ Potential issue | 🟠 MajorSDK usage block still misses required language coverage and hardening details.
Node.js is commented, Python is the only visible tab, and Go/Java tabs are missing. The snippets also lack explicit error paths, security rationale comments, and code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs," "Always include error handling in code examples showing both success and error paths," and "Code blocks MUST have a
title=attribute."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googleforms.mdx` around lines 183 - 257, The Tabs block for SDK examples in googleforms.mdx is missing required language tabs and hardening details: uncomment and restore the Node.js TabItem (label="Node.js") content, add new TabItem entries for "Go" and "Java" with representative examples, and ensure every code block inside each TabItem has a title attribute (e.g., title="Node.js example"). Add explicit success and error handling paths in each snippet (show both normal response handling and caught errors/exception branches) and include brief security rationale comments about credential handling and using magic links (inline comments within each snippet). Keep TabItem labels exact ("Node.js", "Python", "Go", "Java") to satisfy the Tabs syncKey="tech-stack" requirement.src/content/docs/reference/agent-connectors/googlecalendar.mdx (1)
188-262:⚠️ Potential issue | 🟠 MajorUsage section still misses required SDK completeness and safety patterns.
Only Python is visible, with Node.js commented and no Go/Java tabs. The examples also omit explicit error handling/security rationale and code-block
titlemetadata.As per coding guidelines: "All code examples that show SDK usage MUST include all four language tabs," "Always include error handling in code examples showing both success and error paths," and "Code blocks MUST have a
title=attribute showing the file path."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx` around lines 188 - 262, The docs tabs only show Python and have Node.js commented out and missing Go/Java examples, and none of the snippets include error handling or code-block title metadata; restore/uncomment the Node.js TabItem (Tabs syncKey="tech-stack", TabItem label="Node.js") and add complete Go and Java TabItem blocks, ensuring each code fence has a title="path/to/example" attribute; update the Node.js example to use ScalekitClient and connectedAccounts.getMagicLinkForConnectedAccount and actions.request with try/catch that logs both success and error paths and a brief security comment about storing credentials, and similarly wrap the Python actions.get_authorization_link/actions.request example with try/except showing success and error handling and a short security rationale.src/content/docs/reference/agent-connectors/gmail.mdx (1)
193-267:⚠️ Potential issue | 🟠 MajorIncomplete SDK language tabs and missing code block titles.
The Usage section currently only exposes Python, with Node.js commented out and no Go/Java tabs. Per coding guidelines, SDK usage examples must include all four language tabs.
Additionally, the code blocks lack
titleattributes (e.g.,title="example.py").If Go and Java SDKs aren't ready yet, consider adding a note explaining this limitation, or provide placeholder tabs with "coming soon" messages rather than omitting them entirely.
,Suggested structure
<Tabs syncKey="tech-stack"> -{/* Node.js - commented out, uncomment when ready <TabItem label="Node.js"> - ```typescript + ```typescript title="gmail-example.ts" import { ScalekitClient } from '@scalekit-sdk/node'; ... ``` </TabItem> -*/} <TabItem label="Python"> - ```python + ```python title="gmail-example.py" import scalekit.client, os ... ``` </TabItem> + <TabItem label="Go"> + ```go title="gmail-example.go" + // Coming soon + ``` + </TabItem> + <TabItem label="Java"> + ```java title="GmailExample.java" + // Coming soon + ``` + </TabItem> </Tabs>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/reference/agent-connectors/gmail.mdx` around lines 193 - 267, The Tabs block for SDK usage only exposes Python, leaves Node.js commented out, and omits Go/Java tabs and code block titles; update the Tabs/TabItem components (the Tabs element and each TabItem) to include full language tabs (TypeScript/Node.js, Python, Go, Java), restore/uncomment the Node.js TabItem for ScalekitClient usage (label "Node.js"/"TypeScript"), add placeholder TabItem entries for Go and Java if SDKs aren’t ready, and add title attributes to each fenced code block (e.g., title="gmail-example.ts", title="gmail-example.py", title="gmail-example.go", title="GmailExample.java") or include a short "Coming soon" message in the placeholder tabs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/reference/agent-connectors/gmail.mdx`:
- Around line 232-265: Update the Python example to show success and error paths
and add security notes: wrap the ScalekitClient instantiation
(scalekit.client.ScalekitClient) and calls to actions.get_authorization_link and
actions.request in try/except blocks that catch exceptions and log/print
meaningful error messages, and after successful responses show the expected
success flow; add comments near the environment variable usage explaining
security best practices (do not hardcode credentials, use secure secret storage,
and limit scope/rotation), and annotate that the authorization link must be
presented to the user securely and tokens/identifiers must be stored safely.
---
Duplicate comments:
In `@src/content/docs/reference/agent-connectors/gmail.mdx`:
- Around line 193-267: The Tabs block for SDK usage only exposes Python, leaves
Node.js commented out, and omits Go/Java tabs and code block titles; update the
Tabs/TabItem components (the Tabs element and each TabItem) to include full
language tabs (TypeScript/Node.js, Python, Go, Java), restore/uncomment the
Node.js TabItem for ScalekitClient usage (label "Node.js"/"TypeScript"), add
placeholder TabItem entries for Go and Java if SDKs aren’t ready, and add title
attributes to each fenced code block (e.g., title="gmail-example.ts",
title="gmail-example.py", title="gmail-example.go", title="GmailExample.java")
or include a short "Coming soon" message in the placeholder tabs.
In `@src/content/docs/reference/agent-connectors/google_ads.mdx`:
- Around line 183-257: The docs only include a Python TabItem under
Tabs(syncKey="tech-stack"); add the missing TabItem blocks for Node.js, Go, and
Java with full success and error paths, include security rationale comments
(e.g., why to store client secrets safely and to validate redirect flow) inside
each code block, and ensure every triple-backtick code block has a
title="path/to/example.(js|py|go|java)" attribute; update the Node.js example to
use the ScalekitClient methods shown (e.g., connectionName/identifier,
connectedAccounts.getMagicLinkForConnectedAccount, actions.request) and mirror
the Python call sites (get_authorization_link, actions.request) for Go/Java
equivalents so all four languages show both successful response handling and
error handling.
In `@src/content/docs/reference/agent-connectors/googlecalendar.mdx`:
- Around line 188-262: The docs tabs only show Python and have Node.js commented
out and missing Go/Java examples, and none of the snippets include error
handling or code-block title metadata; restore/uncomment the Node.js TabItem
(Tabs syncKey="tech-stack", TabItem label="Node.js") and add complete Go and
Java TabItem blocks, ensuring each code fence has a title="path/to/example"
attribute; update the Node.js example to use ScalekitClient and
connectedAccounts.getMagicLinkForConnectedAccount and actions.request with
try/catch that logs both success and error paths and a brief security comment
about storing credentials, and similarly wrap the Python
actions.get_authorization_link/actions.request example with try/except showing
success and error handling and a short security rationale.
In `@src/content/docs/reference/agent-connectors/googledocs.mdx`:
- Around line 183-257: Uncomment and restore the Node.js TabItem (using
ScalekitClient, connectedAccounts.getMagicLinkForConnectedAccount and
actions.request) and add two new TabItem blocks for Go and Java that demonstrate
equivalent flows (authorize link retrieval and actions.request), ensure each
code block includes both success and explicit error-handling paths
(catch/except/if err) and a short security rationale comment, and add
title="path/to/example.(js|py|go|java)" attributes to every fenced code block
within the Tabs component so each tab shows the file path per repo standards.
In `@src/content/docs/reference/agent-connectors/googledrive.mdx`:
- Around line 183-257: The docs tab block under Tabs (syncKey="tech-stack") is
incomplete: Node.js is commented out and Go/Java tabs are missing, examples lack
error-path handling and title metadata; update the Tabs/TabItem entries to
include all four languages (Node.js, Python, Go, Java), restore or replace the
Node.js TabItem containing ScalekitClient and actions.request, and add
corresponding Go/Java snippets that call the same public methods (e.g.,
ScalekitClient / scalekit.client.ScalekitClient, actions.get_authorization_link
or connectedAccounts.getMagicLinkForConnectedAccount, and actions.request). For
every language snippet add explicit success and error handling flows (try/catch
or conditional error checks) and a brief security rationale comment about
storing credentials and validation, and ensure every code block (the fenced
triple-backtick blocks inside each TabItem) includes a title="..." attribute.
In `@src/content/docs/reference/agent-connectors/googleforms.mdx`:
- Around line 183-257: The Tabs block for SDK examples in googleforms.mdx is
missing required language tabs and hardening details: uncomment and restore the
Node.js TabItem (label="Node.js") content, add new TabItem entries for "Go" and
"Java" with representative examples, and ensure every code block inside each
TabItem has a title attribute (e.g., title="Node.js example"). Add explicit
success and error handling paths in each snippet (show both normal response
handling and caught errors/exception branches) and include brief security
rationale comments about credential handling and using magic links (inline
comments within each snippet). Keep TabItem labels exact ("Node.js", "Python",
"Go", "Java") to satisfy the Tabs syncKey="tech-stack" requirement.
In `@src/content/docs/reference/agent-connectors/googlemeet.mdx`:
- Around line 183-257: The Tabs block (Tabs syncKey="tech-stack") currently only
renders Python (Node.js is commented out via TabItem label="Node.js") and lacks
Go/Java examples; update this Tabs to include four TabItem entries (labels:
"Node.js", "Python", "Go", "Java"), uncomment and restore the Node.js TabItem
content (referencing the ScalekitClient usage and
actions.request/getMagicLinkForConnectedAccount flow), and add equivalent Go and
Java examples; for every code block add title="path/to/example" metadata, and
ensure each language example shows both success and error paths (try/catch or
error handling around actions.request and the auth link retrieval) plus a brief
one-line security rationale comment about storing/handling client secrets and
tokens.
In `@src/content/docs/reference/agent-connectors/googlesheets.mdx`:
- Around line 183-257: Uncomment and restore the missing language tabs and add
Go and Java TabItem entries so all four SDK examples are present (the
Tabs/TabItem components around the Node.js and Python snippets), ensure each
code block has a title="..." attribute indicating the file path, and update each
snippet (Node.js ScalekitClient usage and actions.request, Python
actions.get_authorization_link/actions.request and their equivalents in Go/Java)
to include explicit error handling showing both success and error paths and a
brief security rationale comment (e.g., handling missing env vars, try/catch or
exception handling and not logging secrets); keep the Node.js block uncommented
and function/class names intact (ScalekitClient,
connectedAccounts.getMagicLinkForConnectedAccount, actions.request,
actions.get_authorization_link) so reviewers can locate and verify changes.
In `@src/content/docs/reference/agent-connectors/googleslides.mdx`:
- Around line 184-258: The docs tab block is missing Node.js/Go/Java tabs, lacks
explicit error-path examples and security/error-handling guidance, and code
fences are missing required title= metadata; update the <Tabs
syncKey="tech-stack"> block to include all four TabItem entries (Node.js,
Python, Go, Java) using the existing Python/Node examples as templates, add for
each language a short success path and a matching error-path example (showing
try/catch or error return handling and logging), include a brief security note
about storing credentials and handling tokens (e.g., re-auth on 401), and ensure
every triple-backtick code block includes title="..." attributes to satisfy the
code-block title requirement.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (9)
src/content/docs/reference/agent-connectors/gmail.mdxsrc/content/docs/reference/agent-connectors/google_ads.mdxsrc/content/docs/reference/agent-connectors/googlecalendar.mdxsrc/content/docs/reference/agent-connectors/googledocs.mdxsrc/content/docs/reference/agent-connectors/googledrive.mdxsrc/content/docs/reference/agent-connectors/googleforms.mdxsrc/content/docs/reference/agent-connectors/googlemeet.mdxsrc/content/docs/reference/agent-connectors/googlesheets.mdxsrc/content/docs/reference/agent-connectors/googleslides.mdx
Collaborator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added Agent action docs for google connectors
Summary by CodeRabbit