Skip to content

docs: add Claude Code CLI setup and API enablement instructions #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Claude Code CLI setup and API enablement instructions #5

wants to merge 1 commit into from

Conversation

@jsindy
Copy link

@jsindy jsindy commented Jun 2, 2025 •
edited by coderabbitai bot
Loading

Summary

  • Add Claude Code CLI configuration section with claude mcp add-json command
  • Add required API enablement step for Cloud Resource Manager API
  • Include CLAUDE.md file with project context for AI assistants

Test plan

  • Verify README displays correctly on GitHub
  • Test Claude Code CLI setup instructions work
  • Confirm API enablement step resolves project listing issues

Authored-By: jsindy

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for using the repository with Claude Code, detailing architecture, development commands, available tools, and operational notes.
    • Updated the README with configuration instructions for Claude Code CLI and clarified GCP setup steps, including enabling the required API.

@jsindy
docs: add Claude Code CLI setup and API enablement instructions
8e72e1f 
- Add Claude Code CLI configuration section with mcp add-json command
- Add required API enablement step for Cloud Resource Manager API
- Include CLAUDE.md file with project context for AI assistants

Authored-By: jsindy
@coderabbitai
Copy link

coderabbitai bot commented Jun 2, 2025 •
edited
Loading

Walkthrough

A new documentation file, CLAUDE.md, was introduced to describe the repository's Model Context Protocol (MCP) server for Google Cloud Platform, including its architecture, tools, and operational guidance. The README.md was updated to add configuration instructions for the Claude Code CLI and clarify GCP API setup steps.

Changes

File(s) Change Summary
CLAUDE.md Added a comprehensive documentation file detailing the MCP server, architecture, tools, and usage.
README.md Updated with Claude Code CLI configuration instructions and expanded GCP setup steps.

Poem

In burrows deep, new docs appear,
CLAUDE.md makes the purpose clear.
README grows with setup wise,
Cloudy steps now organize.
With every hop and every line,
This project’s guide is quite divine!
🐇✨

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jun 2, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (10)
CLAUDE.md (8)

5-8: Project Overview is concise
Nicely explains the MCP server’s role. Consider linking to the official MCP spec or relevant GCP docs for readers unfamiliar with Model Context Protocol.

9-15: Include CI-friendly install command
It might be helpful to mention npm ci for deterministic installs in CI pipelines. For example:

- `npm ci` – Install dependencies from lockfile in CI environments

16-24: Improve Architecture formatting
The core components section is detailed but could be easier to scan with consistent indentation. For example:

- **Code Execution Engine (`index.ts:24-40`)**
- - Sandboxed TypeScript/JavaScript ...
+ **Code Execution Engine** (`index.ts:24-40`)
+   - Sandboxed TypeScript/JavaScript execution using `vm`

35-44: Enhance tool list scannability
Consider numbering the nine tools or using individual H3 headings for each to help readers locate a specific tool quickly:

1. **run-gcp-code**: ...
2. **list-projects**: ...

46-56: Clarify IAM requirements
Optionally document required IAM roles or scopes for each injected GCP client to prevent permission errors during execution.

58-69: Link to retry/backoff implementation
Link directly to the retry logic in index.ts:265-277 so developers can inspect the exponential backoff code.

70-74: Detail AST transformation
Briefly note which AST nodes are transformed (e.g., expression statements → return statements) when describing code wrapping to set reader expectations.

75-81: Typographical nit: Missing period
Line 81 lacks a terminal period.

- All client libraries use the currently selected project by default
+ All client libraries use the currently selected project by default.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~81-~81: A period might be missing here.
Context: ...s use the currently selected project by default

(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)

README.md (2)

37-42: Document Claude CLI prerequisites
Add a note about installing/updating the Claude CLI before running claude mcp add-json:

> Ensure you have Claude CLI v1.2.3 or later:  
> `npm install -g @anthropic/claude-cli`

113-119: Clarify API enablement step
The new step is valuable—consider prefacing that this shifts existing numbering and that cloudresourcemanager.googleapis.com is required for project listing:

2. Enable the Cloud Resource Manager API (needed for `list-projects`):
   ```bash
   gcloud services enable cloudresourcemanager.googleapis.com --project=your-project-id

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**


<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between acfc8c173e9a53980231c4a1eccef34fc438c6f4 and 8e72e1f01340c1f1f90c528599da5ad46b8307c7.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `CLAUDE.md` (1 hunks)
* `README.md` (2 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>CLAUDE.md</summary>

[uncategorized] ~81-~81: A period might be missing here.
Context: ...s use the currently selected project by default

(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>CLAUDE.md (1)</summary>

`1-4`: **Strong title and introduction**  
The title and opening line clearly establish the document’s purpose for guiding Claude Code integration.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jsindy