Skip to content

docs: Add Codex CLI configuration guide#305

Open
vincent067 wants to merge 2 commits into
hashicorp:mainfrom
vincent067:docs/add-codex-cli-support
Open

docs: Add Codex CLI configuration guide#305
vincent067 wants to merge 2 commits into
hashicorp:mainfrom
vincent067:docs/add-codex-cli-support

Conversation

@vincent067

Copy link
Copy Markdown

Summary

This PR adds documentation for using the Terraform MCP Server with Codex CLI, OpenAI's official coding agent.

Changes

Added a new section "Usage with Codex CLI" to the README.md that includes:

  • Brief introduction to Codex CLI
  • Installation prerequisites (Node.js 18+, OpenAI API key)
  • Configuration examples for both stdio and HTTP transport modes
  • Example commands showing how to add the MCP server to Codex
  • JSON configuration examples consistent with other client sections (VS Code, Cursor, Claude Desktop, etc.)

Motivation

Codex CLI is gaining popularity as a terminal-based coding agent, and users need clear documentation on how to integrate the Terraform MCP Server with it. This documentation follows the same style and structure as existing sections for other MCP clients.

Testing

  • Verified the markdown renders correctly
  • Commands are based on Codex CLI's documented MCP configuration options

@vincent067 vincent067 requested a review from a team as a code owner March 26, 2026 19:54
@github-actions

Copy link
Copy Markdown

Changelog Warning

Please add a changelog entry to CHANGELOG.md for this change. If you believe this change does not need a changelog entry, please add the 'no-changelog-needed' label.

@hashicorp-cla-app

Copy link
Copy Markdown

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


liwenjun-dev seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA.
If you have already a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

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.

1 participant