Add Google Contacts connector docs#637
Conversation
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
WalkthroughAdds a new Google Contacts agent connector: documentation (setup + usage), connector metadata, a tools registry for contacts/groups/other-contacts/Workspace people, and exports to render the new MDX sections. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App as Scalekit App
participant Scalekit
participant Google as Google OAuth / People API
User->>App: Click "Connect Google Contacts"
App->>Scalekit: Request auth link (actions.request / generate link)
Scalekit-->>App: Return authorization URL
App->>User: Redirect to authorization URL
User->>Google: Authorize + Google returns authorization code to App redirect URI
App->>Scalekit: Exchange code (scalekit receives redirect, calls Google token endpoint)
Scalekit->>Google: Exchange code for tokens (access + refresh)
Google-->>Scalekit: Return tokens
Scalekit-->>App: Confirm connection created (stores tokens, returns connectionName)
App->>Scalekit: Use connector tools / proxy requests with connectionName
Scalekit->>Google: Call People API on behalf of user (refreshing tokens as needed)
Google-->>Scalekit: Return contacts / group data
Scalekit-->>App: Forward API responses
App->>User: Display contacts / operation result
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 4/5 reviews remaining, refill in 12 minutes. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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/components/templates/agent-connectors/_setup-googlecontacts.mdx`:
- Around line 5-7: The <Aside> component instance using type="caution" is
missing a title attribute; update the <Aside type="caution"> element in
_setup-googlecontacts.mdx to include a descriptive title (e.g., title="Caution")
so the component usage is consistent and accessible, ensuring the title text
conveys the warning about Google app verification and follows the project's
wording/style guidelines.
In `@src/content/docs/agentkit/connectors/googlecontacts.mdx`:
- Around line 1-13: The frontmatter for the Google Contacts doc (the YAML block
starting with title: Google Contacts) is missing the required description and
sidebar.label fields; update that frontmatter to include a concise description
(≤160 characters) and a sidebar.label of 1–3 words (and ensure title remains ≤60
chars), e.g., add description: "..." and sidebar.label: "Google Contacts" near
the top of the existing frontmatter so the page meets the documentation
guidelines.
In `@src/data/agent-connectors/googlecontacts.ts`:
- Around line 103-123: The docs are inconsistent: the operation description says
an etag is required for updates but the params list has etag as required: false;
update the params entry for 'etag' to required: true so it matches the operation
description "Update an existing contact. Requires the contact's etag for
optimistic locking.", keeping the existing 'etag' description text and leaving
'person_id' and 'update_person_fields' unchanged.
- Around line 232-241: The batch tools googlecontacts_contacts_batch_delete,
googlecontacts_groups_batch_get, and googlecontacts_people_batch_get incorrectly
declare the resource_names param as type: 'string'; change each resource_names
param to type: 'array' and update its description to indicate an array of
resource names (e.g., ["people/c123","people/c456"]) and note API limits
(people.batchGet/contactGroups.batchGet up to 200 items,
people:batchDeleteContacts up to 500 items) so callers send arrays rather than a
single string.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2163c59e-cc25-42cd-8788-8d096af43433
⛔ Files ignored due to path filters (5)
src/assets/docs/agent-connectors/googlecontacts/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecontacts/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecontacts/enable-people-api.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecontacts/oauth-web-app.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecontacts/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (5)
src/components/templates/agent-connectors/_setup-googlecontacts.mdxsrc/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/data/agent-connectors/googlecontacts.ts
📜 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 (11)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.ts
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.ts
**/*.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/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.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
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- 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...
Files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
src/content/docs/agentkit/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Agentkit code examples live in the external repo scalekit-developers/agent-auth-examples organized as
javascript/frameworks/<framework>andpython/frameworks/<framework>; verify docs snippets match current implementations in that repo
Files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
🧠 Learnings (45)
📓 Common learnings
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:46.707Z
Learning: In `src/components/templates/agent-connectors/`, it is acceptable and intentional to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., `oauth-web-app.png`, `add-redirect-uri.png`) in other Google-service connector templates (e.g., `_setup-bigquery.mdx`, `_setup-google-ads.mdx`, etc.). Do not flag cross-connector image path reuse within the Google service connectors as an issue.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
📚 Learning: 2026-02-26T07:21:37.207Z
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.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.tssrc/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-12T16:29:16.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:16.422Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using "Azure Active Directory" instead of the rebranded "Microsoft Entra ID" is acceptable and intentional. Do not flag "Azure Active Directory" as outdated branding in these agent-connector setup template files.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-12T16:26:46.707Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:46.707Z
Learning: In `src/components/templates/agent-connectors/`, it is acceptable and intentional to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., `oauth-web-app.png`, `add-redirect-uri.png`) in other Google-service connector templates (e.g., `_setup-bigquery.mdx`, `_setup-google-ads.mdx`, etc.). Do not flag cross-connector image path reuse within the Google service connectors as an issue.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-10T10:37:49.873Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:49.873Z
Learning: In `src/components/templates/agent-connectors/`, all connector setup MDX files (e.g., _setup-asana.mdx, _setup-clickup.mdx, _setup-confluence.mdx, _setup-googlecalendar.mdx, _setup-intercom.mdx, _setup-monday.mdx, _setup-notion.mdx, _setup-zoom.mdx) intentionally use a single shared redirect URI screenshot (`use-own-credentials-redirect-uri.png` located under `@/assets/docs/agent-connectors/<connector-name>/`) for all redirect URI-related steps, even when steps show different UIs (e.g., Scalekit dashboard vs. the third-party console). Do not flag reuse of this image across multiple steps within the same connector file as an issue.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-12T16:28:42.817Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:22:55.583Z
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.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/data/agent-connectors/googlecontacts.tssrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides in `src/content/docs/guides/integrations/` must be kept synchronized with their corresponding index pages and use reusable template components from `src/components/templates/`
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:18:51.377Z
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:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/components/templates/agent-connectors/index.tssrc/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/data/agent-connectors/googlecontacts.tssrc/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, keep the trailing `## Scalekit Tools` heading at the end of each template. Do not flag it as empty or as a duplicate heading in future reviews for these files, since it is an intentional structural anchor used by the parent connector reference page to append the tool-list section beneath the proxy API examples.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-03T13:35:56.400Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In `src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx`, the Python SDK's `execute_tool` function accepts `connection_name` as a valid parameter (in addition to `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid or unsupported parameter in Python `execute_tool` calls in AgentKit documentation.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-25T15:59:47.933Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:47.933Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, the code snippets are intentionally directional/illustrative and are meant to demonstrate the expected call sequence, not production-ready runnable code. When reviewing these files, do not flag missing `try/except` (Python) or `try/catch` (JS/TS) error handling solely because the snippet omits it—focus on whether the call sequence/pattern is conveyed clearly.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-22T04:05:02.920Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:143-237
Timestamp: 2026-04-22T04:05:02.920Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the MCP tool calling SDK examples (`list_scoped_tools` / `execute_tool`, under the "MCP tool calling" section) only include Node.js and Python tabs because Go and Java SDK support for this functionality is not yet available. Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for MCP tool calling in bring-your-own-connector docs until those SDKs support the feature.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-09T15:06:49.617Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-01T08:35:26.973Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:55-117
Timestamp: 2026-04-01T08:35:26.973Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx` and Agent Auth connected accounts documentation (src/content/docs/agent-auth/**/*.mdx), only Python and Node.js SDK support is currently available for Agent Auth features (including connected accounts magic link creation and user verification). Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for these files. Add Go and Java TabItems once those SDKs support Agent Auth/connected account features.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdxsrc/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-02-26T07:20:46.903Z
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.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-13T03:44:23.786Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/youtube.mdx:19-26
Timestamp: 2026-03-13T03:44:23.786Z
Learning: In src/content/docs/reference/agent-connectors/*.mdx files, small raw HTML <div> blocks used for the connector header grid layout (e.g., a 5-column grid with description and logo) are considered readable without a justification comment. Do not flag the absence of a justification comment on these simple connector-header div blocks in agent-connector reference pages.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
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.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-12T05:02:13.454Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 487
File: src/content/docs/agent-auth/connections.mdx:0-0
Timestamp: 2026-03-12T05:02:13.454Z
Learning: In `src/content/docs/agent-auth/connections.mdx` (and Agent Auth docs generally), custom authentication (username/password/bearer-token flows) is intentionally out of scope for the current Agent Auth release. Do not flag the absence of custom authentication connection type documentation in Agent Auth connection-type sections.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-13T03:51:44.897Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdxsrc/components/templates/agent-connectors/_setup-googlecontacts.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/agentkit/connectors/googlecontacts.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/agentkit/connectors/googlecontacts.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/agentkit/connectors/googlecontacts.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/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In AgentKit documentation MDX files, when showing Python `execute_tool` calls, treat `connection_name` as a supported argument (along with `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid/unsupported parameter in these Python examples.
Applied to files:
src/content/docs/agentkit/connectors/googlecontacts.mdx
📚 Learning: 2026-03-12T16:28:37.168Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:37.168Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, external links should not be flagged for missing target="_blank" and rel="noopener". Plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) is acceptable and intentional in these agent-connector setup templates, following the established pattern across all connector templates in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-12T16:29:08.626Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:08.626Z
Learning: In files matching src/components/templates/agent-connectors/_setup-*.mdx, permit and reflect the branding 'Azure Active Directory' (AAD) as intentional. Do not flag or update these agent-connectors setup templates for references to 'Microsoft Entra ID'. This exception applies only to these setup template files; maintain standard branding elsewhere according to project guidelines.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-10T12:26:38.439Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecontacts.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-googlecontacts.mdx
🔇 Additional comments (3)
src/components/templates/agent-connectors/index.ts (1)
33-33: Connector template exports are correctly wiredLine 33 and Line 96 follow the established export pattern and correctly expose both setup and usage templates.
Also applies to: 96-96
src/components/templates/agent-connectors/_usage-googlecontacts.mdx (1)
1-131: Usage template looks good and consistent with connector patternsThe proxy and
execute_toolexamples are aligned with the new tool names and use the expected SDK variable naming conventions.src/content/docs/agentkit/connectors/googlecontacts.mdx (1)
63-65:⚠️ Potential issue | 🟡 MinorAdd a clear next-step signal at the end of the page
After Line 65, add a short “what’s next” pointer (frontmatter
next, aLinkCard, or a brief paragraph) so readers know where to go after the tool list.As per coding guidelines, “Every page MUST end with a clear 'what's next' signal.”
⛔ Skipped due to learnings
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: 476 File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99 Timestamp: 2026-03-10T12:26:38.439Z Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-04-20T11:29:40.242Z Learning: Applies to src/content/docs/**/*.{md,mdx} : Page organization should follow: opening context, optional collapsible supplementary sections, main content sections, and optional closing 'next steps' or summary; closing section may be omitted when frontmatter `prev`/`next` links provide navigationLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: AGENTS.md:0-0 Timestamp: 2026-04-20T11:30:52.410Z Learning: Applies to **/*.{md,mdx} : Page organization SHOULD follow: opening context, optional collapsible supplementary sections, main content sections, and an optional closing 'next steps' or summaryLearnt from: saif-at-scalekit Repo: scalekit-inc/developer-docs PR: 471 File: src/content/docs/dev-kit/ai-assisted-development/context7.mdx:9-10 Timestamp: 2026-03-09T10:26:58.650Z Learning: In scalekit-inc/developer-docs, standalone utility/reference pages under src/content/docs/dev-kit/ that are not part of a sequential product journey (e.g., context7.mdx under dev-kit/ai-assisted-development/) may intentionally use `prev: false` and `next: false` in frontmatter. Do not flag the absence of prev/next navigation or a "what's next" signal on such pages.Learnt from: AkshayParihar33 Repo: scalekit-inc/developer-docs PR: 590 File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83 Timestamp: 2026-04-13T10:43:05.628Z Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: AGENTS.md:0-0 Timestamp: 2026-04-20T11:30:52.410Z Learning: Applies to **/*.{md,mdx} : Opening paragraphs (1–3) MUST state what users will accomplish, when/why they need it, and preview the workflow using direct instructional languageLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: AGENTS.md:0-0 Timestamp: 2026-04-20T11:30:52.410Z Learning: Applies to **/*.{md,mdx} : Use `prev`/`next` for sequential guides; use `seeAlso` for related guides in frontmatterLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-04-20T11:29:40.242Z Learning: Applies to src/content/docs/**/*.{md,mdx} : How-to guides must include Overview, Prerequisites, Procedure (with `<Steps>`), Verify, optional Next Steps, and optional FAQs; Next Steps section may be omitted when frontmatter `prev`/`next` links provide navigation
| <Aside type="caution"> | ||
| Google applications using scopes that permit access to user contact data must complete a verification process before going to production. | ||
| </Aside> |
There was a problem hiding this comment.
Add a title to the caution aside
Line 5 uses <Aside type="caution"> without a title. Add one to keep component usage consistent and accessible.
Suggested fix
-<Aside type="caution">
+<Aside type="caution" title="Verification required">
Google applications using scopes that permit access to user contact data must complete a verification process before going to production.
</Aside>As per coding guidelines, “Use <Aside> component with a title attribute for cautions, tips, and notes.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/components/templates/agent-connectors/_setup-googlecontacts.mdx` around
lines 5 - 7, The <Aside> component instance using type="caution" is missing a
title attribute; update the <Aside type="caution"> element in
_setup-googlecontacts.mdx to include a descriptive title (e.g., title="Caution")
so the component usage is consistent and accessible, ensuring the title text
conveys the warning about Google app verification and follows the project's
wording/style guidelines.
| --- | ||
| title: Google Contacts | ||
| tableOfContents: true | ||
| connectorIcon: https://cdn.scalekit.com/sk-connect/assets/provider-icons/googlecontacts.svg | ||
| connectorAuthType: OAuth 2.0 | ||
| connectorCategories: [productivity] | ||
| head: | ||
| - tag: style | ||
| content: | | ||
| .sl-markdown-content h2 { | ||
| font-size: var(--sl-text-xl); | ||
| } | ||
| --- |
There was a problem hiding this comment.
Add required frontmatter metadata
Line 1–13 is missing description and sidebar.label, which are required for docs pages in this path.
Suggested frontmatter update
---
title: Google Contacts
+description: Connect Google Contacts to your agent and use proxy APIs or tools for contacts, groups, and directory operations.
+sidebar:
+ label: Google Contacts
tableOfContents: true
connectorIcon: https://cdn.scalekit.com/sk-connect/assets/provider-icons/googlecontacts.svg
connectorAuthType: OAuth 2.0
connectorCategories: [productivity]As per coding guidelines, “Every documentation page must include frontmatter with at least: title (≤60 chars), description (≤160 chars), and sidebar.label (1-3 words).”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/content/docs/agentkit/connectors/googlecontacts.mdx` around lines 1 - 13,
The frontmatter for the Google Contacts doc (the YAML block starting with title:
Google Contacts) is missing the required description and sidebar.label fields;
update that frontmatter to include a concise description (≤160 characters) and a
sidebar.label of 1–3 words (and ensure title remains ≤60 chars), e.g., add
description: "..." and sidebar.label: "Google Contacts" near the top of the
existing frontmatter so the page meets the documentation guidelines.
| description: "Update an existing contact. Requires the contact's etag for optimistic locking.", | ||
| params: [ | ||
| { | ||
| name: 'person_id', | ||
| type: 'string', | ||
| required: true, | ||
| description: 'The person ID. Get from googlecontacts_contacts_list.', | ||
| }, | ||
| { | ||
| name: 'update_person_fields', | ||
| type: 'string', | ||
| required: true, | ||
| description: 'Comma-separated fields to update (e.g. names,emailAddresses,phoneNumbers)', | ||
| }, | ||
| { | ||
| name: 'etag', | ||
| type: 'string', | ||
| required: false, | ||
| description: | ||
| 'Current etag for optimistic concurrency. Get from googlecontacts_contact_get.', | ||
| }, |
There was a problem hiding this comment.
Make etag requirement consistent in contact update docs
Line 103 says update “requires” etag, but Line 120 marks etag as optional. Keep one contract to avoid integration errors.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/data/agent-connectors/googlecontacts.ts` around lines 103 - 123, The docs
are inconsistent: the operation description says an etag is required for updates
but the params list has etag as required: false; update the params entry for
'etag' to required: true so it matches the operation description "Update an
existing contact. Requires the contact's etag for optimistic locking.", keeping
the existing 'etag' description text and leaving 'person_id' and
'update_person_fields' unchanged.
| name: 'googlecontacts_contacts_batch_delete', | ||
| description: 'Permanently delete up to 500 contacts in a single request.', | ||
| params: [ | ||
| { | ||
| name: 'resource_names', | ||
| type: 'string', | ||
| required: true, | ||
| description: | ||
| 'A contact resource name to delete in the format "people/<id>". Get from googlecontacts_contacts_list.', | ||
| }, |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
`For Google People API, what is the request parameter shape for:
- people.batchGet
- contactGroups.batchGet
- people:batchDeleteContacts
Specifically, does each endpoint accept multiple resource names as repeated values / arrays, or a single string?`
💡 Result:
- people.batchGet (also referred to as people.getBatchGet in some docs): Accepts multiple resource names as a repeated query parameter resourceNames[] (array of strings). Up to 200 resource names. Example: resourceNames=people/me&resourceNames=people/abc. 2) contactGroups.batchGet: Accepts multiple resource names as a repeated query parameter resourceNames[] (array of strings). Up to 200 resource names. 3) people:batchDeleteContacts: Accepts multiple resource names as a repeated field resourceNames[] (array of strings) in the JSON request body. Up to 500 resource names. Example body: { "resourceNames": ["people/c123", "people/c456"] }. All three endpoints accept multiple resource names as repeated values/arrays, not single strings.
Citations:
- 1: https://developers.google.com/people/api/rest/v1/people/getBatchGet
- 2: https://developers.google.com/people/api/rest/v1/people/batchDeleteContacts
- 3: https://developers.google.cn/people/api/rest/v1/contactGroups/batchGet
Batch tools incorrectly model resource_names as a single string instead of an array
Lines 236, 443, and 468 define resource_names as type: 'string' in batch operations (googlecontacts_contacts_batch_delete, googlecontacts_groups_batch_get, and googlecontacts_people_batch_get). The Google People API expects these parameters to accept multiple resource names as arrays, not single strings:
people.batchGetaccepts repeatedresourceNames(array, up to 200 items)contactGroups.batchGetaccepts repeatedresourceNames(array, up to 200 items)people:batchDeleteContactsacceptsresourceNamesarray in the JSON body (up to 500 items)
Change type: 'string' to type: 'array' and update descriptions to show array examples (e.g., ["people/c123","people/c456"]).
Suggested fix
{
name: 'googlecontacts_contacts_batch_delete',
@@
{
name: 'resource_names',
- type: 'string',
+ type: 'array',
required: true,
- description:
- 'A contact resource name to delete in the format "people/<id>". Get from googlecontacts_contacts_list.',
+ description:
+ 'Array of contact resource names to delete (e.g. ["people/c123","people/c456"]). Get from googlecontacts_contacts_list.',
},
@@
{
name: 'googlecontacts_groups_batch_get',
@@
{
name: 'resource_names',
- type: 'string',
+ type: 'array',
required: true,
description:
- 'A contact group resource name in the format "contactGroups/<id>" (e.g. contactGroups/myContacts). Get from googlecontacts_groups_list.',
+ 'Array of contact group resource names (e.g. ["contactGroups/myContacts","contactGroups/abc123"]). Get from googlecontacts_groups_list.',
},
@@
{
name: 'googlecontacts_people_batch_get',
@@
{
name: 'resource_names',
- type: 'string',
+ type: 'array',
required: true,
description:
- 'A contact resource name in the format "people/<id>" (e.g. people/c123456789). Get from googlecontacts_contacts_list.',
+ 'Array of contact resource names in the format "people/<id>" (e.g. ["people/c123456789"]). Get from googlecontacts_contacts_list.',
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| name: 'googlecontacts_contacts_batch_delete', | |
| description: 'Permanently delete up to 500 contacts in a single request.', | |
| params: [ | |
| { | |
| name: 'resource_names', | |
| type: 'string', | |
| required: true, | |
| description: | |
| 'A contact resource name to delete in the format "people/<id>". Get from googlecontacts_contacts_list.', | |
| }, | |
| name: 'googlecontacts_contacts_batch_delete', | |
| description: 'Permanently delete up to 500 contacts in a single request.', | |
| params: [ | |
| { | |
| name: 'resource_names', | |
| type: 'array', | |
| required: true, | |
| description: | |
| 'Array of contact resource names to delete (e.g. ["people/c123","people/c456"]). Get from googlecontacts_contacts_list.', | |
| }, |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/data/agent-connectors/googlecontacts.ts` around lines 232 - 241, The
batch tools googlecontacts_contacts_batch_delete,
googlecontacts_groups_batch_get, and googlecontacts_people_batch_get incorrectly
declare the resource_names param as type: 'string'; change each resource_names
param to type: 'array' and update its description to indicate an array of
resource names (e.g., ["people/c123","people/c456"]) and note API limits
(people.batchGet/contactGroups.batchGet up to 200 items,
people:batchDeleteContacts up to 500 items) so callers send arrays rather than a
single string.
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…tacts images; add etag docs
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/components/templates/agent-connectors/_usage-googlecontacts.mdx (1)
163-166:⚠️ Potential issue | 🟠 MajorAdd the required
## Scalekit Toolsanchor at the end of the usage template.This template is missing the trailing structural heading used by the parent connector page to append/render the tool list section.
Suggested fix
<Aside type="caution" title="Do not cache etags"> Always use the etag from the most recent `contact_get` or `group_get` response. A stale etag causes the API to reject the update. </Aside> + +## Scalekit ToolsBased on learnings: “In
src/components/templates/agent-connectors/_usage-*.mdxusage template files, keep the trailing## Scalekit Toolsheading at the end of each template… it is an intentional structural anchor used by the parent connector reference page.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_usage-googlecontacts.mdx` around lines 163 - 166, The usage template is missing the required trailing structural heading; add a single line heading "## Scalekit Tools" at the end of the _usage-googlecontacts.mdx template so the parent connector page can append/render the tool list section—that is, open the _usage-googlecontacts.mdx file and append the exact heading "## Scalekit Tools" as the final line.
🤖 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/components/templates/agent-connectors/_usage-googlecontacts.mdx`:
- Line 164: Update the caution text to reference the connector's actual tool
names: replace occurrences of contact_get and group_get with
googlecontacts_contact_get and googlecontacts_group_get so the guidance
consistently instructs users to use the etag from the most recent
googlecontacts_contact_get or googlecontacts_group_get response; ensure the
wording remains a caution about stale etags causing API rejects and that both
full tool names appear exactly as used elsewhere in the connector docs.
---
Outside diff comments:
In `@src/components/templates/agent-connectors/_usage-googlecontacts.mdx`:
- Around line 163-166: The usage template is missing the required trailing
structural heading; add a single line heading "## Scalekit Tools" at the end of
the _usage-googlecontacts.mdx template so the parent connector page can
append/render the tool list section—that is, open the _usage-googlecontacts.mdx
file and append the exact heading "## Scalekit Tools" as the final line.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: af5b9187-a98c-407f-bfa6-2f5b2e37cd1f
⛔ Files ignored due to path filters (2)
src/assets/docs/agent-connectors/googlecontacts/enable-people-api.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/googlecontacts/use-own-credentials-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (1)
src/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.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
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- 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...
Files:
src/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdx
🧠 Learnings (20)
📓 Common learnings
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:46.707Z
Learning: In `src/components/templates/agent-connectors/`, it is acceptable and intentional to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., `oauth-web-app.png`, `add-redirect-uri.png`) in other Google-service connector templates (e.g., `_setup-bigquery.mdx`, `_setup-google-ads.mdx`, etc.). Do not flag cross-connector image path reuse within the Google service connectors as an issue.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
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/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/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: 489
File: src/content/docs/reference/agent-connectors/youtube.mdx:19-26
Timestamp: 2026-03-13T03:44:23.786Z
Learning: In src/content/docs/reference/agent-connectors/*.mdx files, small raw HTML <div> blocks used for the connector header grid layout (e.g., a 5-column grid with description and logo) are considered readable without a justification comment. Do not flag the absence of a justification comment on these simple connector-header div blocks in agent-connector reference pages.
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.
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:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
📚 Learning: 2026-02-26T07:21:37.207Z
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.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, keep the trailing `## Scalekit Tools` heading at the end of each template. Do not flag it as empty or as a duplicate heading in future reviews for these files, since it is an intentional structural anchor used by the parent connector reference page to append the tool-list section beneath the proxy API examples.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-02-26T07:22:55.583Z
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.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-25T15:59:47.933Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:47.933Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, the code snippets are intentionally directional/illustrative and are meant to demonstrate the expected call sequence, not production-ready runnable code. When reviewing these files, do not flag missing `try/except` (Python) or `try/catch` (JS/TS) error handling solely because the snippet omits it—focus on whether the call sequence/pattern is conveyed clearly.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-28T14:43:55.084Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 646
File: src/content/docs/agentkit/connectors/salesforce.mdx:96-112
Timestamp: 2026-04-28T14:43:55.084Z
Learning: In `src/content/docs/agentkit/connectors/salesforce.mdx`, the three Python code snippets under the "Metadata API SOAP proxy calls" section (Steps 1–3) are intentionally illustrative/guiding code. Do not require try/except error handling in these snippets; customers are expected to add error handling appropriate to their own use case. This applies alongside the existing guidance that no `title=` attribute is needed on these code blocks.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
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.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-03T13:35:56.400Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-22T04:05:02.920Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:143-237
Timestamp: 2026-04-22T04:05:02.920Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the MCP tool calling SDK examples (`list_scoped_tools` / `execute_tool`, under the "MCP tool calling" section) only include Node.js and Python tabs because Go and Java SDK support for this functionality is not yet available. Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for MCP tool calling in bring-your-own-connector docs until those SDKs support the feature.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-09T15:06:49.617Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-28T14:33:57.957Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 646
File: src/content/docs/agentkit/connectors/salesforce.mdx:71-132
Timestamp: 2026-04-28T14:33:57.957Z
Learning: In `src/content/docs/agentkit/connectors/salesforce.mdx`, the "Metadata API SOAP proxy calls" section uses Python-only code examples because the Salesforce SOAP proxy feature is currently only available in the Python SDK. Do not require or enforce Node.js, Go, and Java tabs in `<Tabs syncKey="tech-stack">` blocks for this section until those SDKs support the Salesforce SOAP proxy feature.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-27T07:13:50.465Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:50.465Z
Learning: In `src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx`, the Python SDK's `execute_tool` function accepts `connection_name` as a valid parameter (in addition to `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid or unsupported parameter in Python `execute_tool` calls in AgentKit documentation.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.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/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/components/templates/agent-connectors/_usage-googlecontacts.mdx
| ``` | ||
|
|
||
| <Aside type="caution" title="Do not cache etags"> | ||
| Always use the etag from the most recent `contact_get` or `group_get` response. A stale etag causes the API to reject the update. |
There was a problem hiding this comment.
Use full tool names in the caution text for consistency and copy/paste safety.
contact_get and group_get do not match the connector’s actual tool names used elsewhere on this page. Use googlecontacts_contact_get and googlecontacts_group_get to avoid confusion.
Suggested fix
- Always use the etag from the most recent `contact_get` or `group_get` response. A stale etag causes the API to reject the update.
+ Always use the etag from the most recent `googlecontacts_contact_get` or `googlecontacts_group_get` response. A stale etag causes the API to reject the update.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/components/templates/agent-connectors/_usage-googlecontacts.mdx` at line
164, Update the caution text to reference the connector's actual tool names:
replace occurrences of contact_get and group_get with googlecontacts_contact_get
and googlecontacts_group_get so the guidance consistently instructs users to use
the etag from the most recent googlecontacts_contact_get or
googlecontacts_group_get response; ensure the wording remains a caution about
stale etags causing API rejects and that both full tool names appear exactly as
used elsewhere in the connector docs.
1 participant
Summary
Preview
https://deploy-preview-637--scalekit-starlight.netlify.app/agentkit/connectors/googlecontacts/
Summary by CodeRabbit
New Features
Documentation