52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
|
# freshservice-claude
|
||
|
|
|
||
|
|
A [Claude](https://claude.com/claude-code) **skill** for working with
|
||
|
|
[Freshservice](https://www.freshservice.com/) ITSM from chat / Cowork — view,
|
||
|
|
create, update, reply to, and triage tickets; look up and update assets/CMDB;
|
||
|
|
find agents, requesters, groups, and departments; and manage changes, problems,
|
||
|
|
and releases via the Freshservice REST API v2.
|
||
|
|
|
||
|
|
## Layout
|
||
|
|
|
||
|
|
| File | Purpose |
|
||
|
|
|------|---------|
|
||
|
|
| `SKILL.md` | Skill entry point — setup, common commands, guardrails |
|
||
|
|
| `reference.md` | Endpoints, status/priority codes, filter-query syntax |
|
||
|
|
| `scripts/fs.py` | Stdlib-only API helper (auth, URL building, paging, errors) |
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Copy the skill into your Claude skills directory:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cp -R . ~/.claude/skills/freshservice
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configure credentials
|
||
|
|
|
||
|
|
```bash
|
||
|
|
mkdir -p ~/.freshservice
|
||
|
|
cat > ~/.freshservice/credentials <<'EOF'
|
||
|
|
FRESHSERVICE_DOMAIN=yourcompany
|
||
|
|
FRESHSERVICE_API_KEY=your_api_key
|
||
|
|
EOF
|
||
|
|
chmod 600 ~/.freshservice/credentials
|
||
|
|
|
||
|
|
python3 ~/.claude/skills/freshservice/scripts/fs.py check
|
||
|
|
```
|
||
|
|
|
||
|
|
The API key is in Freshservice → profile picture → *Profile settings* → API key.
|
||
|
|
`FRESHSERVICE_DOMAIN` accepts the subdomain (`yourcompany`) or the full host.
|
||
|
|
Environment variables of the same name override the file.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
The skill activates when you mention Freshservice or a ticket/asset/change in
|
||
|
|
chat. Under the hood it calls:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
python3 scripts/fs.py request <METHOD> <PATH> [--param KEY=VALUE ...] [--data '<JSON>']
|
||
|
|
```
|
||
|
|
|
||
|
|
See `SKILL.md` and `reference.md` for details.
|