This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 6c644a0d [doc] Add faq for running examples in IDE. (#484)
6c644a0d is described below
commit 6c644a0daa040dc657445174f412bbd94ffdde3b
Author: Wenjin Xie <[email protected]>
AuthorDate: Mon Jan 26 19:39:07 2026 +0800
[doc] Add faq for running examples in IDE. (#484)
---
docs/content/docs/faq/faq.md | 7 +++++++
docs/content/docs/get-started/installation.md | 2 +-
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/docs/content/docs/faq/faq.md b/docs/content/docs/faq/faq.md
index beb6cf85..30a3af50 100644
--- a/docs/content/docs/faq/faq.md
+++ b/docs/content/docs/faq/faq.md
@@ -96,3 +96,10 @@ The following matrix shows the native integration support
status of providers ov
| [MCP Server]({{< ref "docs/development/mcp" >}}) | ✅ | ✅ | ❌ |
Java native MCP support requires **JDK 17+**. See [MCP]({{< ref
"docs/development/mcp" >}}) for details.
+
+## Q4: How to run agent in IDE.
+
+To avoid potential conflict with Flink cluster, the scope of the dependencies
related to Flink and Flink Agents for agent job are provided. See [Maven
Dependencies]({{< ref
"docs/get-started/installation/#maven-dependencies-for-java" >}}) for details.
+
+To run the examples in IDE, users must enable the IDE feature: `add
dependencies with provided scope to classpath`.
+* For **IDEA**, edit the **`Run/Debug Configuration`** and enable **`add
dependencies with provided scope to classpath`**. See [Run/Debug
Configuration](https://www.jetbrains.com/help/idea/run-debug-configuration-scala.html)
for details.
\ No newline at end of file
diff --git a/docs/content/docs/get-started/installation.md
b/docs/content/docs/get-started/installation.md
index 1aa4c162..a9b59fb0 100644
--- a/docs/content/docs/get-started/installation.md
+++ b/docs/content/docs/get-started/installation.md
@@ -168,7 +168,7 @@ For developing Flink Agents applications in Java, add the
following dependencies
{{< hint info >}}
All the above dependencies should be in provided scope, to avoid potential
conflict with the Flink cluster.
-For execution in IDE, enable the feature `add dependencies with provided scope
to classpath` in your IDE.
+For execution in IDE, enable the feature `add dependencies with provided scope
to classpath` in your IDE. See [FAQ]({{< ref
"docs/faq/faq/#q4-how-to-run-agent-in-ide" >}}) for details.
{{< /hint >}}
**Example `pom.xml`**
