-
Notifications
You must be signed in to change notification settings - Fork 463
New tools enhancements #2405
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.
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
Open
arikalon1
wants to merge
4
commits into
master
Choose a base branch
from
new-tools-enhancements
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
New tools enhancements #2405
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3e8ce8d
Add Freshservice (Freshworks ITSM) toolset
claude e8881b0
Add optional write tools (CRUD) to the Freshservice toolset
claude 4c1d228
Merge remote-tracking branch 'origin/master' into claude/freshservice…
claude 3dd1928
Add environment scoping to Datadog toolsets
claude File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| # Freshservice | ||
|
|
||
| Connect HolmesGPT to [Freshservice](https://www.freshworks.com/freshservice/) (Freshworks ITSM) to work with tickets, problems, changes, releases, assets, requesters, agents, the service catalog, the knowledge base and every other Freshservice object via the [Freshservice API v2](https://api.freshservice.com/). | ||
|
|
||
| Access is read-only by default. Create/update/delete tools can be enabled with `enable_write_tools: true`, and each write requires human approval unless you disable that too (see [Write access](#write-access-optional)). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Freshservice instance (e.g. `https://your-domain.freshservice.com`) | ||
| - A Freshservice API key. In the Freshservice UI, click your profile picture → **Profile settings** — the API key is shown below the change password section. | ||
|
|
||
| The API key inherits the permissions of its user, so the tickets, changes and other objects HolmesGPT can read are determined by that user's role. Some object types (e.g. assets/CMDB) are only available on certain Freshservice plans; HolmesGPT reports the exact API error when an object type is not accessible. | ||
|
|
||
| Verify your credentials: | ||
|
|
||
| ```bash | ||
| curl -u <your-api-key>:X "https://<your-domain>.freshservice.com/api/v2/tickets?per_page=1" | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| === "Holmes CLI" | ||
|
|
||
| Add the following to **~/.holmes/config.yaml**. Create the file if it doesn't exist: | ||
|
|
||
| ```yaml | ||
| toolsets: | ||
| freshservice: | ||
| enabled: true | ||
| config: | ||
| api_url: <your Freshservice URL> # e.g. https://your-domain.freshservice.com | ||
| api_key: <your Freshservice API key> | ||
|
|
||
| # Optional | ||
| default_page_size: 30 # Records per page when the LLM doesn't specify (max 100) | ||
| timeout_seconds: 30 # HTTP timeout for Freshservice API requests | ||
| health_check_object: tickets # Object type listed on startup to verify connectivity | ||
| ``` | ||
|
|
||
| --8<-- "snippets/toolset_refresh_warning.md" | ||
|
|
||
| To test, run: | ||
|
|
||
| ```bash | ||
| holmes ask "Show me all open urgent tickets in Freshservice" | ||
| ``` | ||
|
|
||
| === "Holmes Helm Chart" | ||
|
|
||
| First, create a Kubernetes secret with your Freshservice API key: | ||
|
|
||
| ```bash | ||
| kubectl create secret generic freshservice-credentials \ | ||
| --from-literal=api-key=your-freshservice-api-key \ | ||
| -n holmes | ||
| ``` | ||
|
|
||
| --8<-- "snippets/secret_namespace_note.md" | ||
|
|
||
| Then add to your Holmes Helm values: | ||
|
|
||
| ```yaml | ||
| additionalEnvVars: | ||
| - name: FRESHSERVICE_API_KEY | ||
| valueFrom: | ||
| secretKeyRef: | ||
| name: freshservice-credentials | ||
| key: api-key | ||
|
|
||
| toolsets: | ||
| freshservice: | ||
| enabled: true | ||
| config: | ||
| api_url: <your Freshservice URL> # e.g. https://your-domain.freshservice.com | ||
| api_key: "{{ env.FRESHSERVICE_API_KEY }}" | ||
| ``` | ||
|
|
||
| === "Robusta Helm Chart" | ||
|
|
||
| First, create a Kubernetes secret with your Freshservice API key: | ||
|
|
||
| ```bash | ||
| kubectl create secret generic freshservice-credentials \ | ||
| --from-literal=api-key=your-freshservice-api-key \ | ||
| -n default | ||
| ``` | ||
|
|
||
| --8<-- "snippets/secret_namespace_note.md" | ||
|
|
||
| Then add to your Robusta Helm values: | ||
|
|
||
| ```yaml | ||
| holmes: | ||
| additionalEnvVars: | ||
| - name: FRESHSERVICE_API_KEY | ||
| valueFrom: | ||
| secretKeyRef: | ||
| name: freshservice-credentials | ||
| key: api-key | ||
| toolsets: | ||
| freshservice: | ||
| enabled: true | ||
| config: | ||
| api_url: <your Freshservice URL> # e.g. https://your-domain.freshservice.com | ||
| api_key: "{{ env.FRESHSERVICE_API_KEY }}" | ||
| ``` | ||
|
|
||
| --8<-- "snippets/helm_upgrade_command.md" | ||
|
|
||
| ### Optional Fields | ||
|
|
||
| | Option | Default | Description | | ||
| |--------|---------|-------------| | ||
| | `default_page_size` | `30` | Number of records returned per page when the LLM does not specify one (max 100). | | ||
| | `timeout_seconds` | `30` | Timeout for Freshservice API requests. | | ||
| | `health_check_object` | `tickets` | Object type listed on startup to verify connectivity and permissions. Change this if your API key cannot access tickets. | | ||
| | `enable_write_tools` | `false` | Expose tools that create, update and delete Freshservice objects. When `false`, only read tools are available. | | ||
| | `require_approval_for_writes` | `true` | When write tools are enabled, require human approval before each create/update/delete call. Set to `false` for fully autonomous writes. | | ||
|
|
||
| ## Write Access (optional) | ||
|
|
||
| By default HolmesGPT can only read from Freshservice. To let it create, update and delete objects (tickets, problems, changes, notes, tasks, time entries, custom object records and more), enable write tools: | ||
|
|
||
| ```yaml | ||
| toolsets: | ||
| freshservice: | ||
| enabled: true | ||
| config: | ||
| api_url: <your Freshservice URL> | ||
| api_key: <your Freshservice API key> | ||
| enable_write_tools: true | ||
| # require_approval_for_writes: false # only for fully autonomous writes | ||
| ``` | ||
|
|
||
| With writes enabled, six additional tools become available: `freshservice_create_object`, `freshservice_update_object`, `freshservice_delete_object` and their `*_related_object` counterparts for notes, replies, tasks and time entries. | ||
|
|
||
| !!! warning | ||
| Every write call requires interactive human approval by default. Only set `require_approval_for_writes: false` in automated flows where the API key's own Freshservice role is scoped to what Holmes should be allowed to touch — deletes move tickets to trash and deactivate requesters/agents. Some object types are read-only in the Freshservice API itself (roles, workspaces, form fields, SLA policies, business hours, service catalog) regardless of this setting. | ||
|
|
||
| ## Multiple Instances | ||
|
|
||
| ```multi-instance | ||
| toolset: freshservice | ||
| name: Freshservice | ||
| config: | | ||
| api_url: <your Freshservice URL> | ||
| api_key: <your Freshservice API key> | ||
| ``` | ||
|
|
||
| ## Common Use Cases | ||
|
|
||
| ``` | ||
| Which urgent Freshservice tickets are currently open, and what do their latest conversations say? | ||
| ``` | ||
|
|
||
| ``` | ||
| Are there any Freshservice changes planned for this week that could affect the payment service? | ||
| ``` | ||
|
|
||
| ``` | ||
| Find the Freshservice problem records related to database connectivity and summarize their root cause notes. | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use the required Markdown code-block style.
Markdownlint reports MD046 for both new fenced code blocks. Convert these blocks to the configured indented style so documentation linting passes.
Also applies to: 460-464
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 419-419: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🤖 Prompt for AI Agents
Source: Linters/SAST tools