Skip to content

build: add CLAUDE.md#68

Open
xcoulon wants to merge 1 commit into
codeready-toolchain:masterfrom
xcoulon:claude_md
Open

build: add CLAUDE.md#68
xcoulon wants to merge 1 commit into
codeready-toolchain:masterfrom
xcoulon:claude_md

Conversation

@xcoulon

@xcoulon xcoulon commented Mar 31, 2026

Copy link
Copy Markdown
Collaborator

Signed-off-by: Xavier Coulon xcoulon@redhat.com
Assisted-by: Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive development guidance covering project setup, testing workflows, architecture conventions, and configuration requirements.

Signed-off-by: Xavier Coulon <xcoulon@redhat.com>
Assisted-by: Claude Code
@coderabbitai

coderabbitai Bot commented Mar 31, 2026

Copy link
Copy Markdown

Walkthrough

A new CLAUDE.md documentation file has been added to provide guidance for Claude Code about the MCP server project, covering project description, development instructions, testing setup, usage examples, code architecture, and development patterns.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
Added new guidance document for Claude Code covering project overview, development workflow (Taskfile-based), e2e test setup, usage examples, code architecture, naming conventions, and dependencies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'build: add CLAUDE.md' clearly and accurately describes the primary change - adding a new documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Around line 55-60: The doc has inconsistent env var names—ARGOCD_MCP_DEBUG
(used in the podman run example) vs ARGOCD_MCP_SERVER_DEBUG (documented later);
pick the canonical name (use ARGOCD_MCP_SERVER_DEBUG), then update every
occurrence in this file (including the podman run example and the section around
lines 140–147) so the examples and docs match; ensure references to
ARGOCD_MCP_SERVER_LISTEN_HOST, ARGOCD_URL, ARGOCD_TOKEN remain unchanged and
only the debug variable name is normalized throughout.
- Around line 66-77: The fenced package-structure code block in the README (the
triple-backtick block showing the cmd/ and internal/ tree) is missing a language
tag; update the opening fence from ``` to ```text so the block becomes a ```text
code fence to satisfy markdownlint MD040 and render as plain text (locate the
triple-backtick block that lists cmd/, start_server.go, main.go, internal/,
server/, argocd/, etc., and add the "text" language identifier).
🪄 Autofix (Beta)

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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1365b4b4-d1b8-4a8e-8d57-d69fce603c3e

📥 Commits

Reviewing files that changed from the base of the PR and between 1595edc and 7e73d07.

📒 Files selected for processing (1)
  • CLAUDE.md

Comment thread CLAUDE.md
Comment on lines +55 to +60
podman run -d --name argocd-mcp-server \
-e ARGOCD_MCP_SERVER_LISTEN_HOST=0.0.0.0 \
-e ARGOCD_URL=<url> \
-e ARGOCD_TOKEN=<token> \
-e ARGOCD_MCP_DEBUG=true \
-p 8080:8080 argocd-mcp-server:latest

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Fix inconsistent debug environment variable naming.

Line 59 uses ARGOCD_MCP_DEBUG, but Line 146 documents ARGOCD_MCP_SERVER_DEBUG. This inconsistency can misconfigure local/container debugging.

Suggested doc fix
-  -e ARGOCD_MCP_DEBUG=true \
+  -e ARGOCD_MCP_SERVER_DEBUG=true \

As per coding guidelines, "Focus on major issues impacting performance, readability, maintainability and security."

Also applies to: 140-147

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 55 - 60, The doc has inconsistent env var
names—ARGOCD_MCP_DEBUG (used in the podman run example) vs
ARGOCD_MCP_SERVER_DEBUG (documented later); pick the canonical name (use
ARGOCD_MCP_SERVER_DEBUG), then update every occurrence in this file (including
the podman run example and the section around lines 140–147) so the examples and
docs match; ensure references to ARGOCD_MCP_SERVER_LISTEN_HOST, ARGOCD_URL,
ARGOCD_TOKEN remain unchanged and only the debug variable name is normalized
throughout.

Comment thread CLAUDE.md
Comment on lines +66 to +77
```
cmd/
start_server.go # Cobra CLI command, flags, HTTP server setup
main.go # Entry point
internal/
server/
server.go # MCP server initialization, middleware, tool/prompt registration
argocd/
argocd_client.go # HTTP client for Argo CD API
unhealthy_applications.go
unhealthy_application_resources.go
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add language tag to fenced code block.

The package-structure code fence (starting at Line 66) is missing a language identifier (markdownlint MD040).

Suggested doc fix
-```
+```text
 cmd/
   start_server.go         # Cobra CLI command, flags, HTTP server setup
 main.go                   # Entry point
 internal/
@@
-```
+```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
cmd/
start_server.go # Cobra CLI command, flags, HTTP server setup
main.go # Entry point
internal/
server/
server.go # MCP server initialization, middleware, tool/prompt registration
argocd/
argocd_client.go # HTTP client for Argo CD API
unhealthy_applications.go
unhealthy_application_resources.go
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 66-66: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 66 - 77, The fenced package-structure code block in
the README (the triple-backtick block showing the cmd/ and internal/ tree) is
missing a language tag; update the opening fence from ``` to ```text so the
block becomes a ```text code fence to satisfy markdownlint MD040 and render as
plain text (locate the triple-backtick block that lists cmd/, start_server.go,
main.go, internal/, server/, argocd/, etc., and add the "text" language
identifier).

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