Skip to content

docs: add Codex AI tool guide#7865

Merged
ankur-arch merged 2 commits into
mainfrom
codex/add-codex-ai-docs
May 18, 2026
Merged

docs: add Codex AI tool guide#7865
ankur-arch merged 2 commits into
mainfrom
codex/add-codex-ai-docs

Conversation

@AmanVarshney01
Copy link
Copy Markdown
Member

@AmanVarshney01 AmanVarshney01 commented May 4, 2026

Summary

Adds Codex to the Prisma AI tools docs.

Changes

  • Add a new /ai/tools/codex guide for installing the Prisma Codex plugin.
  • Document that the plugin includes Prisma ORM skills plus the remote Prisma MCP server.
  • Add Codex to the AI tools nav and /ai overview page.
  • Add Codex setup instructions to the MCP server integration guide.

Validation

  • pnpm --filter docs types:check
  • pnpm --filter docs lint:links
  • pnpm --filter docs lint:spellcheck
  • pnpm exec oxfmt --check apps/docs/content/docs/ai/index.mdx apps/docs/content/docs/ai/tools/codex.mdx apps/docs/content/docs/ai/tools/mcp-server.mdx apps/docs/content/docs/ai/tools/meta.json

Summary by CodeRabbit

  • Documentation
    • Added Codex integration documentation with installation instructions for the Prisma Codex plugin
    • Included configuration guide for the remote Prisma MCP server integration with Codex
    • Documented safety features protecting against destructive operations when using AI agents

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment May 18, 2026 3:20pm
docs Ready Ready Preview, Comment May 18, 2026 3:20pm
eclipse Ready Ready Preview, Comment May 18, 2026 3:20pm
site Ready Ready Preview, Comment May 18, 2026 3:20pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4ba31aa6-d780-4e4f-870b-8c12ac8c0210

📥 Commits

Reviewing files that changed from the base of the PR and between 32e7910 and 40718ac.

📒 Files selected for processing (4)
  • apps/docs/content/docs/ai/index.mdx
  • apps/docs/content/docs/ai/tools/codex.mdx
  • apps/docs/content/docs/ai/tools/mcp-server.mdx
  • apps/docs/content/docs/ai/tools/meta.json

Walkthrough

This PR adds comprehensive Codex integration documentation to the Prisma docs. The changes introduce Codex as a supported AI coding tool, with an index page reference, a dedicated tool documentation page with installation and configuration details, integration with the MCP server documentation, and corresponding navigation metadata updates.

Changes

Codex AI Tool Documentation

Layer / File(s) Summary
Index page references to Codex
apps/docs/content/docs/ai/index.mdx
Updated frontmatter description to include Codex and added a new list entry for Codex with documentation link and setup description.
Codex tool documentation page
apps/docs/content/docs/ai/tools/codex.mdx
Created complete documentation for the Prisma Codex plugin, including installation instructions, MCP server configuration details, available capabilities, example prompts for ORM setup and database operations, and safety guardrails for destructive commands requiring explicit user consent.
MCP server Codex integration documentation
apps/docs/content/docs/ai/tools/mcp-server.mdx
Added Codex subsection describing plugin installation from the Codex marketplace and the remote MCP server URL configuration used by the plugin.
Navigation metadata update
apps/docs/content/docs/ai/tools/meta.json
Reformatted pages array from single-line to multi-line format and ensured codex is registered in the navigation structure.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: add Codex AI tool guide' directly and clearly summarizes the main change—adding documentation for the Codex AI tool—which aligns perfectly with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

🍈 Lychee Link Check Report

34 links: ✅ 13 OK | 🚫 0 errors | 🔀 5 redirects | 👻 15 excluded

✅ All links are working!


Full Statistics Table
Status Count
✅ Successful 13
🔀 Redirected 5
👻 Excluded 15
🚫 Errors 0
⛔ Unsupported 1
⏳ Timeouts 0
❓ Unknown 0

@argos-ci
Copy link
Copy Markdown

argos-ci Bot commented May 4, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 1 changed May 18, 2026, 3:27 PM

@ankur-arch ankur-arch merged commit dc85af1 into main May 18, 2026
16 of 17 checks passed
@ankur-arch ankur-arch deleted the codex/add-codex-ai-docs branch May 18, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants