Skip to content

docs: add instruction for supporting vector search in DEVELOPER.md #3137

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

Merged
duwenxin99 merged 4 commits into from
May 13, 2026
+4 −0
Merged

docs: add instruction for supporting vector search in DEVELOPER.md #3137

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9753ea
docs: add instruction for supporting vector search in DEVELOPER.md
duwenxin99 Apr 28, 2026
5235632
Update DEVELOPER.md
duwenxin99 May 13, 2026
9d6126a
Update DEVELOPER.md
duwenxin99 May 13, 2026
1e4cc04
Merge branch 'main' into vector-doc
duwenxin99 May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions DEVELOPER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,10 @@ tools.
run based on the provided authentication services.
* **Implement `init()`** to register the new Tool.
* **Implement Unit Tests** in a file named `newdbtool_test.go`.
* **Implement Vector Search** if your new tool supports it. You must:
1. Validate that the vector embedding format can be injected successfully into your Tool's statement. If not, update `Tool.EmbedParams()` to pass in a vector formatter into `parameters.EmbedParams`.
1. Feel free to reuse existing vector [formatters](internal/embeddingmodels/embeddingmodels.go) or create new ones.
1. Add tests and documentation for vector injection and vector search. See the [BigQuery SQL tool](docs/en/integrations/bigquery/tools/bigquery-sql.md) for an example.

#### Adding Integration Tests

Expand Down
Loading