docs(agentkit): add HeyReach agent connector#633
Conversation
Starting with d2 v0.7.x, upstream GitHub releases renamed the macOS asset from darwin-* to macos-*, causing 404 errors on pnpm install:d2. This fix updates the OS mapping in install-d2.sh to use "macos" when the system is detected as Darwin.
Adds setup and usage documentation templates for the HeyReach agent connector, including API-key authentication setup (generate key, create connection, add account), code examples (proxy API, execute_tool calls, LangChain integration), and comprehensive tool listing. The connector page imports the templates via the auto-generated index exports, which now include heyreachSetup and heyreachUsage. All examples have been validated against a live HeyReach API.
satyapd549
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 49 minutes and 3 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughAdds a new HeyReach agent connector (docs, templates, tool definitions, and exports) and updates a macOS artifact name in the install script to use Changes
Sequence Diagram(s)sequenceDiagram
participant User as User
participant Scalekit as Scalekit (Agent)
participant Connector as HeyReach Connector
participant HeyReach as HeyReach API
User->>Scalekit: Invoke agent/tool (e.g., add leads, list campaigns)
Scalekit->>Connector: Resolve connected account (connectionName, identifier)
Connector->>HeyReach: Proxy authenticated API request (uses stored API key)
HeyReach-->>Connector: Returns data / status (200 or 429)
Connector-->>Scalekit: Normalize response for agent
Scalekit-->>User: Return result to agent or client
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/agentkit/connectors/heyreach.mdx`:
- Around line 22-26: Replace the garbled bullet labels with clear,
human-readable operation descriptions and include all connector operations
defined in the code (match names from the heyreach_* functions): map
heyreach_get_lead → "Look up a lead by LinkedIn profile URL",
heyreach_add_leads_to_campaign → "Add up to 100 leads to an existing campaign",
heyreach_check_api_key → "Verify HeyReach API key / test connection", and add
the missing operations: heyreach_get_all_campaigns → "List all campaigns",
heyreach_get_all_linkedin_accounts → "List all linked LinkedIn accounts",
heyreach_get_all_lists → "List all lead lists", heyreach_get_campaign_by_id →
"Get campaign details by ID", heyreach_get_conversations → "Fetch campaign
conversations", heyreach_get_leads_from_list → "Get leads from a list", and
heyreach_get_overall_stats → "Get overall campaign stats"; ensure wording is
concise and consistent with the <ToolList> render so the bullet list matches the
connector functions.
- Around line 15-18: The file currently imports SetupHeyreachSection and
UsageHeyreachSection in two separate statements from the same module;
consolidate them into a single named import from '@components/templates'
(combine the two imports that reference SetupHeyreachSection and
UsageHeyreachSection into one import statement) and remove the duplicate import
so related imports are grouped at the top of the MDX file.
🪄 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: d7f3e931-3146-4e75-ac28-04e0afb4947f
📒 Files selected for processing (6)
scripts/install-d2.shsrc/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/data/agent-connectors/heyreach.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (11)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:frontmatter link, a<LinkCard>, or an explicit paragraph
pointing the reader forward in the sidebar journey.Code examples
- ALL code examples that show SDK usage MUST include all four language
tabs...
Files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.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/data/agent-connectors/heyreach.tssrc/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/data/agent-connectors/heyreach.tssrc/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/data/agent-connectors/heyreach.tssrc/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
Use exact SDK variable names: Node.js:
scalekit, Python:scalekit_client, Go:scalekitClient, Java:scalekitClient
Files:
src/data/agent-connectors/heyreach.tssrc/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/data/agent-connectors/heyreach.tssrc/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 as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/connectors/heyreach.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter with at least:title(≤60 chars),description(≤160 chars), andsidebar.label(1-3 words)
Use H2 for major sections, H3 for subsections, and H4 only inside<Steps>; never use H1 in body content and avoid nesting beyond H4
Use numbered lists only inside<Steps>for ordered procedures; use bulleted lists for unordered information
Use bold for first mention of important terms, UI elements, and dashboard paths; use inline code for technical identifiers (variables, functions, endpoints, scopes, environment variables, file paths, placeholders)
The<Steps>component requires a single continuous ordered list with proper indentation: steps at column 0, continuation content indented with exactly 3 spaces
Use<Aside>component with atitleattribute for cautions, tips, and notes
Use<Badge>component to indicate parameter requirements in tables and inline text
Use<details>blocks at the end of pages for FAQs, common scenarios, and troubleshooting
Split content into clear sections with descriptive, sentence-style titles; include a table of contents for documents with multiple sections; keep paragraphs short and isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content; put topic words at the beginning to support fast skimming; put key takeaways and results at the top of documents
Use bullets and tables generously to structure information; bold important text to highlight key concepts and decisions
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns like 'this' or 'that' when the referent is not explicit
Maintain strict consistency in terminology, formatting, and style; do not presume the reader's state of mind or intentions; use direct, instructional language
Write more simply than you think you need to; optimize for readers new to the do...
Files:
src/content/docs/agentkit/connectors/heyreach.mdx
src/content/docs/agentkit/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Agentkit code examples live in the external repo scalekit-developers/agent-auth-examples organized as
javascript/frameworks/<framework>andpython/frameworks/<framework>; verify docs snippets match current implementations in that repo
Files:
src/content/docs/agentkit/connectors/heyreach.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:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:42.817Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) for external links is acceptable and intentional. Do not flag the absence of target="_blank" and rel="noopener" attributes in these agent-connector setup template files. This follows the established pattern across all connector templates in this directory.
Learnt from: 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: 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: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 455
File: src/content/docs/reference/agent-connectors/asana.mdx:94-173
Timestamp: 2026-03-03T13:35:56.400Z
Learning: For Agent Connectors documentation (src/content/docs/reference/agent-connectors/**/*.mdx), currently only Python SDK support is available for Agent Actions/Agent Connectors. Do not require or enforce the multi-language SDK code examples (Node.js, Python, Go, Java) guideline for these connector docs until SDK support is ready in other languages. The Node.js, Go, and Java examples can be added once the respective SDKs support Agent Actions features.
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/youtube.mdx:19-26
Timestamp: 2026-03-13T03:44:23.786Z
Learning: In src/content/docs/reference/agent-connectors/*.mdx files, small raw HTML <div> blocks used for the connector header grid layout (e.g., a 5-column grid with description and logo) are considered readable without a justification comment. Do not flag the absence of a justification comment on these simple connector-header div blocks in agent-connector reference pages.
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/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.
📚 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-heyreach.mdx
📚 Learning: 2026-04-13T10:43:05.628Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:05.628Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` files, the trailing `## Scalekit Tools` heading at the end of every usage template is intentional and consistent across all 42+ connector usage templates. It acts as a structural anchor/separator that the parent connector reference page uses to append the tool-list section beneath the proxy API examples. Do not flag this heading as empty or duplicate in future reviews of these template files.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/data/agent-connectors/heyreach.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:21:37.207Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlesheets.mdx:89-131
Timestamp: 2026-02-26T07:21:37.207Z
Learning: In src/content/docs/reference/agent-connectors/** MDX files, tool headings (e.g., `googlesheets_create_spreadsheet`, `googlesheets_get_values`) intentionally use H2 (##) instead of H3 to ensure they appear in the table of contents for easier navigation. This is a deliberate UX choice for agent connector reference pages and should not be flagged as a hierarchy issue.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/data/agent-connectors/heyreach.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-04-20T17:03:02.786Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 619
File: src/components/templates/agent-connectors/_usage-posthogmcp.mdx:82-82
Timestamp: 2026-04-20T17:03:02.786Z
Learning: In `src/components/templates/agent-connectors/_usage-posthogmcp.mdx`, the trailing `## Scalekit Tools` heading is intentionally omitted. The parent connector page (`src/content/docs/agentkit/connectors/posthogmcp.mdx`) renders the tool list separately via the `ToolList` component and the imported `tools` dataset, so the structural anchor heading used by other `_usage-*.mdx` templates is not needed here. Do not flag the missing `## Scalekit Tools` heading in this file.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/data/agent-connectors/heyreach.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 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/_setup-heyreach.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdx
📚 Learning: 2026-02-26T07:23:27.672Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/microsoftword.mdx:3-3
Timestamp: 2026-02-26T07:23:27.672Z
Learning: For MDX files under src/content/docs/reference/agent-connectors/, do not enforce the 160-character description limit. These files are auto-generated from API payloads via scripts/sync-agent-connectors.js and may have longer descriptions from the source data.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/data/agent-connectors/heyreach.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/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 configuration comments in code examples: '// Get the signing secret from Scalekit dashboard > Interceptors tab'
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.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/_setup-heyreach.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/_setup-heyreach.mdxsrc/data/agent-connectors/heyreach.tssrc/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/agent-connectors/_usage-heyreach.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-heyreach.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-heyreach.mdx
📚 Learning: 2026-04-13T10:43:03.024Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 590
File: src/components/templates/agent-connectors/_usage-databricks.mdx:83-83
Timestamp: 2026-04-13T10:43:03.024Z
Learning: In `src/components/templates/agent-connectors/_usage-*.mdx` usage template files, keep the trailing `## Scalekit Tools` heading at the end of each template. Do not flag it as empty or as a duplicate heading in future reviews for these files, since it is an intentional structural anchor used by the parent connector reference page to append the tool-list section beneath the proxy API examples.
Applied to files:
src/components/templates/agent-connectors/_usage-heyreach.mdx
📚 Learning: 2026-04-22T09:59:00.346Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 623
File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227
Timestamp: 2026-04-22T09:59:00.346Z
Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.
Applied to files:
src/components/templates/agent-connectors/_usage-heyreach.mdxsrc/data/agent-connectors/heyreach.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-heyreach.mdxsrc/content/docs/agentkit/connectors/heyreach.mdxsrc/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-heyreach.mdx
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to src/content/docs/agentkit/**/*.{md,mdx} : Agentkit code examples live in the external repo **scalekit-developers/agent-auth-examples** organized as `javascript/frameworks/<framework>` and `python/frameworks/<framework>`; verify docs snippets match current implementations in that repo
Applied to files:
src/components/templates/agent-connectors/_usage-heyreach.mdx
📚 Learning: 2026-03-29T07:48:47.916Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 546
File: public/api/scalekit.scalar.yaml:5947-5996
Timestamp: 2026-03-29T07:48:47.916Z
Learning: In scalekit-inc/developer-docs, hiding the /api/v1/users/support-hash route from the public OpenAPI (public/api/scalekit.scalar.yaml) is intentional. The site keeps an internal proxy at src/pages/api/v1/users/support-hash.ts, and public/js/pylon-widget.js relies on it for Pylon verification. Do not flag the spec’s omission of this path as requiring code-side removal of the proxy or widget.
Applied to files:
src/components/templates/agent-connectors/_usage-heyreach.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-heyreach.mdx
📚 Learning: 2026-01-13T12:46:55.260Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursorrules:0-0
Timestamp: 2026-01-13T12:46:55.260Z
Learning: Applies to **/*.mdx : Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Applied to files:
src/components/templates/agent-connectors/_usage-heyreach.mdx
📚 Learning: 2026-03-13T03:44:23.786Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 489
File: src/content/docs/reference/agent-connectors/youtube.mdx:19-26
Timestamp: 2026-03-13T03:44:23.786Z
Learning: In src/content/docs/reference/agent-connectors/*.mdx files, small raw HTML <div> blocks used for the connector header grid layout (e.g., a 5-column grid with description and logo) are considered readable without a justification comment. Do not flag the absence of a justification comment on these simple connector-header div blocks in agent-connector reference pages.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-02-26T07:20:46.903Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: src/content/docs/reference/agent-connectors/googlemeet.mdx:1-87
Timestamp: 2026-02-26T07:20:46.903Z
Learning: For auto-generated agent connector documentation pages in src/content/docs/reference/agent-connectors/, the "what's next" signal requirement (next: frontmatter link, <LinkCard>, or concluding paragraph) does not apply. These are reference pages generated by scripts/sync-agent-connectors.js and serve as lookup resources rather than sequential guides.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-02-26T07:18:51.377Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 448
File: scripts/sync-agent-connectors.js:0-0
Timestamp: 2026-02-26T07:18:51.377Z
Learning: In src/content/docs/reference/agent-connectors/**/*.mdx files, sidebar.label frontmatter is not required because the sidebar configuration references the agent-connectors directory for auto-generation. Navigation ordering and grouping are managed centrally in the sidebar configuration file.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-04-13T14:22:37.194Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 591
File: src/content/docs/reference/agent-connectors/calendly.mdx:47-47
Timestamp: 2026-04-13T14:22:37.194Z
Learning: In `src/content/docs/reference/agent-connectors/` MDX files (agent-connector reference pages, e.g., calendly.mdx), the `title` attribute on `<Aside>` components is not required. Do not flag missing `title` props on `<Aside>` components in files under this directory. This is a deliberate exception to the global rule requiring `title` on all `<Aside>` components.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdxsrc/components/templates/agent-connectors/index.ts
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/connectors/heyreach.mdx
📚 Learning: 2026-03-12T16:29:16.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:16.422Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, using "Azure Active Directory" instead of the rebranded "Microsoft Entra ID" is acceptable and intentional. Do not flag "Azure Active Directory" as outdated branding in these agent-connector setup template files.
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-04-20T11:29:40.242Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-04-20T11:29:40.242Z
Learning: Applies to {src/content/docs/guides/integrations/**/*.{md,mdx},src/components/templates/_*.{ts,tsx,astro}} : Integration guides in `src/content/docs/guides/integrations/` must be kept synchronized with their corresponding index pages and use reusable template components from `src/components/templates/`
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-04-20T11:30:52.410Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-04-20T11:30:52.410Z
Learning: Applies to **/*.{md,mdx} : Use normal section headings instead of `<Steps>` when content is mostly `<Tabs>`, long JSX blocks, or multiple embedded components
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-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: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 : Import components at the top of MDX files with consistent import paths using `@/` prefix
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 : Use CardGrid, Card, and LinkCard components for hubs and navigation pages in MDX documentation
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 : Use 'collapse={lines}' to hide imports, setup, and boilerplate code in code blocks
Applied to files:
src/components/templates/agent-connectors/index.ts
📚 Learning: 2026-03-16T21:02:51.181Z
Learnt from: CR
Repo: scalekit-inc/developer-docs PR: 0
File: .cursor/rules/expressive-code.mdc:0-0
Timestamp: 2026-03-16T21:02:51.181Z
Learning: Applies to **/*.mdx : Import `<Code>` from `astrojs/starlight/components` once per file below frontmatter in `.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 : Use consistent import paths with the `@/` prefix 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 : Use CardGrid, Card, and LinkCard components for organized content presentation in MDX documentation
Applied to files:
src/components/templates/agent-connectors/index.ts
🔇 Additional comments (3)
scripts/install-d2.sh (1)
32-35: The original review comment's core concern is not supported by the evidence. Verification shows that both v0.6.8 (pre-v0.7.x) and v0.7.1 usemacosartifact names, notdarwin. The unconditionalDarwin -> macosmapping at line 35 is correct and does not break installs for pre-v0.7.x versions. The code requires no changes.> Likely an incorrect or invalid review comment.src/components/templates/agent-connectors/_usage-heyreach.mdx (2)
234-239: Theactions.langchain.get_tools(...)API surface is correct.The code matches the current Scalekit Python SDK. The method signature, parameter names (
identifier,providers,page_size), and provider format are all correct and will run without issue.
36-49:⚠️ Potential issue | 🟡 MinorUse the standard Scalekit Python SDK import pattern — change
import scalekit.client, osfollowed byscalekit.client.ScalekitClient(...)tofrom scalekit import ScalekitClient.The pattern used in this file is verbose and non-idiomatic. The Scalekit Python SDK exposes
ScalekitClientat the top level, so the standard import isfrom scalekit import ScalekitClient. Apply this fix consistently across all Python code blocks (lines 36–49, 76–85, 209–223).Suggested fix
-import scalekit.client, os +import os +from scalekit import ScalekitClient from dotenv import load_dotenv load_dotenv() connection_name = "heyreach" identifier = "user_123" # Get your credentials from app.scalekit.com → Developers → Settings → API Credentials -scalekit_client = scalekit.client.ScalekitClient( +scalekit_client = ScalekitClient( client_id=os.getenv("SCALEKIT_CLIENT_ID"), client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"), env_url=os.getenv("SCALEKIT_ENV_URL"), )⛔ Skipped due to learnings
Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: public/AGENTS.md:0-0 Timestamp: 2026-03-31T16:14:24.575Z Learning: Applies to public/**/*.py : Python SDK should use the variable name `scalekit_client`Learnt from: AkshayParihar33 Repo: scalekit-inc/developer-docs PR: 623 File: src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx:197-227 Timestamp: 2026-04-22T09:59:00.346Z Learning: In `src/content/docs/agentkit/bring-your-own-connector/using-tool-proxy.mdx`, the `execute_tool` code examples (Node.js and Python) under the "MCP tool calling" section intentionally omit client initialization boilerplate (`ScalekitClient` setup, env loading, variable declarations). They are continuation snippets that rely on the client already defined in the `list_scoped_tools` discovery block above. Do not flag these as lacking self-contained initialization in future reviews.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:59.118Z Learning: In the Scalekit Python SDK (`scalekit-sdk-python`), `LogoutUrlOptions` is NOT exported from the top-level `scalekit` package `__init__.py`. The correct import path is `from scalekit.common.scalekit import LogoutUrlOptions`. Do not flag this import path as incorrect in documentation or code reviews.Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: CLAUDE.md:0-0 Timestamp: 2026-04-20T11:29:40.242Z Learning: Applies to **/*.{md,mdx} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: AGENTS.md:0-0 Timestamp: 2026-04-20T11:30:52.410Z Learning: Applies to **/*.{js,ts,tsx,py,go,java} : Use exact SDK variable names: Node.js: `scalekit`, Python: `scalekit_client`, Go: `scalekitClient`, Java: `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: .cursorrules:0-0 Timestamp: 2026-01-13T12:46:55.260Z Learning: Applies to **/*.mdx : Use consistent SDK variable naming: Node.js='scalekit', Python='scalekit_client', Go='scalekitClient', Java='scalekitClient'Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: public/AGENTS.md:0-0 Timestamp: 2026-03-31T16:14:24.575Z Learning: Applies to public/**/*.go : Go SDK should use the variable name `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: public/AGENTS.md:0-0 Timestamp: 2026-03-31T16:14:24.575Z Learning: Never hard-code secrets: `SCALEKIT_CLIENT_ID`, `SCALEKIT_CLIENT_SECRET`, and `SCALEKIT_ENV_URL` must be loaded from environment variablesLearnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: public/AGENTS.md:0-0 Timestamp: 2026-03-31T16:14:24.575Z Learning: Applies to public/**/*.java : Java SDK should use the variable name `scalekitClient`Learnt from: CR Repo: scalekit-inc/developer-docs PR: 0 File: public/AGENTS.md:0-0 Timestamp: 2026-03-31T16:14:24.575Z Learning: Applies to public/**/*.{js,ts,jsx,tsx} : Node.js SDK should use the variable name `scalekit`
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/components/templates/agent-connectors/_setup-heyreach.mdx`:
- Line 6: Inside the <Steps> block in the component template update each step
heading from the incorrect "1. ### ..." level-3 heading to the required numbered
H2 format "1. ## ..." so the "Generate a HeyReach API key" step (and the other
occurrences referenced) use H2 not H3; ensure the numbered steps start at column
0 (no leading spaces) and update the headings at the other occurrences noted
(the other two step headings around the same block).
- Line 12: The image path in
src/components/templates/agent-connectors/_setup-heyreach.mdx is incorrect;
update the markdown image reference that currently points to
"@/assets/docs/_setup-heyreach/create-apikey.png" to the correct asset location
under the agent-connectors directory, e.g.
"@/assets/docs/agent-connectors/heyreach/create-apikey.png", ensuring the
filename matches the actual file in src/assets/docs/agent-connectors/heyreach/.
In `@src/content/docs/guides/admin-portal.mdx`:
- Line 60: Replace the Badge components that currently use disallowed text
values by updating the Badge instances whose text props are "No-code" and
"Programmatic" to use one of the allowed tokens; change "No-code" to an allowed
value like "recommended" (or "New"/"Optional"/"API" as appropriate) and change
"Programmatic" likewise (e.g., "API"), ensuring you only modify the Badge text
prop on the Badge elements so they conform to the permitted set ("recommended",
"API", "New", "Optional").
🪄 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: facc5a25-b97e-44cd-bc37-e1d62ad43961
⛔ Files ignored due to path filters (66)
public/d2/docs/agentkit/authentication/token-management-0.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/mcp/configure-mcp-server-0.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/mcp/configure-mcp-server-1.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/mcp/configure-mcp-server-2.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/openclaw-0.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/overview-0.svgis excluded by!**/*.svgpublic/d2/docs/agentkit/user-verification-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/auth-methods/authentication-flow-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/authz/create-roles-permissions-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/authz/implement-access-control-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/authz/overview-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/fsa/multiapp/native-app-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/fsa/multiapp/overview-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/fsa/multiapp/single-page-app-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/fsa/multiapp/web-app-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/implement-workflows/implement-webhooks-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/interceptors/auth-flow-interceptors-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/m2m/api-auth-quickstart-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/m2m/api-keys-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/custom-user-attributes-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/email-domain-rules-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/email-domain-rules-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/hosted-widgets-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/jit-provisioning-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/merge-identities-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/merge-identities-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/manage-users-orgs/scim-provisioning-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/auth-patterns-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/auth-patterns-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/auth-patterns-2.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/auth-patterns-3.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/auth-patterns-4.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/custom-auth-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/expressjs-quickstart-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/fastapi-fastmcp-quickstart-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/fastmcp-quickstart-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/intro-to-mcp-auth-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/intro-to-mcp-auth-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/intro-to-mcp-auth-2.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/overview-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/overview-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/overview-2.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/overview-3.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/topologies/agent-mcp-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/topologies/human-mcp-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/topologies/mcp-api-0.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/topologies/mcp-api-1.svgis excluded by!**/*.svgpublic/d2/docs/authenticate/mcp/topologies/mcp-api-2.svgis excluded by!**/*.svgpublic/d2/docs/cookbooks/render-github-pr-summarizer-0.svgis excluded by!**/*.svgpublic/d2/docs/dev-kit/tools/use-scalekit-credentials-0.svgis excluded by!**/*.svgpublic/d2/docs/directory/guides/group-based-role-assignment-0.svgis excluded by!**/*.svgpublic/d2/docs/directory/scim/quickstart-0.svgis excluded by!**/*.svgpublic/d2/docs/fsa/data-modelling-0.svgis excluded by!**/*.svgpublic/d2/docs/fsa/guides/manage-users-0.svgis excluded by!**/*.svgpublic/d2/docs/fsa/guides/user-invitations-0.svgis excluded by!**/*.svgpublic/d2/docs/guides/integrations/auth-systems/firebase-0.svgis excluded by!**/*.svgpublic/d2/docs/guides/integrations/auth-systems/firebase-1.svgis excluded by!**/*.svgpublic/d2/docs/guides/sso/sso-migration-strategy-0.svgis excluded by!**/*.svgpublic/d2/docs/guides/sso/sso-migration-strategy-1.svgis excluded by!**/*.svgpublic/d2/docs/mcp/auth-methods/custom-auth-0.svgis excluded by!**/*.svgpublic/d2/docs/mcp/auth-methods/enterprise-0.svgis excluded by!**/*.svgpublic/d2/docs/passwordless/oidc-0.svgis excluded by!**/*.svgpublic/d2/docs/sso/guides/idp-init-sso-0.svgis excluded by!**/*.svgpublic/d2/docs/sso/guides/idp-init-sso-1.svgis excluded by!**/*.svgsrc/assets/docs/_setup-heyreach/create-apikey.pngis excluded by!**/*.pngsrc/assets/docs/_setup-heyreach/test.pngis excluded by!**/*.png
📒 Files selected for processing (4)
src/components/templates/agent-connectors/_setup-heyreach.mdxsrc/components/templates/coding-agents/_mcp-auth-claude-code.mdxsrc/content/docs/directory/guides/group-based-role-assignment.mdxsrc/content/docs/guides/admin-portal.mdx
3 participants
Summary
/agentkit/connectors/heyreach.mdxthat imports and renders the reusable templates via auto-generated index exportsheyreach.tsdata file listing all 10 HeyReach connector tools (campaigns, contacts, conversations, leads, stats, etc.)src/components/templates/agent-connectors/index.tswithheyreachSetupandheyreachUsageexports, with alphabetization reordering for consistencyTest plan
src/assets/docs/agent-connectors/heyreach/(create-api-key.png,add-credentials.png,add-connected-account.png) and reinsert markdown image referencesNote about included d2 fix
This branch sits on top of PR #632 (d2 install-script fix). The d2 install-script commit will appear in the diff until PR #632 merges to main, after which GitHub will auto-deduplicate it.
Preview
https://deploy-preview-633--scalekit-starlight.netlify.app/agentkit/connectors/heyreach/
Summary by CodeRabbit
Bug Fixes
New Features
Documentation