Skip to content

Conversation

@davidkinde
Copy link
Contributor

@davidkinde davidkinde commented Dec 1, 2025

Description

MCP server about and set up guide.

Summary by CodeRabbit

  • Documentation
    • Added an MCP Server section with an overview, operations & scopes reference, and a detailed Get Started guide (setup, testing, troubleshooting, security best practices, examples, and AI assistant integration notes).
  • Navigation
    • Sidebar updated to surface the MCP Server docs before the "Auth and access" section for easier discovery.
  • Refactor
    • Minor sidebar entry formatting cleaned up to improve maintainability without changing visible behavior.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 1, 2025

Walkthrough

Adds a new top-level "MCP Server" sidebar section and three documentation pages: an overview, an operations-and-scopes reference, and a setup guide with configuration examples, troubleshooting, and security guidance.

Changes

Cohort / File(s) Summary
Sidebar configuration
src/data/sidebarData.ts
Inserts a new top-level "MCP Server" sidebar section (collapsed) placed before "Auth and access"; adds items About MCP Server and Get started; refactors several existing sidebar entries to multi-line object literals.
MCP Server docs — overview
src/content/docs/mcp-server/about-mcp-server/index.mdx
Adds overview MDX describing Kinde MCP Server purpose, example interactions, how it works, links to setup and operations docs, and frontmatter metadata.
MCP Server docs — get started / setup
src/content/docs/mcp-server/get-started/setup-mcp-server.mdx
Adds setup guide MDX with Environment API Key steps, per-assistant JSON configs (Cursor, Claude Desktop, VS Code), testing, troubleshooting, security best practices, and code samples/images.
MCP Server docs — operations & scopes
src/content/docs/mcp-server/about-mcp-server/operations-and-scopes.mdx
Adds operations-and-scopes MDX enumerating read/create operations across Users, Organizations, Roles & Permissions, and Configuration; maps operations to scopes and explains scope limitations and checks.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Dev as Developer/Admin
    participant AI as AI Assistant (Cursor/Claude/VS Code)
    participant MCP as Kinde MCP Server
    participant KMAPI as Kinde Management API
    rect rgb(230,245,255)
      Note over Dev,AI: User composes natural-language request
    end
    Dev->>AI: Prompt (e.g., "Invite user, assign role")
    AI->>MCP: Structured operation request + env API key / token
    alt Auth & scopes valid
        MCP->>KMAPI: Translated Management API call (service credentials)
        KMAPI-->>MCP: Success / data
        MCP-->>AI: Formatted result (natural-language + data)
        AI-->>Dev: Confirmation / details
    else Missing/insufficient scopes or auth
        MCP-->>AI: Error (insufficient scopes / auth)
        AI-->>Dev: Error message and troubleshooting tips
    end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I tunneled through docs by moonlight bright,
Carried JSON carrots into sight.
Scopes in rows and setup neat,
A tiny MCP burrow, warm and sweet.
Hop in, dev — let's get this right!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'feat: new section - Kinde MCP server documentation' directly and clearly describes the main change: adding a new documentation section for Kinde MCP Server.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch david/update/mcp

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e31098 and 1ad1861.

📒 Files selected for processing (1)
  • src/content/docs/mcp-server/about-mcp-server/index.mdx
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-27T18:42:29.479Z
Learnt from: victoreronmosele
Repo: kinde-oss/documentation PR: 647
File: src/content/docs/developer-tools/sdks/native/ios-sdk.mdx:278-297
Timestamp: 2025-12-27T18:42:29.479Z
Learning: In MDX documentation files (e.g., any API reference docs), when documenting parameters (like loginHint, connectionId), prefer listing them in the API reference Arguments section and link to detailed documentation pages instead of duplicating descriptions, format specs, or validation rules inline. This follows the 'document once, reference anywhere' principle.

Applied to files:

  • src/content/docs/mcp-server/about-mcp-server/index.mdx
🪛 LanguageTool
src/content/docs/mcp-server/about-mcp-server/index.mdx

[grammar] ~66-~66: Ensure spelling is correct
Context: ...rovides a new way to interact with your Kinde account. In addition to the Kinde UI an...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (1)
src/content/docs/mcp-server/about-mcp-server/index.mdx (1)

1-79: LGTM! Past issues resolved, documentation is clear and well-structured.

The previous review feedback has been successfully addressed:

  • Grammar corrections in the "How it works" section (environment-level, set up, restricted to)
  • Fixed link path to the setup guide

The documentation provides a clear overview of the Kinde MCP Server with helpful examples, logical workflow explanation, and appropriate cross-references. The static analysis hint flagging "Kinde" as a spelling error is a false positive—it's the correct product name.


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.

❤️ Share

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

@davidkinde davidkinde changed the title MCP documentation WIP: MCP documentation Dec 1, 2025
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 1, 2025

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1ad1861
Status: ✅  Deploy successful!
Preview URL: https://7db2a439.kinde-docs-preview.pages.dev
Branch Preview URL: https://david-update-mcp.kinde-docs-preview.pages.dev

View logs

coderabbitai[bot]

This comment was marked as outdated.

coderabbitai[bot]

This comment was marked as outdated.

coderabbitai[bot]

This comment was marked as outdated.

@tamalchowdhury
Copy link
Collaborator

Tamal's new updates:

Organized the doc structure: to keep consistency across other sections.

  • About MCP Server
  • Get started

Changed the section order to go after the APIs section, and to be more prominent, since MCP will be a huge and important feature moving forward.

coderabbitai[bot]

This comment was marked as outdated.

Copy link
Collaborator

@tamalchowdhury tamalchowdhury left a comment

Choose a reason for hiding this comment

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

We are working on this.

coderabbitai[bot]

This comment was marked as resolved.

@tamalchowdhury tamalchowdhury changed the title WIP: MCP documentation feat: new section - Kinde MCP server documentation Dec 3, 2025
@tamalchowdhury
Copy link
Collaborator

tamalchowdhury commented Dec 3, 2025

@onderay and @davidkinde --please have a look at this draft:

Summary:
Organized the section sidebar to be higher and more prominent.
Split into a total of 3 pages (About, Scopes, and Setup guide) + Screenshots.

If you like it, it's ready to ship.

@davidkinde davidkinde requested a review from a team as a code owner December 17, 2025 11:42
coderabbitai[bot]

This comment was marked as resolved.

@davidkinde
Copy link
Contributor Author

All updates LGTM, happy for this to be approved (I can't as I raised the PR)

coderabbitai[bot]

This comment was marked as resolved.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
coderabbitai[bot]

This comment was marked as resolved.

davidkinde and others added 2 commits December 17, 2025 13:21
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
coderabbitai[bot]

This comment was marked as resolved.

@davidkinde
Copy link
Contributor Author

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/content/docs/mcp-server/get-started/setup-mcp-server.mdx (2)> 114-125: Consider environment variables for the API key.

The Cursor configuration hardcodes the API key directly in the JSON file (line 120), which contradicts the security best practice on line 294 about not committing keys to version control. If this mcp.json file is tracked in version control, the key would be exposed.
Consider documenting an environment variable approach similar to the Claude Desktop configuration (lines 154-156), or add an explicit warning that this configuration file should be added to .gitignore.

288-294: Add guidance for config file security.
Line 294 correctly advises against committing API keys to version control, but the Cursor and VS Code configuration examples (lines 120, 181) show hardcoded API keys that could easily be committed if the config files are tracked.
Consider adding explicit guidance to either:

  • Add mcp.json (Cursor/VS Code) to .gitignore
  • Use environment variables or a separate secrets file
  • Reference the Claude Desktop pattern (lines 154-156) as a more secure approach

Additionally, line 293 mentions "Kinde audit logs" but doesn't explain how to access them or provide a link to documentation.

📜 Review details

The mcp.json shouldn't be committed to version control, it's config settings for the client.

coderabbitai[bot]

This comment was marked as resolved.

@tamalchowdhury tamalchowdhury self-requested a review December 18, 2025 10:34
Updated the image caption to clarify the AI assistant's response regarding user organizations in Kinde.
Copy link
Collaborator

@tamalchowdhury tamalchowdhury left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link
Contributor

@alex72508 alex72508 left a comment

Choose a reason for hiding this comment

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

Approving and merging

@alex72508 alex72508 merged commit 2bd5796 into main Jan 8, 2026
6 checks passed
@alex72508 alex72508 deleted the david/update/mcp branch January 8, 2026 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants