Brave search connecter and tools#521
Merged
Pranesh-Raghu merged 6 commits intoMar 24, 2026
Merged
Conversation
…etup guide, usage examples, and assets
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
Contributor
WalkthroughAdds three Brave Search documentation pages: setup and usage MDX templates and a reference page; updates agent-connectors template index to export the new setup/usage sections. All changes are documentation-only except the index re-exports. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 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-brave-search.mdx`:
- Around line 76-78: The <Aside type="tip"> component is missing a title
attribute—add a concise, descriptive title (e.g., title="Production tip" or
title="Call upsertConnectedAccount") to the <Aside> element so the tip is
accessible and easier to scan; update the <Aside type="tip"> instance in the
file to include the title attribute while keeping the existing content
unchanged.
In `@src/components/templates/agent-connectors/_usage-brave-search.mdx`:
- Around line 67-69: The <Aside> component at the tip about Brave Search is
missing a title attribute; update the <Aside> element (the one starting with
<Aside type="tip">) to include a concise title like title="Tip" or title="Brave
Search Tip" to satisfy the accessibility guideline requiring a title on <Aside>
components—keep the existing type="tip" and inner content unchanged.
- Line 5: Replace the unhyphenated compound modifier "Scalekit optimized tool
calls" with the hyphenated form "Scalekit-optimized tool calls" in the agent
connectors usage text (the sentence containing "You can interact with Brave
Search in two ways — via direct proxy API calls or via Scalekit optimized tool
calls."). Ensure the phrase is updated exactly to "Scalekit-optimized tool
calls" for improved readability.
In `@src/content/docs/reference/agent-connectors/brave-search.mdx`:
- Line 27: Replace the provider icon URL used in the <img> tag for the Brave
Search connector: update the src value that currently uses "cdn.scalekit.cloud"
to use the required host
"https://cdn.scalekit.com/sk-connect/assets/provider-icons/brave-search.svg"
(i.e., swap the domain to cdn.scalekit.com) in the brave-search.mdx image
element so the connector page loads assets from the correct CDN host.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: e9e91d28-6799-46bc-9dd9-a95588e5adac
⛔ Files ignored due to path filters (3)
src/assets/docs/agent-connectors/brave-search/add-connected-account.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/brave-search/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/brave-search/create-api-key.pngis excluded by!**/*.png
📒 Files selected for processing (4)
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/reference/agent-connectors/brave-search.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (7)
**/*.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/components/templates/agent-connectors/_usage-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
**/*.{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.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.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.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.ts
🧠 Learnings (43)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
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: 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.
📚 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/_usage-brave-search.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.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/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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 in general), 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 documentation in Agent Auth connection-type sections.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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/_usage-brave-search.mdxsrc/components/templates/agent-connectors/index.ts
📚 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-brave-search.mdxsrc/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/index.tssrc/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-13T04:24:59.653Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-11T07:12:09.681Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 480
File: src/content/docs/404.mdx:17-18
Timestamp: 2026-03-11T07:12:09.681Z
Learning: In scalekit-inc/developer-docs, `pagefind: false` is set in astro.config.mjs, but Algolia search takes over as the site-wide search UI. This means the search bar is still visible and functional on all pages (including the custom 404 page). Do not flag references to "search bar" in page copy as invalid on the grounds that pagefind is disabled.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.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-brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.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-brave-search.mdxsrc/components/templates/agent-connectors/_setup-brave-search.mdx
📚 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/components/templates/agent-connectors/_setup-brave-search.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-10T10:38:36.402Z
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:36.402Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` template files, empty alt text `![]()` is the established pattern for redirect URI screenshot images. Do not flag missing alt text on `![]()` markdown image syntax in these agent connector setup template files.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 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/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-10T10:38:35.371Z
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:35.371Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text `![]()` for redirect URI screenshots (e.g., `use-own-credentials-redirect-uri.png`) is a deliberate and consistent pattern across all connector setup template files. Do not flag missing alt text on these images in future reviews of files under `src/components/templates/agent-connectors/`.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 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-brave-search.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-brave-search.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-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides located in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages and use reusable content components in `src/components/templates/`
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-02-26T07:21:32.951Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:32.951Z
Learning: For agent-connectors reference MDX files, use H2 headings (##) for tool sections (e.g., googlesheets_create_spreadsheet, googlesheets_get_values) so they appear in the table of contents. This is a deliberate UX choice and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:20:42.107Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:42.107Z
Learning: In src/content/docs/reference/agent-connectors/**, these auto-generated agent connector reference pages (e.g., googlemeet.mdx) are lookup resources. Do not require or enforce the 'what's next' signal (next link, LinkCard, or concluding paragraph) for these pages; treat them as non-sequential references produced by scripts (scripts/sync-agent-connectors.js).
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:22:49.128Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:49.128Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Do not manually edit the generated MDX files. Update scripts/sync-agent-connectors.js to output a four-column table with headers Name | Type | Required | Description for all parameter tables, ensuring consistency with the coding guidelines. This pattern should apply to all MDX files in that directory.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:18:41.518Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:41.518Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, the sidebar.label frontmatter is not required because navigation is auto-generated from this directory via the central sidebar config. Do not rely on or modify sidebar.label in these files; ensure ordering and grouping are defined in the shared sidebar configuration.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-13T03:44:16.883Z
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:16.883Z
Learning: In MDX files under src/content/docs/reference/agent-connectors, specifically simple connector-header div blocks used for the header grid layout (e.g., a 5-column grid with description and logo), treat the absence of a justification comment as acceptable/readable. Do not flag or require a justification comment for these simple header div blocks in agent-connector reference pages.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:23:24.179Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:24.179Z
Learning: Do not enforce the 160-character description limit for MDX files under src/content/docs/reference/agent-connectors/. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may contain longer descriptions sourced from the data.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-03T13:35:47.638Z
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:47.638Z
Learning: In Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), only Python SDK examples for Agent Actions/Agent Connectors should be required for now. Do not enforce or require multi-language SDK code examples (Node.js, Python, Go, Java) until the respective SDKs support Agent Actions. Once supported, you can add and require other languages in those docs. This guideline applies to all files under the agent-connectors documentation path.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-13T03:51:40.660Z
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:40.660Z
Learning: In src/content/docs/reference/agent-connectors/**, enforce using CDN URLs for provider-icon 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 host should be cdn.scalekit.com (not cdn.scalekit.cloud). Do not flag or modify image src attributes that already use cdn.scalekit.com for provider icons within this directory.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
🪛 LanguageTool
src/components/templates/agent-connectors/_usage-brave-search.mdx
[grammar] ~5-~5: Use a hyphen to join words.
Context: ...a direct proxy API calls or via Scalekit optimized tool calls. Scroll down to see...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (3)
src/components/templates/agent-connectors/index.ts (1)
6-6: Brave Search template exports are correctly wiredBoth new exports are consistent with the existing index pattern and correctly expose setup and usage sections.
Also applies to: 54-54
src/components/templates/agent-connectors/_setup-brave-search.mdx (1)
55-74:⚠️ Potential issue | 🟠 MajorAdd Go/Java tabs and explicit error paths in setup code examples
Line 55–74 includes only Node.js and Python, and both snippets show only the happy path. Add Go and Java tabs and include explicit failure handling in each sample to match the docs standard for SDK examples.
As per coding guidelines: “All code examples MUST include Node.js, Python, Go, and Java implementations… Examples must show both success and error handling paths.”
⛔ Skipped due to learnings
Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : All code examples MUST include Node.js, Python, Go, and Java implementations with consistent variable naming conventions. Examples must show both success and error handling paths. Security implications must be explained for each implementation.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.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Approximately 90% of code examples MUST include all four languages (Node.js, Python, Go, Java). Exceptions are allowed for API reference documentation where cURL requests or SDK-less language-specific snippets may be used.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps componentsLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent Tab labels for multi-language examples: 'Node.js', 'Python', 'Go', 'Java' with TabItem values 'node', 'python'/'py', 'go'/'golang', 'java'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">`.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Ensure code examples are runnable (or clearly marked as placeholders) and include error handling where appropriateLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Always include error handling in code examples showing both success and error pathsLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`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.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use `<Tabs syncKey="tech-stack">` format for multi-language SDK samples in documentationLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use `<Tabs syncKey="tech-stack">` to synchronize multi-language code selection across documentation pagesLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'Learnt from: dhaneshbs Repo: scalekit-inc/developer-docs PR: 514 File: src/content/docs/agent-auth/quickstart.mdx:82-82 Timestamp: 2026-03-20T02:32:40.836Z Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursor/rules/documentation-guide.mdc:0-0 Timestamp: 2026-01-13T12:48:11.566Z Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possiblesrc/components/templates/agent-connectors/_usage-brave-search.mdx (1)
9-65:⚠️ Potential issue | 🟠 MajorExpand proxy examples to all SDK languages and include error handling
Line 9–65 currently documents only Node.js and Python and omits explicit error paths. Add Go and Java tabs and include success/error handling per language.
As per coding guidelines: “All code examples MUST include Node.js, Python, Go, and Java implementations… Examples must show both success and error handling paths.”
⛔ Skipped due to learnings
Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : All code examples MUST include Node.js, Python, Go, and Java implementations with consistent variable naming conventions. Examples must show both success and error handling paths. Security implications must be explained for each implementation.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Approximately 90% of code examples MUST include all four languages (Node.js, Python, Go, Java). Exceptions are allowed for API reference documentation where cURL requests or SDK-less language-specific snippets may be used.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.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps componentsLearnt 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">`.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Ensure code examples are runnable (or clearly marked as placeholders) and include error handling where appropriateLearnt 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.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent Tab labels for multi-language examples: 'Node.js', 'Python', 'Go', 'Java' with TabItem values 'node', 'python'/'py', 'go'/'golang', 'java'Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Always include error handling in code examples showing both success and error pathsLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursor/rules/documentation-guide.mdc:0-0 Timestamp: 2026-01-13T12:48:11.566Z Learning: Applies to **/*.{md,mdx} : Ensure code examples reflect current APIs and are tested when possibleLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use `<Tabs syncKey="tech-stack">` format for multi-language SDK samples in documentationLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use `<Tabs syncKey="tech-stack">` to synchronize multi-language code selection across documentation pagesLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursor/rules/documentation-guide.mdc:0-0 Timestamp: 2026-01-13T12:48:11.566Z Learning: Applies to **/*.mdx : Use Tabs/TabItem components for multi-language or multi-framework examples in MDX documentation
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…ixes, and what you can build section - Fix CDN URL (cdn.scalekit.cloud → cdn.scalekit.com) and icon path (brave-search.svg → brave.svg) - Add sidebar.label and tags to frontmatter - Add 'What you can build' collapsible section with use-case table and key concepts - Fix Aside titles in _setup-brave-search.mdx (CodeRabbit compliance) - Fix Aside title in _usage-brave-search.mdx - Fix heading case: 'Scalekit Tools' → 'Scalekit tools' - Populate empty Scalekit tools section with 6 Python-only examples: web search, news search, LLM grounding context, AI chat completions, local place search + POI details, AI summarizer with follow-ups - Add LangChain integration example
…go in screenshots Update add-credentials.png and add-connected-account.png to show the official Brave orange lion shield icon instead of the generic placeholder.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
src/components/templates/agent-connectors/_usage-brave-search.mdx (1)
5-5:⚠️ Potential issue | 🟡 MinorUse a hyphen in the compound modifier
At Line 5, change “Scalekit optimized tool calls” to “Scalekit-optimized tool calls” for readability.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/components/templates/agent-connectors/_usage-brave-search.mdx` at line 5, Update the compound modifier phrase "Scalekit optimized tool calls" to use a hyphenated form "Scalekit-optimized tool calls" in the text location that currently reads "You can interact with Brave Search in two ways — via direct proxy API calls or via Scalekit optimized tool calls." to improve readability; locate the exact string "Scalekit optimized tool calls" in the _usage-brave-search.mdx content and replace it with "Scalekit-optimized tool calls".
🤖 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-brave-search.mdx`:
- Around line 6-7: Update the step headings inside the Steps component to use
the repository pattern `1. ## Title` (not `1. ### Title`) and ensure all step
content is indented with exactly 3 spaces; specifically change the heading "1.
### Get a Brave Search API key" to "1. ## Get a Brave Search API key" and apply
the same change for the other Step headings referenced (lines corresponding to
the second and third steps), and re-indent their content blocks to three spaces
so they match the `Steps` component formatting convention.
---
Duplicate comments:
In `@src/components/templates/agent-connectors/_usage-brave-search.mdx`:
- Line 5: Update the compound modifier phrase "Scalekit optimized tool calls" to
use a hyphenated form "Scalekit-optimized tool calls" in the text location that
currently reads "You can interact with Brave Search in two ways — via direct
proxy API calls or via Scalekit optimized tool calls." to improve readability;
locate the exact string "Scalekit optimized tool calls" in the
_usage-brave-search.mdx content and replace it with "Scalekit-optimized tool
calls".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: a2e5cf52-4326-4e81-8f1f-43a80b8ad4e2
⛔ Files ignored due to path filters (2)
src/assets/docs/agent-connectors/brave-search/add-connected-account.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/brave-search/add-credentials.pngis excluded by!**/*.png
📒 Files selected for processing (3)
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
📜 Review details
🧰 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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
🧠 Learnings (57)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
📚 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-brave-search.mdx
📚 Learning: 2026-03-11T07:12:09.681Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 480
File: src/content/docs/404.mdx:17-18
Timestamp: 2026-03-11T07:12:09.681Z
Learning: In scalekit-inc/developer-docs, `pagefind: false` is set in astro.config.mjs, but Algolia search takes over as the site-wide search UI. This means the search bar is still visible and functional on all pages (including the custom 404 page). Do not flag references to "search bar" in page copy as invalid on the grounds that pagefind is disabled.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides located in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages and use reusable content components in `src/components/templates/`
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.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-brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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 in general), 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 documentation in Agent Auth connection-type sections.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Always include a `title` attribute for `<Aside>` components for accessibility and clarity
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use Aside component for notes, warnings, and tips in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.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-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use Aside components for important notes, tips, and warnings in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-12T16:29:33.506Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:28-28
Timestamp: 2026-03-12T16:29:33.506Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text (`![]()`) is acceptable for ALL inline images (not just redirect URI screenshots), including API-enablement screenshots such as `enable-bigquery-api.png`. Do not flag missing alt text for any inline image in these agent-connector setup template files.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Use asides for important notes, tips, cautions, and references in documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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/_setup-brave-search.mdxsrc/components/templates/agent-connectors/_usage-brave-search.mdx
📚 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/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.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-brave-search.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-brave-search.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/components/templates/agent-connectors/_usage-brave-search.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/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-20T02:32:40.836Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 514
File: src/content/docs/agent-auth/quickstart.mdx:82-82
Timestamp: 2026-03-20T02:32:40.836Z
Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-13T04:24:59.653Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-02-02T08:57:38.862Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/single-page-app.mdx:0-0
Timestamp: 2026-02-02T08:57:38.862Z
Learning: In Scalekit documentation, "single page application" (and its variants) should remain unhyphenated, even though standard grammar rules suggest hyphenating compound adjectives. Keep it as "single page application" not "single-page application".
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-10T10:38:36.402Z
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:36.402Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` template files, empty alt text `![]()` is the established pattern for redirect URI screenshot images. Do not flag missing alt text on `![]()` markdown image syntax in these agent connector setup template files.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdxsrc/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-16T21:02:51.181Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-03-16T21:02:51.181Z
Learning: Applies to **/*.mdx : Provide a `title` prop in `<Code>` component when the snippet represents a file
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.mdx
📚 Learning: 2026-03-05T11:29:12.786Z
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:12.786Z
Learning: In `src/content/docs/agent-auth/providers.mdx`, the `<Card>` components use `icon=" "` (a space) intentionally. This is a deliberate UX choice to render consistent colored boxes across all cards, because only some Starlight icon names resolve to actual icons while others do not. Do not flag `icon=" "` as a placeholder issue on this file.
Applied to files:
src/components/templates/agent-connectors/_usage-brave-search.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-brave-search.mdx
📚 Learning: 2026-02-26T07:21:32.951Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:32.951Z
Learning: For agent-connectors reference MDX files, use H2 headings (##) for tool sections (e.g., googlesheets_create_spreadsheet, googlesheets_get_values) so they appear in the table of contents. This is a deliberate UX choice and should not be flagged as a hierarchy issue.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:22:49.128Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:95-141
Timestamp: 2026-02-26T07:22:49.128Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, parameter tables are auto-generated from JSON API responses by scripts/sync-agent-connectors.js. Do not manually edit the generated MDX files. Update scripts/sync-agent-connectors.js to output a four-column table with headers Name | Type | Required | Description for all parameter tables, ensuring consistency with the coding guidelines. This pattern should apply to all MDX files in that directory.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:23:24.179Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:24.179Z
Learning: Do not enforce the 160-character description limit for MDX files under src/content/docs/reference/agent-connectors/. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may contain longer descriptions sourced from the data.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-13T03:44:16.883Z
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:16.883Z
Learning: In MDX files under src/content/docs/reference/agent-connectors, specifically simple connector-header div blocks used for the header grid layout (e.g., a 5-column grid with description and logo), treat the absence of a justification comment as acceptable/readable. Do not flag or require a justification comment for these simple header div blocks in agent-connector reference pages.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:18:41.518Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:41.518Z
Learning: For MDX files under src/content/docs/reference/agent-connectors, the sidebar.label frontmatter is not required because navigation is auto-generated from this directory via the central sidebar config. Do not rely on or modify sidebar.label in these files; ensure ordering and grouping are defined in the shared sidebar configuration.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-26T07:20:42.107Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:42.107Z
Learning: In src/content/docs/reference/agent-connectors/**, these auto-generated agent connector reference pages (e.g., googlemeet.mdx) are lookup resources. Do not require or enforce the 'what's next' signal (next link, LinkCard, or concluding paragraph) for these pages; treat them as non-sequential references produced by scripts (scripts/sync-agent-connectors.js).
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.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/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Structure documentation content with clear headings for better search understanding
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-13T03:51:40.660Z
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:40.660Z
Learning: In src/content/docs/reference/agent-connectors/**, enforce using CDN URLs for provider-icon 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 host should be cdn.scalekit.com (not cdn.scalekit.cloud). Do not flag or modify image src attributes that already use cdn.scalekit.com for provider icons within this directory.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-10T10:38:35.371Z
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:35.371Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text `![]()` for redirect URI screenshots (e.g., `use-own-credentials-redirect-uri.png`) is a deliberate and consistent pattern across all connector setup template files. Do not flag missing alt text on these images in future reviews of files under `src/components/templates/agent-connectors/`.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.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/content/docs/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.mdx
📚 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/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.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/reference/agent-connectors/brave-search.mdx
📚 Learning: 2026-03-03T13:35:47.638Z
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:47.638Z
Learning: In Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), only Python SDK examples for Agent Actions/Agent Connectors should be required for now. Do not enforce or require multi-language SDK code examples (Node.js, Python, Go, Java) until the respective SDKs support Agent Actions. Once supported, you can add and require other languages in those docs. This guideline applies to all files under the agent-connectors documentation path.
Applied to files:
src/content/docs/reference/agent-connectors/brave-search.mdx
🪛 LanguageTool
src/components/templates/agent-connectors/_usage-brave-search.mdx
[grammar] ~5-~5: Use a hyphen to join words.
Context: ...a direct proxy API calls or via Scalekit optimized tool calls. Scroll down to see...
(QB_NEW_EN_HYPHEN)
- Shorten description to ≤160 chars - Add intro text to empty ## Tool list section - Fix unused connected_account variable (use as statement, not assignment) - Fix upsertConnectedAccount → snake_case/camelCase both mentioned in Aside - Replace deprecated initialize_agent with create_tool_calling_agent + AgentExecutor
…mponent Change step headings from ### to ## per repository convention and re-indent all step content from 4 spaces to 3 spaces as required by the Starlight Steps component formatting rules.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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-brave-search.mdx`:
- Around line 57-71: The snippets only show the success path; update the
TypeScript and Python examples around the upsertConnectedAccount /
upsert_connected_account calls (scalekit.actions.upsertConnectedAccount and
scalekit_client.actions.upsert_connected_account) to include explicit error
handling: wrap the call in a try/catch (TS) or try/except (Python), log or print
a clear failure message including the caught error, and keep the original
success call intact so both success and error paths are demonstrated for
production guidance.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7dbf3844-d94c-4d52-b214-18c3d233ce4f
📒 Files selected for processing (1)
src/components/templates/agent-connectors/_setup-brave-search.mdx
📜 Review details
🧰 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/_setup-brave-search.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- How-to guides MUST contain numbered
<Steps>(Starlight component).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs: Node.js, Python, Go, Java — using<Tabs syncKey="tech-stack">.- SDK variable names are STRICTLY:
scalekit(Node.js),
scalekit_client(Python),scalekitClient(Go), ...
Files:
src/components/templates/agent-connectors/_setup-brave-search.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/_setup-brave-search.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/_setup-brave-search.mdx
🧠 Learnings (30)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 0
File: :0-0
Timestamp: 2026-03-13T04:24:59.653Z
Learning: In scalekit-inc/developer-docs, for PRs focused on tooling and templatizing (e.g., extracting usage sections into reusable MDX templates and updating sync scripts), review comments about .mdx file content quality (casing, unused imports, import consolidation, endpoint descriptions, etc.) are considered out of scope and should be resolved without blocking the PR.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Keep documentation synchronized with product changes
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Structure documentation content with clear headings for better search understanding
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: 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: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Test MDX documentation locally before committing to catch parsing and Steps component indentation errors
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: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Prefer relative links for internal documentation pages and include anchors for section references
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: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.{md,mdx} : Provide links to related concepts, guides, and references in documentation
📚 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-brave-search.mdx
📚 Learning: 2026-03-11T07:12:09.681Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 480
File: src/content/docs/404.mdx:17-18
Timestamp: 2026-03-11T07:12:09.681Z
Learning: In scalekit-inc/developer-docs, `pagefind: false` is set in astro.config.mjs, but Algolia search takes over as the site-wide search UI. This means the search bar is still visible and functional on all pages (including the custom 404 page). Do not flag references to "search bar" in page copy as invalid on the grounds that pagefind is disabled.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides located in `src/content/docs/guides/integrations/` MUST be kept synchronized with their index pages and use reusable content components in `src/components/templates/`
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Include configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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-brave-search.mdx
📚 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/_setup-brave-search.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/_setup-brave-search.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/_setup-brave-search.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 in general), 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 documentation in Agent Auth connection-type sections.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Always include a `title` attribute for `<Aside>` components for accessibility and clarity
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:48:11.566Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/documentation-guide.mdc:0-0
Timestamp: 2026-01-13T12:48:11.566Z
Learning: Applies to **/*.mdx : Use Aside component for notes, warnings, and tips in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use Aside components for important notes, tips, and warnings in MDX documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-12T16:29:33.506Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:28-28
Timestamp: 2026-03-12T16:29:33.506Z
Learning: In `src/components/templates/agent-connectors/_setup-*.mdx` files, empty alt text (`![]()`) is acceptable for ALL inline images (not just redirect URI screenshots), including API-enablement screenshots such as `enable-bigquery-api.png`. Do not flag missing alt text for any inline image in these agent-connector setup template files.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Use asides for important notes, tips, cautions, and references in documentation
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use numbered format within Steps component: `1. ## Title` with all step content indented with exactly 3 spaces
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Do not use double hash (##) for step headings in Steps components; use numbered format `1. ##` instead
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Each step in Steps component must use numbered format `1. ## Title` with exactly 3-space indentation for all step content
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : The `<Steps>` component requires a single continuous `<ol>`. Numbered steps must start at column 0 with no leading spaces. Continuation content must be indented with exactly 3 spaces. Sub-bullet lists under a step use 3 spaces with no blank line before bullets. No blank line immediately after `<Steps>` opening tag.
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:47:52.148Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/deno-docs-style.mdc:0-0
Timestamp: 2026-01-13T12:47:52.148Z
Learning: Applies to **/*.{md,mdx} : Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Aside components within Steps must be indented with 3 spaces to avoid Steps component parsing errors
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-03-17T11:36:10.761Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-17T11:36:10.761Z
Learning: Applies to **/*.{md,mdx} : Before publishing documentation, verify: headings use sentence case, pages open with clear summaries, steps use imperative verbs, examples are runnable and minimal, sidebar labels are concise, links are descriptive, terminology is consistent, no filler words, code examples include all 4 languages, SDK variable names follow NON-NEGOTIABLE convention, security implications are explained, frontmatter includes required fields
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Ensure no trailing whitespace on empty lines within Steps components to avoid indentation errors
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use action-oriented headings in step-by-step guides within Steps components
Applied to files:
src/components/templates/agent-connectors/_setup-brave-search.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/_setup-brave-search.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/_setup-brave-search.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/_setup-brave-search.mdx
🔇 Additional comments (1)
src/components/templates/agent-connectors/_setup-brave-search.mdx (1)
55-74:⚠️ Potential issue | 🟠 MajorAdd Go and Java tabs for SDK parity
This SDK example currently includes only Node.js and Python, but repo policy requires all four SDK languages when demonstrating SDK usage.
Suggested update
<Tabs syncKey="tech-stack"> <TabItem label="Node.js"> ```typescript await scalekit.actions.upsertConnectedAccount({ connectionName: 'brave-search', identifier: 'user_123', // your user's unique ID credentials: { api_key: 'BSA...' }, }); ``` </TabItem> <TabItem label="Python"> ```python scalekit_client.actions.upsert_connected_account( connection_name="brave-search", identifier="user_123", credentials={"api_key": "BSA..."} ) ``` </TabItem> + <TabItem label="Go"> + ```go + _, err := scalekitClient.Actions.UpsertConnectedAccount(ctx, &scalekit.UpsertConnectedAccountRequest{ + ConnectionName: "brave-search", + Identifier: "user_123", + Credentials: map[string]string{"api_key": "BSA..."}, + }) + if err != nil { + // handle error + } + ``` + </TabItem> + <TabItem label="Java"> + ```java + try { + scalekitClient.actions().upsertConnectedAccount( + UpsertConnectedAccountRequest.builder() + .connectionName("brave-search") + .identifier("user_123") + .credentials(Map.of("api_key", "BSA...")) + .build() + ); + } catch (Exception e) { + // handle error + } + ``` + </TabItem> </Tabs>As per coding guidelines: “All code examples MUST include Node.js, Python, Go, and Java implementations with consistent variable naming conventions.”
⛔ Skipped due to learnings
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.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">`.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.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names in documentation and code examples: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps componentsLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent Tab labels for multi-language examples: 'Node.js', 'Python', 'Go', 'Java' with TabItem values 'node', 'python'/'py', 'go'/'golang', 'java'Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Approximately 90% of code examples MUST include all four languages (Node.js, Python, Go, Java). Exceptions are allowed for API reference documentation where cURL requests or SDK-less language-specific snippets may be used.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : All code examples MUST include Node.js, Python, Go, and Java implementations with consistent variable naming conventions. Examples must show both success and error handling paths. Security implications must be explained for each implementation.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-03-17T11:36:10.761Z Learning: Applies to **/*.{md,mdx} : Use `<Tabs syncKey="tech-stack">` format for multi-language SDK samples in documentationLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use `<Tabs syncKey="tech-stack">` to synchronize multi-language code selection across documentation pagesLearnt from: dhaneshbs Repo: scalekit-inc/developer-docs PR: 514 File: src/content/docs/agent-auth/quickstart.mdx:82-82 Timestamp: 2026-03-20T02:32:40.836Z Learning: In Agent Auth documentation under src/content/docs/agent-auth/, the Node.js SDK installation command should use the stable package `scalekit-sdk/node` (no version pin). Agent Auth features are now available in the stable release. Do not flag the removal of the `2.2.0-beta.1` beta version pin or suggest adding it back. Any remaining references to the beta version across Agent Auth docs should be updated to use the stable package.
This was referenced Mar 25, 2026
This was referenced Apr 1, 2026
This was referenced Apr 13, 2026
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit