Skip to content

Commit 88f191d

Browse files
Developer guide enhancement (#521)
Signed-off-by: Riya Saxena <[email protected]> (cherry picked from commit 67fc209) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 3d1ef52 commit 88f191d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: DEVELOPER_GUIDE.md

+15
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ To build from the command line, use `./gradlew`.
3030
./gradlew publishToMavenLocal
3131
```
3232

33+
### Build your custom tool
34+
35+
* Create a new Java file in the specified package directory -> eg. cat src/main/java/org/opensearch/agent/tools/NewTool.java
36+
* Modify ToolPlugin file to instantiate, initialize, and add the new tool, refer -> ([here](https://github.com/opensearch-project/skills/pull/81/files))
37+
* Start the server with ./gradlew run
38+
39+
### Test your custom tool
40+
41+
* Make sure to have access to the LLM that you're using
42+
* Create any remote connector using ([remote_inference_blueprints](https://github.com/opensearch-project/ml-commons/blob/main/docs/remote_inference_blueprints))
43+
* Get the model_id from the step above and provide it as a parameter in below step to register the agent
44+
* Register the agent that will run your custom tool for ([reference](https://opensearch.org/docs/latest/ml-commons-plugin/agents-tools/tools/ml-model-tool/#step-3-register-a-flow-agent-that-will-run-the-mlmodeltool))
45+
* Get the agent_id from the step above and provide it as part of URL in below step to run the agent
46+
* Run the agent ([refer](https://opensearch.org/docs/latest/ml-commons-plugin/agents-tools/tools/ml-model-tool/#step-4-run-the-agent))
47+
3348
### Using IntelliJ IDEA
3449

3550
Launch Intellij IDEA, choose **Import Project**, and select the `settings.gradle` file in the root of this package.

0 commit comments

Comments
 (0)