Clarify where the LLM API key files should be. #9758

[dpage]

#9758

Summary by CodeRabbit

• Documentation
  • Improved API Key File descriptions for Anthropic and OpenAI providers, clarifying that file paths are relative to the pgAdmin server filesystem (including container environments), that the ~ prefix expands to the user's home directory, and that the field is optional when using custom API URLs.

[coderabbitai]

Walkthrough

Documentation and help text clarifications were expanded for AI provider API key file paths across configuration documentation and application code. The updates explain that paths are relative to the pgAdmin server filesystem, support home directory (~) expansion, and are optional when using custom URLs.

Changes

Cohort / File(s)	Summary
Documentation - AI Tools & Preferences docs/en_US/ai_tools.rst, docs/en_US/preferences.rst	Expanded API Key File field descriptions for Anthropic and OpenAI sections to clarify filesystem path semantics, container context, home directory expansion, and optional usage with custom URLs.
Application Help Text web/pgadmin/llm/__init__.py	Enhanced help text for API key file path configuration to indicate paths must reside on the pgAdmin server filesystem (e.g., inside containers).

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 clearly and specifically summarizes the main change: clarifying documentation about where LLM API key files should be located, which aligns with the actual changes across three documentation/code files.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

📝 Coding Plan

• Generate coding plan for human review comments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (1)

web/pgadmin/llm/__init__.py (1)

126-127: Keep UI help text consistent with implemented ~ path expansion.

Consider adding one short sentence that ~ expands to the pgAdmin server process user’s home directory, so the in-app help matches documented and implemented behavior.

Suggested wording tweak

                 'This path must be on the server hosting pgAdmin, '
                 'e.g. inside the container when using Docker. '
+                'The ~ prefix expands to the home directory of the '
+                'user running the pgAdmin server process. '
                 'The file should contain only the API key. The API key '

Also applies to: 190-191

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@web/pgadmin/llm/__init__.py` around lines 126 - 127, The UI help text strings
in web/pgadmin/llm/__init__.py that warn "This path must be on the server
hosting pgAdmin..." need a short追加 sentence stating that "~" expands to the
pgAdmin server process user's home directory so the in-app help matches
implemented behavior; locate the two occurrences of that help text in the module
and append a concise sentence like '"Note: "~" expands to the pgAdmin server
process user’s home directory."' to each string.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@web/pgadmin/llm/__init__.py`:
- Around line 126-127: The UI help text strings in web/pgadmin/llm/__init__.py
that warn "This path must be on the server hosting pgAdmin..." need a short追加
sentence stating that "~" expands to the pgAdmin server process user's home
directory so the in-app help matches implemented behavior; locate the two
occurrences of that help text in the module and append a concise sentence like
'"Note: "~" expands to the pgAdmin server process user’s home directory."' to
each string.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d2d48fc1-fe6a-4708-b233-3419dc6d966b

📥 Commits

Reviewing files that changed from the base of the PR and between e347210 and 624b30e.

📒 Files selected for processing (3)

• docs/en_US/ai_tools.rst
• docs/en_US/preferences.rst
• web/pgadmin/llm/__init__.py