kjannette/deClawed
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
KS Jannette
2026-07-30 18:48:47 -04:00
parent 72ec89a1c6
commit ee12a44ec1
1 changed files with 150 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
README.md
View File

@@ -2,130 +2,182 @@
<img src="assets/logo.png" alt="Declawed" width="120" /> <img src="assets/logo.png" alt="Declawed" width="120" />
</p> </p>
# Declawed: your kuddly assisty-kitty # Declawed: your kuddly assisty-kitty
Inbox brimming with stank, algorithmically-generated logs? Wanna cut the crap and get the stuff that matters into your calendars, Atlassian, Jira, Asana, G sheets (etc., etc.) ... in two clicks?
### (Cat) nip it in the bud!! Inbox brimming with stank? Wanna cut the crap and get the messaging that matters into calendars, Atlassian, Jira, Asana, Google Calendar/Sheets (etc.) ... in two clicks? (Cat) nip slop in the bud with Assisty-Kitty!!
# The "why": # The "why":
### Declawed is a configurable, prompt purrr-fectable LLM mail and task automation assisty-kitty.
### More private than other options (not purrfect *yet* - but privacy is our number one goal with every release). ### Eliminates that frustrating feeling you'll never get your paws around the dangling, catnip-stuffed mouse through haunch-high mail from list you're never signed up for or were re-sold to from ones you have, bot-generated marketing slop, and, of course, nigerians princes that need help claim their lottery jackpot.
### More accurate actions/results (read on).
### Eliminates the frustrating feeling you'll never get the dangling, catnip-stuffed mouse you've been chasing all week
"deClawed" because: no one should be beholden to one LLM api or local model. Have you seen that baddie Kimi K3?
The platform princes are rent extractors.
Open weights are heavy weight champions.
# The "how"
Because It's soooo easy.
deClawed is configurable, prompt purrr-fectable, LLM-driven mail and task automation for anyone that can cut n' paste a few CLI commands and can type in short declarative sentences.
More private than other options (not purrfect *yet* - but privacy is our number one goal with every release).
More accurate actions/results (read on).
# Privacy: more than the blue-plate crustacean # Privacy: more than the blue-plate crustacean
Your own local Model Context Protocol (MCP) server integrates with your preferred LLM API.
Each step offers greater control, configurability and transparency over permissions.
Avoid the flakey (molty?) black-box installs that are loaded with more Trojans than an Olympic Village. Silent/dark processes, data harvesting phone-homes, behavioral analytics, telemetry backdoors - the nasties lurking in the dark detritus. Your own local Model Context Protocol (MCP) server integrates with your preferred LLM API. Each step in the install, and setup offers greater control, and transparency. Permissions are 100% configurable.
Escape black-box installs stocked with more Trojans than an Olympic Village - silent/dark processes, data harvesting phone-homes, behavioral analytics, telemetry backdoors, corporate surveillance - the nasties lurking in the dark discoverable only by secops edgelords that are masters of the the CLI.
💩 You know lobsters eat poop, right? 💩
# Simplicity # Simplicity
### NLP prompts are **actually** easy and **demonstrably** more effective ### NLP prompts are **actually** easy and **demonstrably** more effective
Stop drilling down byzantine menus in mail, scheduling and workflow platforms to configure filters and actions that 1. only ever work 20% of the time 2. change in functionality and scope every two months.
Stop drilling down byzantine menus in mail, scheduling and workflow to configure filters and actions that 1. only ever work 20% of the time 2. change in functionality and scope every two months because a project manager needs to justify their salary.
Write short, declarative prompts instead. It's like wrapping busywork's paws in tinfoil and tossing it in a bathtub. Write short, declarative prompts instead. It's like wrapping busywork's paws in tinfoil and tossing it in a bathtub.
Prompts Prompts
1. Use semantic grouping, organizing by message intent, purpose, and context. 1. Use semantic grouping, organizing by message intent, purpose, and context.
2. The prompt templates in our "built in" library are evaluated using, for example, cosine similarity, ROUGE scoring and real human feedback. 2. The prompt templates in Kitty's "built in" library are evaluated using, for example, cosine similarity, ROUGE scoring and real human eval in the SDLC dev loop.
3. For example: you'll consistently keep the treasure and trash the junk when you task deClawed with reviewing forums/feeds where actionable insights are gold, but only 10% of the signal. 3. For example: you'll consistently keep the treasure and trash the junk when you task deClawed with reviewing forums/feeds where actionable insights are gold, but only 10% of the signal.
### Prompting: easily configured to cron: cleaning the litter(in)box before the stank wafts into the whole house.
### Imagine your morning inbox or summaries brimming with a fresh, spring-meadow aroma of opportunity and insight -- not last night's litter. ### Prompting: easily configured to cron: cleaning the litter(in)box before the stank wafts through the whole work house.
### Imagine your morning inbox or summaries brimming with a fresh, spring-meadow aroma of opportunity and insight -- not last night's Kitty kibble.
# -- You just might feel like it' s freakin' 1998 again. # -- You just might feel like it' s freakin' 1998 again.
# Wiring up your kitty # Wiring up your kitty
Assisty-kitty easily interfaces with mail and calendar and other app APIs (about any other service you want to plug in) ... it keeps things moving so you can go chase laser pointers or enjoy a 19-hour nap in a sunbeam. Assisty-kitty easily interfaces with mail and calendar and other app APIs (about any other service you want to plug in) ... it keeps things moving so you can go chase laser pointers or enjoy a 19-hour nap in a sunbeam.
--- ---
# Scope and Architecture # Scope and Architecture
## Current implementation requires building/using: ## Current implementation requires building/using:
-- Claude Desktop (as UI - proprietary UI coming soonish) -- Claude Desktop (as UI only - proprietary UI coming soonish)
-- Building/Connecting a Local Model Context Protocol Server -- Building/Connecting a Model API or Local Model Context Protocol Server
-- A DNS-config’d domain, with MX records pointing to: -- A DNS-config’d domain, with MX records pointing to:
-- A commercial or self-hosted SMTP Server -- A commercial or self-hosted SMTP Server
## Coming soonish: ## Coming soonish:
-- Proprietary custom UI. -- Proprietary, custom UI.
-- Support for Hugging Face models galore. -- Support for all stripes of models on HugginFFace.
- Support for wiring to local LLMs. - Support for local LLMs.
# Setup # Setup
### 1. Install Node.js (v16+ required). ### 1. Install Node.js (v16+ required).
```bash ```bash
node --version node --version
npm --version npm --version
``` ```
If not installed, grab it from [nodejs.org](https://nodejs.org/). If not installed, grab it from [nodejs.org](https://nodejs.org/).
### 2. Clone and Install ### 2. Clone and Install
```bash
git clone https://github.com/kjannette/deClawed-Assisty-Kitty.git
cd deClawed-Assity-Kitty
npm install
```
```bash
git clone https://git.sjdev.online/kjannette/deClawed-Assity-Kitty
cd deClawed-Assity-Kitty
npm i
```
### 3. Set Up Google Cloud Credentials ### 3. Set Up Google Cloud Credentials
#### 3a. Create a Google Cloud Project #### 3a. Create a Google Cloud Project
1. Go to [Google Cloud Console](https://console.cloud.google.com/) 1. Go to [Google Cloud Console](https://console.cloud.google.com/)
2. Sign in with the Google account that owns the target Gmail 2. Sign in with the Google account that owns the target Gmail
3. Click the project dropdown (top-left) > **New Project** 3. Click the project dropdown (top-left) > **New Project**
4. Name it (e.g., `assistant-mcp`) and click **Create** 4. Name it (e.g., `assistant-mcp`) and click **Create**
5. Select the new project from the dropdown 5. Select the new project from the dropdown
#### 3b. Enable APIs #### 3b. Enable APIs
In **APIs & Services > Library**, enable: In **APIs & Services > Library**, enable:
- **Gmail API** - **Gmail API**
- **Google Sheets API** (if mapping mail to sheets) - **Google Sheets API** (if mapping mail to sheets)
- **Google Calendar API** (if using calendar event creation, etc.s) - **Google Calendar API** (if using calendar event creation, etc.s)
#### 3c. Configure the OAuth Consent Screen #### 3c. Configure the OAuth Consent Screen
1. Go to **Google Auth Platform > Branding** (or **APIs & Services > OAuth consent screen**) 1. Go to **Google Auth Platform > Branding** (or **APIs & Services > OAuth consent screen**)
2. Set user type to **External**, click **Create** 2. Set user type to **External**, click **Create**
3. Fill in app name, support email, and developer contact email 3. Fill in app name, support email, and developer contact email
4. Save and continue 4. Save and continue
#### 3d. Add OAuth Scopes #### 3d. Add OAuth Scopes
In **Google Auth Platform > Data Access**, add: In **Google Auth Platform > Data Access**, add:
- `https://www.googleapis.com/auth/gmail.modify` - `https://www.googleapis.com/auth/gmail.modify`
- `https://www.googleapis.com/auth/spreadsheets` (for Sheets integration) - `https://www.googleapis.com/auth/spreadsheets` (for Sheets integration)
- `https://www.googleapis.com/auth/calendar.events` (for Calendar integration) - `https://www.googleapis.com/auth/calendar.events` (for Calendar integration)
#### 3e. Add Yourself as a Test User #### 3e. Add Yourself as a Test User
Go to **Google Auth Platform > Audience** and add each Gmail address you'll use. Go to **Google Auth Platform > Audience** and add each Gmail address you'll use.
#### 3f. Create OAuth Client Credentials #### 3f. Create OAuth Client Credentials
1. Go to **Google Auth Platform > Clients** (or **APIs & Services > Credentials**) 1. Go to **Google Auth Platform > Clients** (or **APIs & Services > Credentials**)
2. Click **Create Client** > Application type: **Desktop app** 2. Click **Create Client** > Application type: **Desktop app**
3. **Download the JSON**, rename it to `credentials.json` 3. **Download the JSON**, rename it to `credentials.json`
4. Place it in the project root 4. Place it in the project root
### 4. Configure Accounts ### 4. Configure Accounts
Create file `accounts.json` in the project root. Each key is an account alias with its own token file and optional Sheets/Calendar config: Create file `accounts.json` in the project root. Each key is an account alias with its own token file and optional Sheets/Calendar config:
```json ```json
{ {
"work": { "work": {
@@ -141,113 +193,147 @@ Create file `accounts.json` in the project root. Each key is an account alias wi
} }
``` ```
- **`label`** -- display name (typically the email address) - **`label`** -- display name (typically the email address)
- **`tokenFile`** -- per-account OAuth token (auto-generated during auth) - **`tokenFile`** -- per-account OAuth token (auto-generated during auth)
- **`spreadsheetId`** -- Google Sheets ID for recruiter contact logging (optional) - **`spreadsheetId`** -- Google Sheets ID for recruiter contact logging (optional)
- **`calendarId`** -- Google Calendar ID for event creation (optional, `"primary"` uses the default calendar) - **`calendarId`** -- Google Calendar ID for event creation (optional, `"primary"` uses the default calendar)
### 5. Authorize Gmail Accounts ### 5. Authorize Gmail Accounts
Build and run the auth script for each account: Build and run the auth script for each account:
```bash ```bash
npm run auth # authorizes the "work" account npm run auth # authorizes the "work" account
npm run auth -- secondary # authorizes the "secondary" account npm run auth -- secondary # authorizes the "secondary" account
``` ```
Each run will:
Each run required steps:
1. Print a URL -- open it in your browser 1. Print a URL -- open it in your browser
2. Sign in and click **Allow** 2. Sign in and click **Allow**
3. You'll land on a "localhost refused to connect" page (normal) 3. You'll land on a "localhost refused to connect" page (normal)
4. Copy the **entire URL** from the address bar and paste it back into the terminal 4. Copy the **entire URL** from the address bar and paste it back into the terminal
5. The script saves the token file (e.g., `token.json` or `token-secondary.json`) 5. The script saves the token file (e.g., `token.json` or `token-secondary.json`)
You only need to do this once per account. Tokens auto-refresh. You only need to do this once per account. Tokens auto-refresh.
### 6. Write the Prompts ### 6. Write the Prompts
Two plain-text prompt files in `src/prompts/` control the workflow: Two plain-text prompt files in `src/prompts/` control the workflow:
| File | Phase | Purpose | | File | Phase | Purpose |
|------|-------|---------| |------|-------|---------|
| `src/prompts/classify-emails.txt` | 1 -- Classification | Defines categories A/B/C/D and how to sort emails | | `src/prompts/classify-emails.txt` | 1 -- Classification | Defines categories A/B/C/D and how to sort emails |
| `src/prompts/take-action-on-emails.txt` | 2 -- Action | Tells the LLM what to do with each category (delete, log, schedule, etc.) | | `src/prompts/take-action-on-emails.txt` | 2 -- Action | Tell the LLM what to do with each category (delete, log, schedule, etc.) |
**Tips:** **Tips:**
- Use clear, explicit category definitions with example language - Use clear, explicit category definitions with example language
- Handle ambiguous cases (e.g., "If an email both acknowledges receipt AND requests action, classify as B") - Handle ambiguous cases (e.g., "If an email both acknowledges receipt AND requests action, classify as B")
- Prompt files are loaded at runtime -- edit them anytime, no rebuild required - Prompt files are loaded at runtime -- edit them anytime, no rebuild required
### 7. Build ### 7. Build
```bash ```bash
npm run build npm run build
``` ```
Compiles `src/**/*.ts` into `build/`. Compiles `src/**/*.ts` into `build/`.
## 8. Configure Claude Desktop ## 8. Configure Claude Desktop
Edit your Claude Desktop config: Edit your Claude Desktop config:
```bash ```bash
code ~/Library/Application\ Support/Claude/claude_desktop_config.json code ~/Library/Application\ Support/Claude/claude_desktop_config.json
``` ```
Add the server: Add the server:
```json ```json
{ {
"mcpServers": { "mcpServers": {
"assistant": { "assistant": {
"command": "/ABSOLUTE/PATH/TO/node", "command": "/ABSOLUTE/PATH/TO/node",
"args": [ "args": [
"/ABSOLUTE/PATH/TO/deClawed-Assity-Kitty/build/index.js" "/ABSOLUTE/PATH/TO/deClawed-Assity-Kitty/build/index.js"
] ]
} }
} }
} }
``` ```
Replace paths with the output of `which node` and your actual project location. Replace paths with the output of `which node` and your actual project location.
## 9. Add/Configure API Keys, Credentials, and Other Secrets ## 9. Add/Configure API Keys, Credentials, and Other Secrets
Secret files are **gitignored** -- they never leave your machine. Example templates are provided so you know what shape each file needs to be in. Secret files are **gitignored** -- they never leave your machine. Example templates are provided so you know what shape each file needs to be in.
#### 9a. `credentials.json` #### 9a. `credentials.json`
This file holds your Google OAuth client credentials. **You do not write this by hand** -- it is downloaded from the Google Cloud Console (see Step 3f above). Copy the example and then replace it with the real download: This file holds your Google OAuth client credentials. **You do not write this by hand** -- it is downloaded from the Google Cloud Console (see Step 3f above). Copy the example and then replace it with the real download:
```bash ```bash
cp credentials.example.json credentials.json cp credentials.example.json credentials.json
# Now replace credentials.json with the file downloaded from Google Cloud Console. # Now replace credentials.json with the file downloaded from Google Cloud Console.
``` ```
The structure looks like this (the example file ships with empty values): The structure looks like this (the example file ships with empty values):
```json ```json
{ {
"installed": { "installed": {
"client_id": "", "client_id": "",
"project_id": "", "project_id": "",
"auth_uri": "https://accounts.google.com/o/oauth2/auth", "auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token", "token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_secret": "", "client_secret": "",
"redirect_uris": ["http://localhost"] "redirect_uris": ["http://localhost"]
} }
} }
``` ```
#### 9b. `accounts.json` #### 9b. `accounts.json`
Defines each Gmail account the server manages. Copy the example and fill in your values: Defines each Gmail account the server manages. Copy the example and fill in your values:
```bash ```bash
cp accounts.example.json accounts.json cp accounts.example.json accounts.json
``` ```
| Field | What to put here | | Field | What to put here |
|-------|-----------------| |-------|-----------------|
| `label` | The email address for this account (display only) | | `label` | The email address for this account (display only) |
@@ -255,28 +341,38 @@ cp accounts.example.json accounts.json
| `spreadsheetId` | The ID from your Google Sheet URL: `docs.google.com/spreadsheets/d/<THIS_PART>/edit` (optional) | | `spreadsheetId` | The ID from your Google Sheet URL: `docs.google.com/spreadsheets/d/<THIS_PART>/edit` (optional) |
| `calendarId` | `"primary"` for your default calendar, or a specific calendar ID (optional) | | `calendarId` | `"primary"` for your default calendar, or a specific calendar ID (optional) |
Add as many accounts as you need. Each key (e.g., `"work"`, `"secondary"`) becomes the account name used in tool calls and auth commands. Add as many accounts as you need. Each key (e.g., `"work"`, `"secondary"`) becomes the account name used in tool calls and auth commands.
#### 9c. `token*.json` (auto-generated) #### 9c. `token*.json` (auto-generated)
Token files are **created automatically** when you run `npm run auth` (Step 5). You do not need to create or edit them manually. A `token.example.json` is provided for reference only -- it shows the structure but the values are populated by the OAuth flow. Token files are **created automatically** when you run `npm run auth` (Step 5). You do not need to create or edit them manually. A `token.example.json` is provided for reference only -- it shows the structure but the values are populated by the OAuth flow.
#### Summary of secret files #### Summary of secret files
| Example template | Actual file (gitignored) | How to create | | Example template | Actual file (gitignored) | How to create |
|-----------------|--------------------------|---------------| |-----------------|--------------------------|---------------|
| `credentials.example.json` | `credentials.json` | Download from Google Cloud Console | | `credentials.example.json` | `credentials.json` | Download from Google Cloud Console |
| `accounts.example.json` | `accounts.json` | Copy example, fill in your email/sheet/calendar IDs | | `accounts.example.json` | `accounts.json` | Copy example, fill in your email/sheet/calendar IDs |
| `token.example.json` | `token.json`, `token-secondary.json`, etc. | Auto-generated by `npm run auth` | | `token.example.json` | `token.json`, `token-secondary.json`, etc. | Auto-generated by `npm run auth` |
### 10. Restart Claude Desktop ### 10. Restart Claude Desktop
Fully quit (**Cmd+Q**, not just close the window) and reopen. The `assistant` server should appear under **Connectors**. Fully quit (**Cmd+Q**, not just close the window) and reopen. The `assistant` server should appear under **Connectors**.
--- ---
## MCP Tools ## MCP Tools
| Tool | Description | | Tool | Description |
|------|-------------| |------|-------------|
| `fetch_new_emails` | Fetches unread emails for a given account. Classification and action prompts are automatically appended to the response. | | `fetch_new_emails` | Fetches unread emails for a given account. Classification and action prompts are automatically appended to the response. |
@@ -285,24 +381,32 @@ Fully quit (**Cmd+Q**, not just close the window) and reopen. The `assistant` se
| `log_contact` | Logs or updates contact info in a Google Sheet. Merges rows by email + role. | | `log_contact` | Logs or updates contact info in a Google Sheet. Merges rows by email + role. |
| `create_calendar_event` | Creates a Google Calendar event for scheduled calls/meetings. Includes meeting links, attendees and their contact info. | | `create_calendar_event` | Creates a Google Calendar event for scheduled calls/meetings. Includes meeting links, attendees and their contact info. |
## MCP Prompts (built in as of now-ish - add your own) ## MCP Prompts (built in as of now-ish - add your own)
### BETTER YET - DO A PR OR FORK ### BETTER YET - DO A PR OR FORK
| Prompt | Account | Description | | Prompt | Account | Description |
|--------|---------|-------------| |--------|---------|-------------|
| `review_emails` | work | Loads the classification + action prompts for the work inbox | | `review_emails` | work | Loads the classification + action prompts for the work inbox |
| `review_secondary_emails` | secondary | Same workflow, but for a second email account inbox | | `review_secondary_emails` | secondary | Same workflow, but for a second email account inbox |
Invoke these from Claude Desktop's Connectors menu, or just type "Review my inbox" / "Review my secondary inbox." Invoke these from Claude Desktop's Connectors menu, or just type "Review my inbox" / "Review my secondary inbox."
--- ---
## Two-Phase Workflow ## Two-Phase Workflow
**Phase 1 -- Classify** **Phase 1 -- Classify**
The LLM calls `fetch_new_emails`, which returns email data with the classification instructions from `classify-emails.txt` appended. Each email is sorted into: The LLM calls `fetch_new_emails`, which returns email data with the classification instructions from `classify-emails.txt` appended. Each email is sorted into:
| Category | Meaning | Action | | Category | Meaning | Action |
|----------|---------|--------| |----------|---------|--------|
| **A** | Acknowledgement / auto-reply | Delete | | **A** | Acknowledgement / auto-reply | Delete |
@@ -310,18 +414,23 @@ The LLM calls `fetch_new_emails`, which returns email data with the classificati
| **C** | Rejection | Delete | | **C** | Rejection | Delete |
| **D** | Other / uncategorized | Summarize + log | | **D** | Other / uncategorized | Summarize + log |
**Phase 2 -- Act** **Phase 2 -- Act**
Using `take-action-on-emails.txt`, the LLM: Using `take-action-on-emails.txt`, the LLM:
- Calls `delete_emails` for A + C - Calls `delete_emails` for A + C
- Calls `append_to_summary` for B + D - Calls `append_to_summary` for B + D
- Calls `log_recruiter_contact` to track contacts in Sheets (if configured) - Calls `log_recruiter_contact` to track contacts in Sheets (if configured)
- Calls `create_calendar_event` for any scheduled interviews/calls (if configured) - Calls `create_calendar_event` for any scheduled interviews/calls (if configured)
--- ---
## Key Commands ## Key Commands
| Command | Purpose | | Command | Purpose |
|---------|---------| |---------|---------|
| `npm run build` | Recompile after editing source files | | `npm run build` | Recompile after editing source files |
@@ -330,10 +439,13 @@ Using `take-action-on-emails.txt`, the LLM:
| `npm test` | Run the test suite | | `npm test` | Run the test suite |
| `npm run test:watch` | Run tests in watch mode | | `npm run test:watch` | Run tests in watch mode |
--- ---
## Project Structure ## Project Structure
``` ```
deClawed-Assity-Kitty/ deClawed-Assity-Kitty/
├── src/ ├── src/
@@ -375,4 +487,4 @@ deClawed-Assity-Kitty/
├── vitest.config.ts ├── vitest.config.ts
├── .gitignore ├── .gitignore
└── README.md └── README.md
``` ```