docs(signal): clarify BYOA login validity and handoff timeout - #927
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (13)**/*.mdx📄 CodeRabbit inference engine (.cursorrules)
Files:
⚙️ CodeRabbit configuration file
Files:
**/*.{yml,yaml,md,mdx}📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
Files:
src/content/docs/**/*.mdx📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
Files:
src/content/**/*.mdx📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/*.{md,mdx,astro,ts}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
src/content/docs/**/*.{md,mdx}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
src/**/*.{ts,tsx,astro,md,mdx}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
**/*.{ts,tsx,astro,md,mdx,css}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
**/*.{ts,tsx,astro,md,mdx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{ts,tsx,js,jsx,java,py,go,md,mdx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
src/content/docs/authenticate/**/*.mdx⚙️ CodeRabbit configuration file
Files:
🧠 Learnings (13)📚 Learning: 2026-01-30T18:18:50.883ZApplied to files:
📚 Learning: 2026-02-04T12:47:16.544ZApplied to files:
📚 Learning: 2026-02-25T08:57:12.201ZApplied to files:
📚 Learning: 2026-02-25T13:04:27.491ZApplied to files:
📚 Learning: 2026-03-05T11:29:08.125ZApplied to files:
📚 Learning: 2026-03-09T07:27:56.794ZApplied to files:
📚 Learning: 2026-03-09T07:32:38.426ZApplied to files:
📚 Learning: 2026-03-17T16:01:50.487ZApplied to files:
📚 Learning: 2026-02-25T03:34:41.147ZApplied to files:
📚 Learning: 2026-02-25T18:41:00.639ZApplied to files:
📚 Learning: 2026-05-16T17:25:30.736ZApplied to files:
📚 Learning: 2026-04-25T07:22:18.321ZApplied to files:
📚 Learning: 2026-05-16T17:25:30.736ZApplied to files:
🔇 Additional comments (1)
WalkthroughThe MCP custom authentication documentation now explains the 10-minute validity window for login requests and OAuth ChangesMCP authentication documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This is a localized documentation update clarifying BYOA login expiry and handoff-timeout troubleshooting; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/authenticate/mcp/custom-auth.mdx`:
- Around line 87-88: Update the authentication guidance around the login request
expiration and related first-time-user instructions to use second-person
wording, replacing references to “the user” with “you” or “your application”
while preserving the existing meaning and behavior.
- Around line 194-196: Update the troubleshooting guidance around the
invalid_state error to distinguish expired login requests from mismatched state
values. Instruct users to verify that their application stores the state from
step 1 and returns it unchanged without dropping, overwriting, or rewriting it,
while keeping state validation enabled; retain restarting the MCP connection
only as the recovery for expired requests.
- Line 203: The troubleshooting paragraph that mentions the access token and
shared client caching lacks context about what the token contains, its validity
window, and security considerations. Enhance this section by either linking to
the quickstart documentation or adding an inline note explaining that Scalekit
access tokens are short-lived (300–3600 seconds recommended), contain claims
such as aud, iss, exp, iat, and scope, and must be validated on every request.
This ensures readers encountering this timeout scenario understand both the root
cause and the token-handling expectations.
🪄 Autofix
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: 31fd454e-823f-4724-a844-536df5cdefd3
📒 Files selected for processing (1)
src/content/docs/authenticate/mcp/custom-auth.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (13)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/content/docs/authenticate/mcp/custom-auth.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).
- Headings that match a real API parameter, method, or field name
(e.g.,contactID,xero_tenant_id,executeTool) should preserve
the original casing. Do NOT flag these as sentence-case violations.- 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:f...
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
src/content/**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
src/content/**/*.mdx: All documentation must live as MDX files insidesrc/content/
Every documentation page must have frontmatter with title (≤60 characters), description (≤160 characters), sidebar label, order, and tags
Write documentation in second person using 'you' and 'your application', present tense for descriptions, and imperative for step-by-step instructions
Avoid filler phrases like 'simply', 'just', 'easily' in documentation and be direct
Explain security implications when relevant in documentation
Every code block demonstrating an SDK operation must include all four languages (Node.js, Python, Go, Java) using synced tabs with syncKey='tech-stack'
SDK variable names are fixed and must not be renamed: Node.js usesscalekit, Python usesscalekit_client, Go usesscalekitClient, Java usesscalekitClient
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{md,mdx,astro,ts}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{md,mdx,astro,ts}: Usepnpm pretty-quick --stagedvia pre-commit git hook to auto-format all staged.md,.mdx,.astro,.tsfiles with Prettier
Runpnpm formatto auto-format all.md,.mdx,.astro,.tsfiles before pushing changes
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
src/content/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{md,mdx}: Every documentation page must include frontmatter withtitle,description, andsidebar.label;titlemust be at most 60 characters,descriptionat most 160 characters, and sidebar labels should be 1–3 words.
Use sentence case for all titles and headings, keep page titles short and descriptive, and make headings describe outcomes rather than categories.
Use H2 for major sections, H3 for subsections, H4 only inside<Steps>, and never use H1 in body content.
Use descriptive link text, prefer relative links for internal pages, and never use labels such asclick hereorthis.
Use fenced code blocks with language identifiers, format technical identifiers with inline code, include table headers, and ensure examples are runnable or clearly marked as placeholders.
Never hard-code secrets or API keys in documentation or code examples; explain relevant security threats and mitigations.
Documentation code examples must use the exact SDK variable names: Node.jsscalekit, Pythonscalekit_client, GoscalekitClient, and JavascalekitClient.
At least approximately 90% of SDK-related code examples must include Node.js, Python, Go, and Java implementations, with consistent naming, success and error paths, and security explanations.
Use<Tabs syncKey="tech-stack">for multi-language SDK samples and include clear language tabs, imports, realistic data, success and error handling, and appropriate Expressive Code features.
When using Starlight<Steps>, keep numbered steps at column 0, indent continuation content and sub-bullets by exactly three spaces, and keep nested<Tabs>blocks inside the owning list item.
Use the primary structure appropriate to each document type: how-to guides include overview, prerequisites, procedure, verification, and optional next steps; API references include endpoint summary, authentication, base URL, parameters, request, response, and errors; concept pages include overview, concepts, use cases, t...
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
src/**/*.{ts,tsx,astro,md,mdx}
📄 CodeRabbit inference engine (CLAUDE.md)
Navigation structure changes must be coordinated across
src/configs/sidebar.config.ts,src/components/overrides/Header.astro, andsrc/components/SecondaryNav.astro.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{ts,tsx,astro,md,mdx,css}
📄 CodeRabbit inference engine (CLAUDE.md)
All changes must pass Prettier formatting, the build, Git hook validations, and content-structure validation; use pnpm, Astro/Starlight conventions, Tailwind CSS compatibility, and Vue 3 and React compatibility.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{ts,tsx,astro,md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Use Astro + Starlight conventions, maintain Tailwind CSS compatibility, and ensure Vue 3 and React component compatibility.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*
📄 CodeRabbit inference engine (AGENTS.md)
Use
pnpmfor package management, and ensure changes pass Prettier formatting, the build, Git hook validations, and content-structure validation.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
**/*.{ts,tsx,js,jsx,java,py,go,md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Use JSDoc, JavaDoc, or docstrings for functions, classes, and complex logic; document parameters, return values, types, exceptions, edge cases, useful references, and bug-fix issue links, using standard TODO, FIXME, and NOTE formats.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
src/content/docs/authenticate/**/*.mdx
⚙️ CodeRabbit configuration file
src/content/docs/authenticate/**/*.mdx: This page lives in the primary authentication section.
- If it's a quickstart or step-based guide, it MUST use
<Steps>.- Auth method pages (passwordless, social, SSO, passkeys) MUST include
a brief "when to use this" section before the implementation steps.- Any reference to tokens (idToken, accessToken, refreshToken) MUST
clarify: what it contains, its lifetime, and how to use it securely.- The FSA quickstart (
authenticate/fsa/quickstart.mdx) is the
canonical entry point — no other page should duplicate its 5-step
install→redirect→callback→session→logout structure.
Files:
src/content/docs/authenticate/mcp/custom-auth.mdx
🧠 Learnings (13)
📚 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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.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/authenticate/mcp/custom-auth.mdx
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/content/docs/authenticate/mcp/custom-auth.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/content/docs/authenticate/mcp/custom-auth.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (.mdx files), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag links for missing `target="_blank"` or `rel="noopener"` (avoid adding raw HTML anchors just to include those attributes), and keep the approach consistent with existing docs styling.
Applied to files:
src/content/docs/authenticate/mcp/custom-auth.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/content/docs/authenticate/mcp/custom-auth.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (MD/MDX), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag external links for missing `target="_blank"` or `rel="noopener"`, and avoid converting Markdown links into raw HTML `<a>` tags just to add those attributes, since that would be inconsistent with the established doc pattern.
Applied to files:
src/content/docs/authenticate/mcp/custom-auth.mdx
🔇 Additional comments (1)
src/content/docs/authenticate/mcp/custom-auth.mdx (1)
189-191: LGTM!Also applies to: 200-202
|
@claude Address the comments by @CodeRabbit if they make sense to address. |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
repo="scalekit-inc/developer-docs"
pr="927"
echo "== CodeRabbit review comments =="
gh api --paginate "repos/${repo}/pulls/${pr}/comments" \
--jq '.[] | select(.user.login == "coderabbitai" or .user.login == "coderabbit") | {id, path, line, side, body, html_url, created_at}' || true
echo
echo "== CodeRabbit issue comments =="
gh api --paginate "repos/${repo}/issues/${pr}/comments" \
--jq '.[] | select(.user.login == "coderabbitai" or .user.login == "coderabbit") | {id, body, html_url, created_at}' || true
echo
echo "== Current PR diff =="
gh pr diff "$pr" --repo "$repo" -- src/content/docs/authenticate/mcp/custom-auth.mdx
echo
echo "== Current target file =="
nl -ba src/content/docs/authenticate/mcp/custom-auth.mdx | sed -n '1,260p'Length of output: 1215 🏁 Script executed: #!/bin/bash
set -euo pipefail
repo="scalekit-inc/developer-docs"
pr="927"
diff_file="$(mktemp)"
gh pr diff "$pr" --repo "$repo" > "$diff_file"
echo "== Target-file diff =="
awk '
/^diff --git a\/src\/content\/docs\/authenticate\/mcp\/custom-auth\.mdx b\/src\/content\/docs\/authenticate\/mcp\/custom-auth\.mdx$/ { show=1 }
/^diff --git / && !/^diff --git a\/src\/content\/docs\/authenticate\/mcp\/custom-auth\.mdx b\/src\/content\/docs\/authenticate\/mcp\/custom-auth\.mdx$/ { show=0 }
show { print }
' "$diff_file"
echo
echo "== Current target file =="
nl -ba src/content/docs/authenticate/mcp/custom-auth.mdx | sed -n '1,280p'Length of output: 3120
You are interacting with an AI system. |
Split invalid_state troubleshooting into expired-request vs mismatched-state causes, and rewrite the new guidance in developer-facing second person.
3 participants
Why: A few users hit avoidable failures on the bring-your-own-auth (BYOA) MCP handoff. Some saw an
invalid_stateerror page when a first-time user took longer than the login window to finish signing up; another hit gateway timeouts when a new SDK client was constructed on every request. The page described thestateround-trip but never stated how long the login request stays valid or what error a timeout produces.What: Surgical edit in
src/content/docs/authenticate/mcp/custom-auth.mdx. Added a line to step 1 noting the login request andstatestay valid for approximately 10 minutes (and expiry surfaces asinvalid_state), plus a short Troubleshooting section covering theinvalid_stateerror page and thedeadline_exceededhandoff timeout (reuse a single Scalekit client instead of building one per request). Copy-only, no nav or config changes. Skills applied: docs-engineering, docs-contribution-router, docs-writing-style.Check: Open
/authenticate/mcp/custom-auth/; confirm step 1 states the ~10-minute validity window and the Troubleshooting section explainsinvalid_stateand the handoff-timeout fix.Preview: https://deploy-preview-927--scalekit-starlight.netlify.app/authenticate/mcp/custom-auth/
Summary by CodeRabbit
invalid_stateerrors and gateway timeouts.