Skip to content

docs: add Databricks Workspace agent connector#590

Merged
ravibits merged 2 commits into
mainfrom
preview/actions-databrics-connector
Apr 13, 2026
Merged

docs: add Databricks Workspace agent connector#590
ravibits merged 2 commits into
mainfrom
preview/actions-databrics-connector

Conversation

@AkshayParihar33
Copy link
Copy Markdown
Contributor

@AkshayParihar33 AkshayParihar33 commented Apr 13, 2026

Summary

  • Adds reference page for the Databricks Workspace agent connector at /reference/agent-connectors/databricks/
  • Adds setup template with steps to create a service principal, generate OAuth secrets, and configure credentials in Scalekit
  • Adds usage template with Node.js and Python proxy API examples
  • Documents all 13 available tools (clusters, jobs, SQL, SCIM, secrets)

Preview

https://deploy-preview-590--scalekit-starlight.netlify.app/reference/agent-connectors/databricks/

Test plan

  • Verify images load on the Databricks connector page
  • Verify all 13 tools are listed correctly
  • Verify setup steps are accurate

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Databricks Workspace connector docs: step-by-step setup guide, usage walkthrough with Node.js and Python examples, and a full reference of available tools for cluster and job management, SCIM/user operations, secret scopes, and SQL execution, including parameter and pagination details.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 13, 2026

Walkthrough

Adds Databricks Workspace agent-connector documentation: new setup and usage MDX templates, exported template components, and a reference page documenting authentication and available tools (clusters, jobs, SCIM, secrets, SQL).

Changes

Cohort / File(s) Summary
Setup & Usage templates
src/components/templates/agent-connectors/_setup-databricks.mdx, src/components/templates/agent-connectors/_usage-databricks.mdx
Added two MDX templates: a 4-step setup guide for configuring Databricks OAuth/service principal and a usage page with proxy API and Scalekit Tools examples (Node.js and Python snippets).
Template exports
src/components/templates/agent-connectors/index.ts
Exported SetupDatabricksSection and UsageDatabricksSection from the new MDX files.
Reference docs
src/content/docs/reference/agent-connectors/databricks.mdx
Added reference page for Databricks Workspace connector with frontmatter, authentication overview, embedded setup/usage sections, and detailed tool listings (cluster, job, SCIM, secrets, SQL operations).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • saif-at-scalekit
  • amitash1912
  • ravibits
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add Databricks Workspace agent connector' directly and clearly describes the main change: adding documentation for a Databricks Workspace agent connector, which is reflected across all four modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch preview/actions-databrics-connector

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/_usage-databricks.mdx`:
- Line 83: Remove the empty top-level heading "Scalekit Tools" from the partial
(the line that reads "## Scalekit Tools") so it no longer produces a
duplicate/empty TOC entry; keep the rest of the template intact since the parent
page already defines the tool-list section.
- Around line 3-5: The docs mix service-principal (M2M) setup with
user-delegated examples: update the Databricks connector documentation to be
consistent by either (A) stating the connector supports user-delegated OAuth and
keep the examples, in which case add setup steps for end-user OAuth and ensure
examples reference getAuthorizationLink / get_authorization_link and explain the
user flow, or (B) clarifying it is M2M-only and replace the getAuthorizationLink
/ get_authorization_link examples with direct client-credentials examples
showing how to obtain and use tokens via the service principal (the connector
class/method names for auth and API calls should be referenced so readers can
map setup to usage). Ensure the chosen mode is reflected in both the setup
section (service principal vs user OAuth) and all usage snippets.

In `@src/content/docs/reference/agent-connectors/databricks.mdx`:
- Line 23: The description string that currently reads “Connect to Databricks
Workspace APIs using a Service Principal with OAuth 2.0 client credentials to
manage clusters, jobs, notebooks, SCIM, secrets, and SQL.” should be updated to
avoid claiming unsupported features: either remove the word “notebooks” from
that sentence, or add documentation and tool references for notebook management
(e.g., a "Notebook tools" section and corresponding API/tool links) so the claim
is accurate; update the sentence and/or add the notebook tools section
accordingly.
- Around line 59-62: Update the `databricksworkspace_cluster_terminate`
description to correctly state Databricks behavior: replace the sentence that
says the cluster "will be deleted and all its associated resources released"
with text that explains terminate transitions the cluster to a TERMINATED state,
is reversible (configuration retained for 30 days unless pinned) and can be
restarted via the start API, and note that only the `/permanent-delete` endpoint
permanently removes the cluster and its configuration; edit the paragraph under
the `databricksworkspace_cluster_terminate` heading accordingly so the
documentation accurately reflects termination vs permanent delete semantics.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1a8db25b-4e73-403f-bff2-76d05f22460d

📥 Commits

Reviewing files that changed from the base of the PR and between 3377235 and 2fbb134.

⛔ Files ignored due to path filters (3)
  • src/assets/docs/agent-connectors/databricks/add-service-principal.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/databricks/generate-secret.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/databricks/workspace-settings.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
  • src/content/docs/reference/agent-connectors/databricks.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (9)
**/*.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. ## Title with 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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.mdx

⚙️ CodeRabbit configuration file

**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:

Frontmatter

  • title MUST be ≤ 60 characters and clearly state what the page does.
  • description MUST be ≤ 160 characters, action-oriented, unique per page.
  • sidebar.label MUST be present and ≤ 30 characters.
  • sidebar.order MUST 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 / next links on pages that are clearly
    part of a sequential flow (e.g., quickstart → implement-login →
    complete-login → manage-session → logout).

Voice & Style (CLAUDE.md standards)

  • Voice: confident, direct, collaborative, instructional.
  • Person: second person only ("you", "your application"). Reject "we",
    "our", "the developer", "the user".
  • Tense: present tense for descriptions; imperative mood for instructions.
  • Flag weasel words: "simply", "just", "easy", "straightforward",
    "obviously", "of course", "note that".
  • Flag passive voice constructions where active voice is clearer.
  • Headings must be sentence case, not Title Case (except proper nouns).
  • No heading should end with a colon or period.

Content structure

  • Journey how-to guides MUST contain numbered <Steps> (Starlight
    component). This does NOT apply to src/content/docs/cookbooks/**
    (blog-style recipes — optional <Steps>, <Tabs> after </Steps> OK;
    see cookbooks path_instructions).
  • Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
  • API reference pages MUST list parameters in a table with Name / Type /
    Required / Description columns.
  • Every page MUST end with a clear "what's next" signal — either a
    next: frontmatter link, a <LinkCard>, or an explicit paragraph
    pointing the reader forward in the sidebar journey.

Code examples

  • ALL code examples that show SDK usage MUST include all four language
    tabs...

Files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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,tsx,js,jsx,go,py,java}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx,js,jsx,go,py,java}: Comments should not duplicate the code; avoid comments that simply restate what the code does. Comments should add value beyond what's obvious. Do not use comments to explain poorly written code; instead, use better variable names and structure. Ensure comments clarify rather than obscure purpose
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments. Include parameter descriptions, return values, types, and descriptions. Document exceptions and edge cases. Include links to external references where helpful (standards, RFCs, official documentation)
Add comments when fixing bugs; reference issue trackers. Use standard formats for TODO, FIXME, and NOTE comments

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
src/content/docs/**/*.mdx

📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)

src/content/docs/**/*.mdx: In MDX documentation files, <Steps> must contain one continuous ordered list. Wrap <Steps> around a normal Markdown ordered list such as 1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the 1. ##, 2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images, <Tabs>, <TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside <Steps>. If the content is mostly <Tabs> or other JSX-heavy blocks, use normal section headings instead of <Steps>
In MDX documentation files, when <Tabs> is used inside a step, keep <Tabs>, <TabItem>, </TabItem>, and </Tabs> consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside </Steps>

Files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
🧠 Learnings (52)
📓 Common learnings
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 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: 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.
📚 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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-12T16:28:42.817Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-25T15:59:47.933Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:47.933Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, the code snippets are intentionally directional/illustrative and are meant to demonstrate the expected call sequence, not production-ready runnable code. When reviewing these files, do not flag missing `try/except` (Python) or `try/catch` (JS/TS) error handling solely because the snippet omits it—focus on whether the call sequence/pattern is conveyed clearly.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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/_usage-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
📚 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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
📚 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 use case comments explaining scenarios in code examples: '// Use case: Provision a workspace after a sales-assisted onboarding'

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/index.ts
📚 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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.mdx
📚 Learning: 2026-03-09T15:06:49.617Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.mdx
📚 Learning: 2026-04-01T08:35:26.973Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:55-117
Timestamp: 2026-04-01T08:35:26.973Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx` and Agent Auth connected accounts documentation (src/content/docs/agent-auth/**/*.mdx), only Python and Node.js SDK support is currently available for Agent Auth features (including connected accounts magic link creation and user verification). Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for these files. Add Go and Java TabItems once those SDKs support Agent Auth/connected account features.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.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-databricks.mdx
  • src/components/templates/agent-connectors/_setup-databricks.mdx
📚 Learning: 2026-03-12T16:28:37.168Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:37.168Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, external links should not be flagged for missing target="_blank" and rel="noopener". Plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) is acceptable and intentional in these agent-connector setup templates, following the established pattern across all connector templates in this directory.

Applied to files:

  • src/components/templates/agent-connectors/_setup-databricks.mdx
📚 Learning: 2026-03-25T16:00:29.351Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/content/docs/reference/agent-connectors/granolamcp.mdx:52-58
Timestamp: 2026-03-25T16:00:29.351Z
Learning: In `src/content/docs/reference/agent-connectors/**` (agent-connector reference pages, e.g., granolamcp.mdx), short sequential setup steps (4 items or fewer) may use plain Markdown numbered lists instead of the Starlight `<Steps>` component to avoid visual clutter when the page already contains multiple structured content blocks (tables, details/summary blocks, tool sections). Do not flag or require `<Steps>` for these short setup procedures on agent-connector reference pages.

Applied to files:

  • src/components/templates/agent-connectors/_setup-databricks.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-databricks.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 Steps component for sequential instructions in MDX documentation

Applied to files:

  • src/components/templates/agent-connectors/_setup-databricks.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: Test MDX documentation locally before committing to catch parsing and Steps component indentation errors

Applied to files:

  • src/components/templates/agent-connectors/_setup-databricks.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-databricks.mdx
📚 Learning: 2026-03-25T15:59:51.911Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:51.911Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files (agent-connector usage templates, e.g., `_usage-granolamcp.mdx`), code examples are intentionally directional/illustrative and are meant to show the call sequence pattern rather than production-ready runnable code. Do not flag the absence of try/except or try/catch error handling in these usage template files.

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-10T10:37:49.873Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:49.873Z
Learning: In `src/components/templates/agent-connectors/`, all connector setup MDX files (e.g., _setup-asana.mdx, _setup-clickup.mdx, _setup-confluence.mdx, _setup-googlecalendar.mdx, _setup-intercom.mdx, _setup-monday.mdx, _setup-notion.mdx, _setup-zoom.mdx) intentionally use a single shared redirect URI screenshot (`use-own-credentials-redirect-uri.png` located under `@/assets/docs/agent-connectors/<connector-name>/`) for all redirect URI-related steps, even when steps show different UIs (e.g., Scalekit dashboard vs. the third-party console). Do not flag reuse of this image across multiple steps within the same connector file as an issue.

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-12T16:26:46.707Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:46.707Z
Learning: In `src/components/templates/agent-connectors/`, it is acceptable and intentional to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., `oauth-web-app.png`, `add-redirect-uri.png`) in other Google-service connector templates (e.g., `_setup-bigquery.mdx`, `_setup-google-ads.mdx`, etc.). Do not flag cross-connector image path reuse within the Google service connectors as an issue.

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-27T17:20:14.679Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-27T17:20:14.679Z
Learning: Applies to **/*.{md,mdx} : Proactively address common setup and configuration problems. Keep code examples simple, self-contained, and exportable

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 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 : Group related imports together in MDX files

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 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 : Group related imports together at the top of MDX files

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 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 : Import components at the top of MDX files

Applied to files:

  • src/components/templates/agent-connectors/index.ts
📚 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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/content/docs/reference/agent-connectors/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.mdx
📚 Learning: 2026-03-25T16:00:25.846Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/content/docs/reference/agent-connectors/granolamcp.mdx:52-58
Timestamp: 2026-03-25T16:00:25.846Z
Learning: For MDX pages under src/content/docs/reference/agent-connectors/ (e.g., agent-connector reference pages like granolamcp.mdx), if you have a short sequential setup procedure of 4 items or fewer, it’s acceptable to use a plain Markdown numbered list instead of the Starlight <Steps> component. This exception is intended to avoid visual clutter on pages that already contain multiple structured content blocks (such as tables, <details>/<summary>, or tool sections). When this 4-or-fewer condition is met, do not flag missing/avoided <Steps> for these setup procedures.

Applied to files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
📚 Learning: 2026-04-01T10:25:46.962Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 567
File: src/content/docs/reference/agent-connectors/apifymcp.mdx:70-70
Timestamp: 2026-04-01T10:25:46.962Z
Learning: For agent-connector reference documentation pages (MDX under `src/content/docs/reference/agent-connectors/`), treat backtick/code-quoted example search terms inside parameter tables (e.g., `"google maps"`, `"instagram scraper"`) as literal query inputs that users type. Do not flag changes to the lowercase casing of words within these code-quoted example queries as if they were improper product-name capitalization; the casing is intentional to reflect realistic user input.

Applied to files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
🔇 Additional comments (2)
src/components/templates/agent-connectors/index.ts (1)

8-8: Databricks template exports are correctly wired.

Both new exports follow the established barrel pattern and match the new template filenames.

Also applies to: 64-64

src/components/templates/agent-connectors/_setup-databricks.mdx (1)

5-44: Setup walkthrough is clear and complete.

The sequence, required credentials, and dashboard mapping are easy to follow for first-time setup.

Comment thread src/components/templates/agent-connectors/_usage-databricks.mdx Outdated
Comment thread src/components/templates/agent-connectors/_usage-databricks.mdx
Comment thread src/content/docs/reference/agent-connectors/databricks.mdx Outdated
Comment thread src/content/docs/reference/agent-connectors/databricks.mdx
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 13, 2026

Deploy Preview for scalekit-starlight ready!

Name Link
🔨 Latest commit 2d3198e
🔍 Latest deploy log https://app.netlify.com/projects/scalekit-starlight/deploys/69dcc90967f0a70008e683b6
😎 Deploy Preview https://deploy-preview-590--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/_usage-databricks.mdx`:
- Around line 18-23: Add an explicit security warning comment above the
ScalekitClient instantiation: explain the threat (hard-coded secrets/APIs can be
leaked via source control or logs) and instruct developers to never hard-code
secrets or API keys and to use environment variables or a secret manager
instead; reference the ScalekitClient usage and the environment variables
process.env.SCALEKIT_ENV_URL, process.env.SCALEKIT_CLIENT_ID, and
process.env.SCALEKIT_CLIENT_SECRET so reviewers can find and update both the
instantiation block and the similar block around the second occurrence (lines
showing the same process.env keys).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 274235ac-86be-424d-98ea-0b3d75730ecf

📥 Commits

Reviewing files that changed from the base of the PR and between 2fbb134 and 2d3198e.

📒 Files selected for processing (2)
  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (4)
**/*.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. ## Title with 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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.mdx

⚙️ CodeRabbit configuration file

**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:

Frontmatter

  • title MUST be ≤ 60 characters and clearly state what the page does.
  • description MUST be ≤ 160 characters, action-oriented, unique per page.
  • sidebar.label MUST be present and ≤ 30 characters.
  • sidebar.order MUST 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 / next links on pages that are clearly
    part of a sequential flow (e.g., quickstart → implement-login →
    complete-login → manage-session → logout).

Voice & Style (CLAUDE.md standards)

  • Voice: confident, direct, collaborative, instructional.
  • Person: second person only ("you", "your application"). Reject "we",
    "our", "the developer", "the user".
  • Tense: present tense for descriptions; imperative mood for instructions.
  • Flag weasel words: "simply", "just", "easy", "straightforward",
    "obviously", "of course", "note that".
  • Flag passive voice constructions where active voice is clearer.
  • Headings must be sentence case, not Title Case (except proper nouns).
  • No heading should end with a colon or period.

Content structure

  • Journey how-to guides MUST contain numbered <Steps> (Starlight
    component). This does NOT apply to src/content/docs/cookbooks/**
    (blog-style recipes — optional <Steps>, <Tabs> after </Steps> OK;
    see cookbooks path_instructions).
  • Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
  • API reference pages MUST list parameters in a table with Name / Type /
    Required / Description columns.
  • Every page MUST end with a clear "what's next" signal — either a
    next: frontmatter link, a <LinkCard>, or an explicit paragraph
    pointing the reader forward in the sidebar journey.

Code examples

  • ALL code examples that show SDK usage MUST include all four language
    tabs...

Files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.mdx
src/content/docs/**/*.mdx

📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)

src/content/docs/**/*.mdx: In MDX documentation files, <Steps> must contain one continuous ordered list. Wrap <Steps> around a normal Markdown ordered list such as 1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the 1. ##, 2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images, <Tabs>, <TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside <Steps>. If the content is mostly <Tabs> or other JSX-heavy blocks, use normal section headings instead of <Steps>
In MDX documentation files, when <Tabs> is used inside a step, keep <Tabs>, <TabItem>, </TabItem>, and </Tabs> consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside </Steps>

Files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
🧠 Learnings (49)
📓 Common learnings
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/attio.mdx:24-24
Timestamp: 2026-03-13T03:51:44.897Z
Learning: For any agent connector documentation files located in src/content/docs/reference/agent-connectors/, use CDN URLs for connector logos with the host `https://cdn.scalekit.com/sk-connect/assets/provider-icons/` (e.g., `https://cdn.scalekit.com/sk-connect/assets/provider-icons/attio.svg`). The correct host is `cdn.scalekit.com`, NOT `cdn.scalekit.cloud`. Do not flag or change image src attributes that use `cdn.scalekit.com` for provider icons in this directory.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 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: 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: 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-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.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:51.911Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files (agent-connector usage templates, e.g., `_usage-granolamcp.mdx`), code examples are intentionally directional/illustrative and are meant to show the call sequence pattern rather than production-ready runnable code. Do not flag the absence of try/except or try/catch error handling in these usage template files.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Learnt from: 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.
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.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 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.
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, keep the trailing `## Scalekit Tools` heading at the end of each template. Do not flag it as empty or as a duplicate heading in future reviews for these files, since it is an intentional structural anchor used by the parent connector reference page to append the tool-list section beneath the proxy API examples.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.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-databricks.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/_usage-databricks.mdx
📚 Learning: 2026-03-25T15:59:47.933Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/components/templates/agent-connectors/_usage-granolamcp.mdx:18-48
Timestamp: 2026-03-25T15:59:47.933Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, the code snippets are intentionally directional/illustrative and are meant to demonstrate the expected call sequence, not production-ready runnable code. When reviewing these files, do not flag missing `try/except` (Python) or `try/catch` (JS/TS) error handling solely because the snippet omits it—focus on whether the call sequence/pattern is conveyed clearly.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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 use case comments explaining scenarios in code examples: '// Use case: Provision a workspace after a sales-assisted onboarding'

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.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-databricks.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-databricks.mdx
📚 Learning: 2026-03-25T10:15:02.544Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 529
File: src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx:188-190
Timestamp: 2026-03-25T10:15:02.544Z
Learning: In scalekit-inc/developer-docs, the Aside note in `src/content/docs/agent-auth/mcp/tool-access-via-mcp.mdx` warning that ChatGPT's beta MCP connector "may not work correctly" and "does not fully implement the MCP specification" is intentional. Real-world developers have reported re-auth loops and inconsistent streamable HTTP behaviour with ChatGPT compared to Claude, even though OpenAI's marketing describes it as "full MCP support". Do not flag or suggest removing this compatibility warning in future reviews.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
📚 Learning: 2026-03-27T16:55:31.608Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 544
File: src/content/docs/cookbooks/daily-briefing-agent.mdx:0-0
Timestamp: 2026-03-27T16:55:31.608Z
Learning: In `src/content/docs/cookbooks/daily-briefing-agent.mdx`, the `ensureConnected` (TypeScript) and `ensure_connected` (Python) functions intentionally use a single `if` check (not a `while` loop with re-validation) after the OAuth prompt. This is deliberate, well-tested example code reflecting the actual repo pattern. Do not suggest adding retry loops or post-prompt status re-validation in future reviews of this file.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-03-26T13:43:56.358Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 539
File: src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx:1-15
Timestamp: 2026-03-26T13:43:56.358Z
Learning: In scalekit-inc/developer-docs, the cookbook page src/content/docs/cookbooks/search-scalekit-docs-in-your-ide.mdx intentionally uses a title of 66 characters ("Search Scalekit docs with ref.tools in your AI coding assistant") that exceeds the standard 60-character limit. The maintainer (saif-at-scalekit) has confirmed this title should be kept as-is because it is considered fully meaningful. Do not flag this title length in future reviews.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-03-10T12:26:38.439Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 476
File: src/content/docs/guides/integrations/sso-integrations/okta-oidc.mdx:84-99
Timestamp: 2026-03-10T12:26:38.439Z
Learning: In scalekit-inc/developer-docs, integration guide pages under `src/content/docs/guides/integrations/` (including SSO integrations, SCIM integrations, and social connections) do not require a "what's next" signal, "Next steps" section, or concluding navigation links. Do not flag the absence of these elements on integration guide pages.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-03-09T07:28:02.186Z
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:28:02.186Z
Learning: In scalekit-inc/developer-docs, the 3-space indentation rule for Steps component content (src/content/docs/**/*.mdx) should only be flagged if it causes visible rendering problems in the UI. Do not enforce it as a strict style rule when the rendered output looks correct.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-02-25T13:04:35.551Z
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:35.551Z
Learning: In scalekit-inc/developer-docs MDX files, page-level CSS overrides in frontmatter (via `head:` tag with style content) are acceptable when used to improve readability and make content more inviting to readers, even if they override default Starlight typography. UX decisions on heading sizes can be made on a per-page basis to optimize the reading experience.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-02-25T08:57:19.260Z
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:19.260Z
Learning: In Scalekit developer-docs using Astro Starlight, the `tableOfContents` frontmatter field is enabled by default ({ minHeadingLevel: 2, maxHeadingLevel: 3 }). Do not suggest adding `tableOfContents: true` explicitly unless the user wants to customize heading levels or disable it entirely. The field only needs to be set when overriding the default behavior.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-03-11T08:54:32.774Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 480
File: src/content/docs/404.mdx:2-3
Timestamp: 2026-03-11T08:54:32.774Z
Learning: In scalekit-inc/developer-docs, the 404 page (src/content/docs/404.mdx) intentionally uses `title: '404'` in its frontmatter. Do not flag this as a non-descriptive title; '404' is considered universally understood and acceptable as a page title for the custom not-found page.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.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-databricks.mdx
📚 Learning: 2026-04-01T14:52:05.113Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:0-0
Timestamp: 2026-04-01T14:52:05.113Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx`, the magic link creation and verify API code snippets (Python and Node.js) intentionally omit try/catch and try/except error handling to keep the step-by-step guide easy to follow. Error semantics (state mismatch, verification failure, CSRF protection) are covered in the surrounding prose and Aside components. Do not flag the absence of error paths in these specific snippets in future reviews.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
📚 Learning: 2026-03-09T15:06:49.617Z
Learnt from: hrishikesh-p
Repo: scalekit-inc/developer-docs PR: 473
File: src/content/docs/agent-auth/tools/execute.mdx:34-76
Timestamp: 2026-03-09T15:06:49.617Z
Learning: In src/content/docs/agent-auth/tools/**/*.mdx (Agent Auth tool execution docs, e.g., execute.mdx, authorize.mdx), only Python and Node.js SDK support is currently available for Agent Auth tool execution. Do not require or enforce Go and Java tabs in Tabs syncKey="tech-stack" blocks for these files until the Go and Java SDKs support Agent Auth features. Add Go and Java TabItems once those SDKs are ready.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
📚 Learning: 2026-04-01T08:35:26.973Z
Learnt from: srinivaskarre-sk
Repo: scalekit-inc/developer-docs PR: 566
File: src/content/docs/agent-auth/user-verification.mdx:55-117
Timestamp: 2026-04-01T08:35:26.973Z
Learning: In `src/content/docs/agent-auth/user-verification.mdx` and Agent Auth connected accounts documentation (src/content/docs/agent-auth/**/*.mdx), only Python and Node.js SDK support is currently available for Agent Auth features (including connected accounts magic link creation and user verification). Do not require or enforce Go and Java tabs in `<Tabs syncKey="tech-stack">` blocks for these files. Add Go and Java TabItems once those SDKs support Agent Auth/connected account features.

Applied to files:

  • src/components/templates/agent-connectors/_usage-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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-databricks.mdx
  • src/content/docs/reference/agent-connectors/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.mdx
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.

Applied to files:

  • src/content/docs/reference/agent-connectors/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.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/databricks.mdx
📚 Learning: 2026-03-25T16:00:25.846Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 531
File: src/content/docs/reference/agent-connectors/granolamcp.mdx:52-58
Timestamp: 2026-03-25T16:00:25.846Z
Learning: For MDX pages under src/content/docs/reference/agent-connectors/ (e.g., agent-connector reference pages like granolamcp.mdx), if you have a short sequential setup procedure of 4 items or fewer, it’s acceptable to use a plain Markdown numbered list instead of the Starlight <Steps> component. This exception is intended to avoid visual clutter on pages that already contain multiple structured content blocks (such as tables, <details>/<summary>, or tool sections). When this 4-or-fewer condition is met, do not flag missing/avoided <Steps> for these setup procedures.

Applied to files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
📚 Learning: 2026-04-01T10:25:46.962Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 567
File: src/content/docs/reference/agent-connectors/apifymcp.mdx:70-70
Timestamp: 2026-04-01T10:25:46.962Z
Learning: For agent-connector reference documentation pages (MDX under `src/content/docs/reference/agent-connectors/`), treat backtick/code-quoted example search terms inside parameter tables (e.g., `"google maps"`, `"instagram scraper"`) as literal query inputs that users type. Do not flag changes to the lowercase casing of words within these code-quoted example queries as if they were improper product-name capitalization; the casing is intentional to reflect realistic user input.

Applied to files:

  • src/content/docs/reference/agent-connectors/databricks.mdx
🔇 Additional comments (3)
src/components/templates/agent-connectors/_usage-databricks.mdx (1)

67-67: Scalekit Tools anchor heading is correctly kept.

This matches the established usage-template structure and should remain.

Based on learnings, the trailing ## Scalekit Tools heading is an intentional structural anchor in src/components/templates/agent-connectors/_usage-*.mdx.

src/content/docs/reference/agent-connectors/databricks.mdx (2)

59-62: Termination behavior is now accurately documented.

Good correction: TERMINATED is reversible, and permanent removal is called out separately via /permanent-delete.


43-145: Tool list structure and parameter tables are in good shape.

The page consistently documents each tool with clear headings and complete parameter-table headers.

As per coding guidelines, API reference sections should include structured parameter tables with clear headers.

Comment thread src/components/templates/agent-connectors/_usage-databricks.mdx
@ravibits ravibits merged commit db72e16 into main Apr 13, 2026
4 checks passed
@saif-at-scalekit saif-at-scalekit deleted the preview/actions-databrics-connector branch May 7, 2026 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants