@simpleapps-com/augur-skills 0.0.2 → 0.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/skills/simpleapps/augur-api/SKILL.md +51 -0
- package/skills/simpleapps/fyxer/SKILL.md +94 -0
- package/skills/simpleapps/fyxer/basecamp-index.md +110 -0
- package/skills/simpleapps/fyxer/basecamp.md +91 -0
- package/skills/simpleapps/github/SKILL.md +45 -0
- package/skills/simpleapps/github/issues-prs.md +89 -0
- package/skills/simpleapps/github/project-structure.md +142 -0
- package/skills/simpleapps/github/wiki-as-context.md +162 -0
- package/skills/simpleapps/workflow/SKILL.md +3 -1
- package/skills/simpleapps/workflow/basecamp.md +82 -8
- package/skills/simpleapps/workflow/github.md +9 -21
package/package.json
CHANGED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: augur-api
|
|
3
|
+
description: Augur API integration via MCP. Covers service discovery, CRUD operations across all 27 Augur microservices, and credential resolution. Use when querying or modifying Augur data (contacts, transactions, inventory, etc.).
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Augur API
|
|
7
|
+
|
|
8
|
+
MCP server exposing all 27 Augur microservices through 6 generic tools.
|
|
9
|
+
|
|
10
|
+
## Tools
|
|
11
|
+
|
|
12
|
+
| Tool | Purpose |
|
|
13
|
+
|------|---------|
|
|
14
|
+
| `augur_discover` | List services or endpoints for a service |
|
|
15
|
+
| `augur_list` | List records (GET collection) |
|
|
16
|
+
| `augur_get` | Get single record by ID |
|
|
17
|
+
| `augur_create` | Create record (POST) |
|
|
18
|
+
| `augur_update` | Update record (PUT) |
|
|
19
|
+
| `augur_delete` | Delete record (DELETE) |
|
|
20
|
+
|
|
21
|
+
## Usage Pattern
|
|
22
|
+
|
|
23
|
+
Always start with discovery:
|
|
24
|
+
|
|
25
|
+
1. `augur_discover()` — lists all available services
|
|
26
|
+
2. `augur_discover(service="<name>")` — lists endpoints for a specific service
|
|
27
|
+
3. Use `augur_list`, `augur_get`, `augur_create`, `augur_update`, `augur_delete` for CRUD
|
|
28
|
+
|
|
29
|
+
Do NOT hardcode service names or endpoints. Use `augur_discover` to find them at runtime.
|
|
30
|
+
|
|
31
|
+
## Authentication
|
|
32
|
+
|
|
33
|
+
Credentials resolve automatically — no setup needed if running from a project directory with a `protected/` folder containing credentials.
|
|
34
|
+
|
|
35
|
+
Resolution order (first match wins):
|
|
36
|
+
|
|
37
|
+
1. **Env vars** — `AUGUR_TOKEN` + `AUGUR_SITE_ID`
|
|
38
|
+
2. **Explicit file** — `AUGUR_CREDS_FILE` env var pointing to a JSON file
|
|
39
|
+
3. **Ancestor walk** — walks up from cwd looking for `protected/*.json`
|
|
40
|
+
4. **Default file** — `~/.simpleapps/augur-api.json`
|
|
41
|
+
|
|
42
|
+
Credentials file format: `{"siteId": "...", "jwt": "..."}`
|
|
43
|
+
|
|
44
|
+
The ancestor walk means client project directories with `protected/<client>.json` just work.
|
|
45
|
+
|
|
46
|
+
## When Auth Fails
|
|
47
|
+
|
|
48
|
+
If tools return authentication errors:
|
|
49
|
+
- Check for `protected/*.json` in the project directory or any ancestor
|
|
50
|
+
- Verify the file contains valid `siteId` and `jwt` keys
|
|
51
|
+
- Fallback: set `AUGUR_TOKEN` and `AUGUR_SITE_ID` env vars
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: fyxer
|
|
3
|
+
description: Fyxer AI meeting recording integration. Covers extraction, local caching, and posting to downstream services. Use when processing Fyxer recordings or meeting transcripts.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Fyxer
|
|
7
|
+
|
|
8
|
+
Fyxer AI records and summarizes meetings. This skill covers extracting data from Fyxer and routing it to other services.
|
|
9
|
+
|
|
10
|
+
## Fyxer URLs
|
|
11
|
+
|
|
12
|
+
Recording page: `https://app.fyxer.com/call-recordings/<meeting-uuid>:<calendar-event-id>`
|
|
13
|
+
|
|
14
|
+
The URL path after `/call-recordings/` contains two parts separated by a colon:
|
|
15
|
+
- **Meeting UUID** (before colon): `52f0cf2b-fdb8-4e95-8b01-2afb6d367c69`
|
|
16
|
+
- **Calendar event ID** (after colon): `2fg5k3v3hffl91dnuqauc15suk_20260119T190000Z`
|
|
17
|
+
|
|
18
|
+
Use only the **meeting UUID** for cache folders, duplicate checks, and frontmatter.
|
|
19
|
+
|
|
20
|
+
Each recording has two tabs:
|
|
21
|
+
- **Summary** — AI-generated summary with section headings, participants, action items. Has "Copy summary" and "Download PDF" buttons.
|
|
22
|
+
- **Transcript** — Speaker-attributed, timestamped full transcript. Has "Copy transcript" and "Download transcript" buttons.
|
|
23
|
+
|
|
24
|
+
## Local Cache
|
|
25
|
+
|
|
26
|
+
All extracted data is cached at `~/.simpleapps/fyxer/<meeting-uuid>/`:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
summary.txt - raw Fyxer summary (from Summary tab)
|
|
30
|
+
transcript.txt - raw Fyxer transcript (from Transcript tab)
|
|
31
|
+
message.txt - assembled output (generated by downstream processes, e.g. basecamp.md)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Cache is populated via Chrome extraction (see below) and reused across processes.
|
|
35
|
+
|
|
36
|
+
## Chrome Extraction
|
|
37
|
+
|
|
38
|
+
Only needed when local cache files are missing.
|
|
39
|
+
|
|
40
|
+
### Extract transcript
|
|
41
|
+
|
|
42
|
+
Click the **Transcript** tab. Extraction methods (in order of preference):
|
|
43
|
+
|
|
44
|
+
1. **"Download transcript" button** (BEST) — Downloads a `.txt` file to `~/Downloads/`. Complete content, no truncation. Copy to cache dir, then delete the download.
|
|
45
|
+
2. **"Copy transcript" button** + `pbpaste` — Copies to system clipboard. Write to disk: `pbpaste > transcript.txt`. Reliable but requires clipboard access.
|
|
46
|
+
3. **`get_page_text`** — UNRELIABLE. Only captures visible/partial content. Missed most of a 30-minute transcript in testing. DO NOT USE for transcripts.
|
|
47
|
+
|
|
48
|
+
Save to `~/.simpleapps/fyxer/<meeting-uuid>/transcript.txt`.
|
|
49
|
+
|
|
50
|
+
### Extract summary
|
|
51
|
+
|
|
52
|
+
The Summary tab is the default view. Extraction methods (in order of preference):
|
|
53
|
+
|
|
54
|
+
1. **"Copy summary" button** + `pbpaste` (BEST) — Copies markdown to clipboard. Write to disk: `pbpaste > summary.txt`. Summaries are short (~1,700 chars) so this works well.
|
|
55
|
+
2. **`get_page_text`** — Works for short summaries but mixes in page chrome. Not recommended.
|
|
56
|
+
|
|
57
|
+
Save to `~/.simpleapps/fyxer/<meeting-uuid>/summary.txt`.
|
|
58
|
+
|
|
59
|
+
### Extract participants
|
|
60
|
+
|
|
61
|
+
Click the **participant count dropdown** (e.g. "3 participants") in the page header to reveal attendee names and emails. Take a screenshot to read them.
|
|
62
|
+
|
|
63
|
+
### Clipboard verification
|
|
64
|
+
|
|
65
|
+
To verify clipboard content is complete before writing to disk:
|
|
66
|
+
|
|
67
|
+
```javascript
|
|
68
|
+
(async () => {
|
|
69
|
+
const text = await navigator.clipboard.readText();
|
|
70
|
+
window.__temp = text;
|
|
71
|
+
return JSON.stringify({
|
|
72
|
+
length: text.length,
|
|
73
|
+
first50: text.substring(0, 50),
|
|
74
|
+
last100: text.substring(text.length - 100)
|
|
75
|
+
});
|
|
76
|
+
})()
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Then write and verify: `pbpaste > target.txt && wc -c target.txt`
|
|
80
|
+
|
|
81
|
+
**Note**: Do NOT try to read full clipboard content via JS — Chrome MCP truncates JS output at ~1,000 characters. Always use `pbpaste` to write to disk.
|
|
82
|
+
|
|
83
|
+
### Download cleanup
|
|
84
|
+
|
|
85
|
+
MUST clean up `~/Downloads/` after copying downloaded files to the cache directory. Fyxer names downloads like `transcript-SA_USCCO.txt`. Repeated downloads append `(1)`, `(2)`, etc.
|
|
86
|
+
|
|
87
|
+
## Processes
|
|
88
|
+
|
|
89
|
+
- See `basecamp.md` for posting meeting transcripts as Basecamp Discussions
|
|
90
|
+
- See `basecamp-index.md` for the Fyxer Index document (duplicate detection, reconciliation)
|
|
91
|
+
|
|
92
|
+
## Dependencies
|
|
93
|
+
|
|
94
|
+
- Chrome browser automation (for extraction when cache is empty)
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Fyxer Index — Basecamp Document
|
|
2
|
+
|
|
3
|
+
Each Basecamp project that receives Fyxer meeting transcripts MUST have a **Fyxer Index** document. This document serves as a fast lookup for duplicate detection and meeting history, accessible to all team members.
|
|
4
|
+
|
|
5
|
+
## Document Format
|
|
6
|
+
|
|
7
|
+
- **Title**: `Fyxer Index`
|
|
8
|
+
- **Location**: Documents section of each Basecamp project
|
|
9
|
+
- **Content**: One line per posted meeting, newest first
|
|
10
|
+
|
|
11
|
+
Each line follows this format:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
<meeting-uuid> | <date> | <message-id> | <subject>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Example:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
52f0cf2b-fdb8-4e95-8b01-2afb6d367c69 | 2026-01-19 | 514789012 | Fyxer: 2026-01-19
|
|
21
|
+
a1b2c3d4-e5f6-7890-abcd-ef1234567890 | 2026-02-10 | 514801234 | Fyxer: 2026-02-10
|
|
22
|
+
d9e8f7a6-b5c4-3210-fedc-ba0987654321 | 2026-02-15 | 514823456 | Fyxer: 2026-02-15
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Fields:
|
|
26
|
+
|
|
27
|
+
| Field | Source |
|
|
28
|
+
|-------|--------|
|
|
29
|
+
| meeting-uuid | UUID from Fyxer URL (before the colon) |
|
|
30
|
+
| date | Meeting date (YYYY-MM-DD) |
|
|
31
|
+
| message-id | Basecamp message ID returned by `create_message` |
|
|
32
|
+
| subject | Message subject as posted (e.g., `Fyxer: 2026-02-15`) |
|
|
33
|
+
|
|
34
|
+
## Finding the Index
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
list_documents(project_id)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Scan for a document titled `Fyxer Index`. Use `get_document(project_id, document_id)` to read its contents.
|
|
41
|
+
|
|
42
|
+
## Creating the Index
|
|
43
|
+
|
|
44
|
+
If no `Fyxer Index` document exists in the project, create one before posting the first meeting:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
create_document(project_id, "Fyxer Index", "")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
This creates an empty document. The first meeting entry will be appended after posting.
|
|
51
|
+
|
|
52
|
+
## Updating the Index
|
|
53
|
+
|
|
54
|
+
After successfully posting a meeting transcript via `create_message`, append a new line to the index:
|
|
55
|
+
|
|
56
|
+
1. Read the current index: `get_document(project_id, document_id)`
|
|
57
|
+
2. Append the new entry to the content (newest first — add to the top)
|
|
58
|
+
3. Update: `update_document(project_id, document_id, title="Fyxer Index", content=updated_content)`
|
|
59
|
+
|
|
60
|
+
The `create_message` response includes the message ID needed for the index entry.
|
|
61
|
+
|
|
62
|
+
## Duplicate Check
|
|
63
|
+
|
|
64
|
+
Before posting a meeting transcript, check the index:
|
|
65
|
+
|
|
66
|
+
1. Find the Fyxer Index document: `list_documents(project_id)` → scan for `Fyxer Index`
|
|
67
|
+
2. Read it: `get_document(project_id, document_id)`
|
|
68
|
+
3. Search the content for the meeting UUID
|
|
69
|
+
4. If found → the meeting has already been posted. Inform the user and stop.
|
|
70
|
+
5. If not found → safe to proceed with posting.
|
|
71
|
+
|
|
72
|
+
If no Fyxer Index document exists, there are no posted meetings in this project. Proceed with posting and create the index.
|
|
73
|
+
|
|
74
|
+
## Reconciliation — Missing Entries
|
|
75
|
+
|
|
76
|
+
The index MAY fall out of sync if a meeting was posted without updating the index (e.g., manual posting, index creation after existing meetings). To reconcile:
|
|
77
|
+
|
|
78
|
+
1. List all messages: `list_messages(project_id)`
|
|
79
|
+
2. Filter for messages with `Fyxer:` in the title
|
|
80
|
+
3. For each Fyxer message, call `get_message(project_id, message_id)` and extract the `fyxer-id` from the YAML frontmatter
|
|
81
|
+
4. Compare against the index — add any missing entries
|
|
82
|
+
5. Update the index document with the complete list
|
|
83
|
+
|
|
84
|
+
Run reconciliation when:
|
|
85
|
+
- The Fyxer Index document is first created in a project that already has Fyxer messages
|
|
86
|
+
- The user suspects the index is incomplete
|
|
87
|
+
- A duplicate check finds nothing but the user believes a meeting was already posted
|
|
88
|
+
|
|
89
|
+
## Reconciliation — Orphaned Entries
|
|
90
|
+
|
|
91
|
+
If an index entry references a message that no longer exists (deleted in Basecamp):
|
|
92
|
+
|
|
93
|
+
1. Attempt `get_message(project_id, message_id)` for the entry
|
|
94
|
+
2. If 404 → the message was deleted. Remove the entry from the index.
|
|
95
|
+
3. Update the index document
|
|
96
|
+
|
|
97
|
+
Only run orphan cleanup when explicitly requested by the user. Do not automatically delete index entries.
|
|
98
|
+
|
|
99
|
+
## Updated Posting Process
|
|
100
|
+
|
|
101
|
+
The full Fyxer → Basecamp posting process (see `basecamp.md`) now includes index management:
|
|
102
|
+
|
|
103
|
+
1. **Check index** — find Fyxer Index doc, read it, search for meeting UUID
|
|
104
|
+
2. **Check local cache** — if summary.txt and transcript.txt exist, skip extraction
|
|
105
|
+
3. **Extract from Chrome** — if cache is missing (see `SKILL.md`)
|
|
106
|
+
4. **Build message.txt** — frontmatter + transcript
|
|
107
|
+
5. **Post to Basecamp** — `create_message` → capture message_id from response
|
|
108
|
+
6. **Update index** — append new entry to Fyxer Index document (create doc if needed)
|
|
109
|
+
|
|
110
|
+
Step 6 is new. If the index update fails after a successful post, warn the user — the message is posted but the index is stale. The user can run reconciliation later to fix it.
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Fyxer → Basecamp
|
|
2
|
+
|
|
3
|
+
Post Fyxer meeting recordings as searchable Discussions in Basecamp projects.
|
|
4
|
+
|
|
5
|
+
## Inputs
|
|
6
|
+
|
|
7
|
+
- **Fyxer recording URL**: `https://app.fyxer.com/call-recordings/<meeting-uuid>:<calendar-event-id>`
|
|
8
|
+
- **Basecamp project ID**: Target project for the Discussion
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
### 1. Check for duplicate
|
|
13
|
+
|
|
14
|
+
Extract the meeting UUID from the Fyxer URL (the part before the colon).
|
|
15
|
+
|
|
16
|
+
Find the **Fyxer Index** document in the project: `list_documents(project_id)` → scan for title `Fyxer Index`. If found, `get_document(project_id, document_id)` and search the content for the meeting UUID. If the UUID appears, the meeting has already been posted — inform the user and stop.
|
|
17
|
+
|
|
18
|
+
If no Fyxer Index document exists, there are no tracked meetings in this project. Proceed with posting.
|
|
19
|
+
|
|
20
|
+
See `basecamp-index.md` for full index format and reconciliation.
|
|
21
|
+
|
|
22
|
+
### 2. Check local cache
|
|
23
|
+
|
|
24
|
+
If `~/.simpleapps/fyxer/<meeting-uuid>/summary.txt` and `transcript.txt` both exist, skip to step 3. Otherwise, follow the Chrome extraction steps in `SKILL.md`.
|
|
25
|
+
|
|
26
|
+
### 3. Build message.txt
|
|
27
|
+
|
|
28
|
+
Parse `summary.txt` for frontmatter fields, extract participants (see `SKILL.md` participant extraction), and combine with the full transcript from `transcript.txt`:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
---
|
|
32
|
+
meeting: SA/ClientName
|
|
33
|
+
date: YYYY-MM-DD
|
|
34
|
+
time: HH:MM-HH:MM
|
|
35
|
+
participants: Person A, Person B, Person C
|
|
36
|
+
topics: Topic One, Topic Two, Topic Three
|
|
37
|
+
fyxer-id: <meeting-uuid>
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
[contents of transcript.txt]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Frontmatter field sources:
|
|
44
|
+
|
|
45
|
+
| Field | Source |
|
|
46
|
+
|-------|--------|
|
|
47
|
+
| meeting | Meeting title from the page header |
|
|
48
|
+
| date | Recording date |
|
|
49
|
+
| time | Recording time range |
|
|
50
|
+
| participants | Participant dropdown (click to reveal names) |
|
|
51
|
+
| topics | Section headings from the Summary |
|
|
52
|
+
| fyxer-id | Meeting UUID from the URL (before the colon) |
|
|
53
|
+
|
|
54
|
+
Save as `~/.simpleapps/fyxer/<meeting-uuid>/message.txt`.
|
|
55
|
+
|
|
56
|
+
### 4. Post to Basecamp
|
|
57
|
+
|
|
58
|
+
Use `create_message(project_id, subject, content)`:
|
|
59
|
+
|
|
60
|
+
- **Subject**: `Fyxer: YYYY-MM-DD`
|
|
61
|
+
- **Content**: contents of `message.txt`
|
|
62
|
+
|
|
63
|
+
Capture the **message_id** from the response.
|
|
64
|
+
|
|
65
|
+
### 5. Update Fyxer Index
|
|
66
|
+
|
|
67
|
+
After a successful post, update the Fyxer Index document:
|
|
68
|
+
|
|
69
|
+
1. If no Fyxer Index document exists, create one: `create_document(project_id, "Fyxer Index", "")`
|
|
70
|
+
2. Read current content: `get_document(project_id, document_id)`
|
|
71
|
+
3. Prepend a new line (newest first): `<meeting-uuid> | <date> | <message-id> | <subject>`
|
|
72
|
+
4. Update: `update_document(project_id, document_id, title="Fyxer Index", content=updated_content)`
|
|
73
|
+
|
|
74
|
+
If the index update fails after a successful post, warn the user. The message is posted but the index is stale. Run reconciliation later (see `basecamp-index.md`).
|
|
75
|
+
|
|
76
|
+
## Format Rules
|
|
77
|
+
|
|
78
|
+
- **Plain text only** — Basecamp prefers plain text over HTML
|
|
79
|
+
- **YAML frontmatter** — machine-parseable so other Claude Code instances can search and parse meeting context
|
|
80
|
+
- **Transcript only in body** — summary and action items belong on relevant Basecamp todos, not in this message
|
|
81
|
+
- **Consistent title** — `Fyxer: YYYY-MM-DD` keeps messages uniform and sortable
|
|
82
|
+
|
|
83
|
+
## Finding Posted Transcripts
|
|
84
|
+
|
|
85
|
+
Check the index: `list_documents(project_id)` → find `Fyxer Index` → `get_document`
|
|
86
|
+
View a specific transcript: `get_message(project_id, message_id)` using the message_id from the index
|
|
87
|
+
Browse all messages: `list_messages(project_id)` — Fyxer posts use the title format `Fyxer: YYYY-MM-DD`
|
|
88
|
+
|
|
89
|
+
## Dependencies
|
|
90
|
+
|
|
91
|
+
- Basecamp MCP (`create_message`, `create_document`, `update_document`, `list_documents`, `get_document` tools) — see `simpleapps:workflow` skill (`basecamp.md`) for full MCP tool reference
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: github
|
|
3
|
+
description: GitHub conventions for SimpleApps. Covers org structure, local project layout, wiki-as-docs workflow, issue creation, PR workflows, and gh CLI usage. Use when creating issues, PRs, setting up repos, or working with GitHub wikis.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# GitHub
|
|
7
|
+
|
|
8
|
+
## Organization
|
|
9
|
+
|
|
10
|
+
All SimpleApps repos live under the **`simpleapps-com`** GitHub org.
|
|
11
|
+
|
|
12
|
+
Repository pattern: `simpleapps-com/<repo-name>`
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
Use the `gh` CLI for all GitHub operations:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
gh auth status # Check auth status
|
|
20
|
+
gh auth setup-git # Configure gh as git credential helper
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
If `git push` fails with 401/403, run `gh auth setup-git` to fix credentials.
|
|
24
|
+
|
|
25
|
+
## Key Topics
|
|
26
|
+
|
|
27
|
+
- **Wiki as context** — See `wiki-as-context.md` for why the wiki is the source of truth and how to write for both humans and AI agents.
|
|
28
|
+
- **Project structure** — See `project-structure.md` for the `{project}/[repo|wiki]` layout, what goes where, and wiki conventions.
|
|
29
|
+
- **Issues & pull requests** — See `issues-prs.md` for issue templates, PR commands, and cross-linking with Basecamp.
|
|
30
|
+
|
|
31
|
+
## Quick Reference
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# Pushing
|
|
35
|
+
gh auth setup-git && git push origin <branch>
|
|
36
|
+
git push origin <tag>
|
|
37
|
+
|
|
38
|
+
# Issues
|
|
39
|
+
gh issue create --repo simpleapps-com/<repo> --title "type: desc" --body "..."
|
|
40
|
+
gh issue list --repo simpleapps-com/<repo>
|
|
41
|
+
|
|
42
|
+
# PRs
|
|
43
|
+
gh pr create --repo simpleapps-com/<repo> --title "title" --body "..."
|
|
44
|
+
gh pr list --repo simpleapps-com/<repo>
|
|
45
|
+
```
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Issues & Pull Requests
|
|
2
|
+
|
|
3
|
+
## Issues
|
|
4
|
+
|
|
5
|
+
### Creating Issues
|
|
6
|
+
|
|
7
|
+
MUST always use `--repo simpleapps-com/<repo>` to target the correct org. MUST ask the user which repo to create the issue in — never assume.
|
|
8
|
+
|
|
9
|
+
### Issue Title
|
|
10
|
+
|
|
11
|
+
- Use conventional commit style: `fix: description`, `feat: description`, `chore: description`
|
|
12
|
+
- SHOULD be a technical description, not the client's words
|
|
13
|
+
- Keep under 70 characters
|
|
14
|
+
|
|
15
|
+
### Issue Body
|
|
16
|
+
|
|
17
|
+
Every issue MUST include these sections:
|
|
18
|
+
|
|
19
|
+
```markdown
|
|
20
|
+
## Problem
|
|
21
|
+
What is broken, missing, or needed? Include error messages, URLs, or screenshots if relevant.
|
|
22
|
+
|
|
23
|
+
## Expected Behavior
|
|
24
|
+
What SHOULD happen instead? Be specific.
|
|
25
|
+
|
|
26
|
+
## Acceptance Criteria
|
|
27
|
+
- [ ] Concrete, testable criteria
|
|
28
|
+
- [ ] Each item is independently verifiable
|
|
29
|
+
|
|
30
|
+
## Context
|
|
31
|
+
Any additional info: related issues, affected files, workarounds, reproduction steps.
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
For bug reports, also include:
|
|
35
|
+
- **Steps to Reproduce** — numbered steps to trigger the bug
|
|
36
|
+
- **Current Behavior** — what actually happens (with error messages)
|
|
37
|
+
|
|
38
|
+
### Labels
|
|
39
|
+
|
|
40
|
+
Use labels to categorize: `bug`, `feature`, `enhancement`
|
|
41
|
+
|
|
42
|
+
### Example
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
gh issue create --repo simpleapps-com/<repo> \
|
|
46
|
+
--title "fix: search endpoint returns 404" \
|
|
47
|
+
--body "$(cat <<'ISSUE'
|
|
48
|
+
## Problem
|
|
49
|
+
The `search` MCP tool returns HTTP 404 on every query. This prevents finding content across projects.
|
|
50
|
+
|
|
51
|
+
## Expected Behavior
|
|
52
|
+
Search SHOULD return matching results, consistent with the Basecamp web UI.
|
|
53
|
+
|
|
54
|
+
## Acceptance Criteria
|
|
55
|
+
- [ ] Search returns results for known content
|
|
56
|
+
- [ ] Error handling for empty results
|
|
57
|
+
|
|
58
|
+
## Context
|
|
59
|
+
BCX API may not expose a search endpoint. Web UI search at `/search?q=...` works.
|
|
60
|
+
ISSUE
|
|
61
|
+
)"
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Managing Issues
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
gh issue list --repo simpleapps-com/<repo> # List open issues
|
|
68
|
+
gh issue list --repo simpleapps-com/<repo> --state all # Include closed
|
|
69
|
+
gh issue view <number> --repo simpleapps-com/<repo> # View issue details
|
|
70
|
+
gh issue close <number> --repo simpleapps-com/<repo> # Close issue
|
|
71
|
+
gh issue close <number> --repo simpleapps-com/<repo> --comment "message" # Close with comment
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Closing via Commit
|
|
75
|
+
|
|
76
|
+
Include `Closes #N` in the commit message body to auto-close issues when pushed.
|
|
77
|
+
|
|
78
|
+
## Pull Requests
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
gh pr create --repo simpleapps-com/<repo> --title "title" --body "description"
|
|
82
|
+
gh pr list --repo simpleapps-com/<repo>
|
|
83
|
+
gh pr view <number> --repo simpleapps-com/<repo>
|
|
84
|
+
gh pr merge <number> --repo simpleapps-com/<repo>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Cross-Linking with Basecamp
|
|
88
|
+
|
|
89
|
+
When working on client tasks that originate in Basecamp, see the `simpleapps:workflow` skill for the full Basecamp-to-GitHub cross-linking process.
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Project Structure & Wiki Workflow
|
|
2
|
+
|
|
3
|
+
## Local Layout
|
|
4
|
+
|
|
5
|
+
Every project MUST use this layout:
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
{project}/
|
|
9
|
+
├── repo/ # Main git repo (simpleapps-com/<name>.git)
|
|
10
|
+
├── wiki/ # GitHub wiki repo (simpleapps-com/<name>.wiki.git)
|
|
11
|
+
├── wip/ # Work-in-progress files for active tasks (not in git)
|
|
12
|
+
└── protected/ # Secrets and credentials for dev testing (not in git)
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The parent `{project}/` directory is NOT a git repo — it's a local wrapper that keeps the code repo and wiki side-by-side. The `wip/` and `protected/` directories sit outside both git trees so their contents can never be accidentally committed.
|
|
16
|
+
|
|
17
|
+
## Why This Pattern
|
|
18
|
+
|
|
19
|
+
- GitHub wikis are separate git repos. Cloning them alongside the code keeps everything local and searchable.
|
|
20
|
+
- AI agents (Claude Code) can `Read` wiki files from disk instantly instead of fetching URLs.
|
|
21
|
+
- The wiki becomes the **source of truth for dev docs**. The repo stays focused on product code.
|
|
22
|
+
|
|
23
|
+
## Setting Up a New Project
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
mkdir {project}
|
|
27
|
+
cd {project}
|
|
28
|
+
git clone https://github.com/simpleapps-com/<name>.git repo
|
|
29
|
+
git clone https://github.com/simpleapps-com/<name>.wiki.git wiki
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
If the wiki repo doesn't exist yet, create it by adding any page via the GitHub wiki UI first, then clone.
|
|
33
|
+
|
|
34
|
+
## What Goes Where
|
|
35
|
+
|
|
36
|
+
| Content | Location | Examples |
|
|
37
|
+
|---------|----------|---------|
|
|
38
|
+
| Product code | `repo/` | Source, tests, configs, SKILL.md files |
|
|
39
|
+
| Dev documentation | `wiki/` | Architecture, guides, specs, conventions |
|
|
40
|
+
| Repo README | `repo/README.md` | Minimal — quick start + link to wiki |
|
|
41
|
+
| Repo `.claude/rules/` | `repo/` | Minimal summaries referencing wiki pages |
|
|
42
|
+
| Repo `.claude/CLAUDE.md` | `repo/` | Quick reference + wiki links |
|
|
43
|
+
| Active task context | `wip/` | WIP files for Basecamp todos or GitHub issues |
|
|
44
|
+
| Dev secrets | `protected/` | API keys, tokens, test credentials |
|
|
45
|
+
|
|
46
|
+
Rule of thumb: if a `.md` file isn't built into the end product, it belongs in the wiki. If it contains secrets or ephemeral task state, it belongs outside both git trees.
|
|
47
|
+
|
|
48
|
+
## WIP Directory
|
|
49
|
+
|
|
50
|
+
The `wip/` directory holds work-in-progress files that AI agents create when picking up tasks from Basecamp or GitHub issues. Each file tracks research, plans, and progress for an active task.
|
|
51
|
+
|
|
52
|
+
### Naming Convention
|
|
53
|
+
|
|
54
|
+
`{issue-number}-{short-description}.md` — e.g., `14-basecamp-mcp-auto-refresh-oauth.md`
|
|
55
|
+
|
|
56
|
+
### Lifecycle
|
|
57
|
+
|
|
58
|
+
1. Agent picks up a Basecamp todo or GitHub issue
|
|
59
|
+
2. Creates a WIP file with research findings and implementation plan
|
|
60
|
+
3. Updates the file as work progresses
|
|
61
|
+
4. File remains after completion as a record of decisions made
|
|
62
|
+
|
|
63
|
+
### What belongs in WIP
|
|
64
|
+
|
|
65
|
+
- Research findings and code analysis
|
|
66
|
+
- Detailed implementation plans
|
|
67
|
+
- Decision rationale
|
|
68
|
+
- Test results and verification notes
|
|
69
|
+
|
|
70
|
+
### What does NOT belong in WIP
|
|
71
|
+
|
|
72
|
+
- Secrets, credentials, or tokens (use `protected/`)
|
|
73
|
+
- Final documentation (use `wiki/`)
|
|
74
|
+
- Code (use `repo/`)
|
|
75
|
+
|
|
76
|
+
## Protected Directory
|
|
77
|
+
|
|
78
|
+
The `protected/` directory stores secrets and credentials needed during development and testing. It sits outside all git trees so nothing can be accidentally committed.
|
|
79
|
+
|
|
80
|
+
Examples: API keys, OAuth tokens, test credentials, `.env` files for local testing.
|
|
81
|
+
|
|
82
|
+
MUST NOT be committed to any git repository. MUST NOT be copied into `repo/` or `wiki/`.
|
|
83
|
+
|
|
84
|
+
## Referencing Wiki from Repo
|
|
85
|
+
|
|
86
|
+
Repo files SHOULD use **relative filesystem paths** to reference wiki content:
|
|
87
|
+
|
|
88
|
+
```markdown
|
|
89
|
+
Full docs: ../../../wiki/Versioning.md
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Relative paths work for Claude Code (local file reads). GitHub URLs require network access and are slower.
|
|
93
|
+
|
|
94
|
+
## Wiki Conventions
|
|
95
|
+
|
|
96
|
+
### Page Naming
|
|
97
|
+
|
|
98
|
+
- Use **PascalCase** with hyphens: `Getting-Started.md`, `Plugin-Structure.md`
|
|
99
|
+
- Match the pattern used in GitHub wiki URLs: `wiki/Page-Name`
|
|
100
|
+
|
|
101
|
+
### _Sidebar.md
|
|
102
|
+
|
|
103
|
+
Every wiki MUST have a `_Sidebar.md` for navigation. Group pages by topic:
|
|
104
|
+
|
|
105
|
+
```markdown
|
|
106
|
+
**[[Home]]**
|
|
107
|
+
|
|
108
|
+
**Getting Started**
|
|
109
|
+
- [[Getting-Started]]
|
|
110
|
+
|
|
111
|
+
**Architecture**
|
|
112
|
+
- [[Architecture]]
|
|
113
|
+
- [[Plugin-Structure]]
|
|
114
|
+
|
|
115
|
+
**Development**
|
|
116
|
+
- [[Development]]
|
|
117
|
+
- [[Versioning]]
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Linking
|
|
121
|
+
|
|
122
|
+
- Use `[[Page-Name]]` wiki links for internal links (renders on GitHub wiki)
|
|
123
|
+
- Use `[[Display Text|Page-Name]]` for custom link text
|
|
124
|
+
|
|
125
|
+
### Content Guidelines
|
|
126
|
+
|
|
127
|
+
- Wiki pages are the **full, detailed** version of documentation
|
|
128
|
+
- Each page SHOULD be self-contained — don't assume the reader has seen other pages
|
|
129
|
+
- Include examples, code blocks, and tables where they help
|
|
130
|
+
- Use RFC 2119 keywords (MUST/SHOULD/MAY) for requirements
|
|
131
|
+
|
|
132
|
+
### Committing Wiki Changes
|
|
133
|
+
|
|
134
|
+
The wiki is a regular git repo. Commit and push like any other:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
cd {project}/wiki
|
|
138
|
+
git add -A && git commit -m "docs: add architecture page"
|
|
139
|
+
git push origin master
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Note: GitHub wikis typically use `master` as the default branch, not `main`.
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# Wiki as Context
|
|
2
|
+
|
|
3
|
+
The GitHub wiki is the **single source of truth** for how a project works. It is not an afterthought or a place to dump notes — it is the primary context that drives development.
|
|
4
|
+
|
|
5
|
+
## The Problem
|
|
6
|
+
|
|
7
|
+
Documentation scattered across a codebase creates friction:
|
|
8
|
+
|
|
9
|
+
- `.claude/rules/` files, README.md, inline comments, and docs/ folders all compete as sources of truth
|
|
10
|
+
- AI agents waste tokens reading large files to find relevant context
|
|
11
|
+
- New team members don't know where to look
|
|
12
|
+
- Docs rot because they live next to code and get forgotten
|
|
13
|
+
|
|
14
|
+
## The Solution
|
|
15
|
+
|
|
16
|
+
The wiki is the **spec**. The repo is the **implementation**.
|
|
17
|
+
|
|
18
|
+
| Wiki | Repo |
|
|
19
|
+
|------|------|
|
|
20
|
+
| Architecture decisions | Code that implements them |
|
|
21
|
+
| API specs | API code |
|
|
22
|
+
| Conventions and standards | Code that follows them |
|
|
23
|
+
| Onboarding guides | Nothing — wiki is self-contained |
|
|
24
|
+
| Release processes | Automation scripts |
|
|
25
|
+
| Full explanations | Minimal pointers back to wiki |
|
|
26
|
+
|
|
27
|
+
## How It Works
|
|
28
|
+
|
|
29
|
+
### 1. Wiki First
|
|
30
|
+
|
|
31
|
+
When starting new work, check the wiki first. If the wiki doesn't cover it, write the wiki page before writing code. The wiki defines *what* and *why*. The code implements *how*.
|
|
32
|
+
|
|
33
|
+
### 2. Repo References Wiki
|
|
34
|
+
|
|
35
|
+
Repo files (`.claude/CLAUDE.md`, `.claude/rules/`, `README.md`) SHOULD be **minimal** — just enough to orient, then point to the wiki for details.
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
# Versioning
|
|
39
|
+
|
|
40
|
+
Full docs: ../../../wiki/Versioning.md
|
|
41
|
+
|
|
42
|
+
`VERSION` file = source of truth. All version fields MUST match.
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 3. AI Agents Read Wiki Locally
|
|
46
|
+
|
|
47
|
+
Because the wiki is cloned alongside the repo (see `project-structure.md`), AI agents read wiki pages as local files. No network requests, no URL fetching — just `Read ../../../wiki/Architecture.md`.
|
|
48
|
+
|
|
49
|
+
This means wiki pages are both human documentation AND machine context.
|
|
50
|
+
|
|
51
|
+
### 4. Wiki Evolves with the Project
|
|
52
|
+
|
|
53
|
+
The wiki is not write-once. As the codebase changes:
|
|
54
|
+
|
|
55
|
+
- Update affected wiki pages in the same work session
|
|
56
|
+
- Add new pages when new patterns emerge
|
|
57
|
+
- Remove pages when features are deprecated
|
|
58
|
+
- Keep the `_Sidebar.md` current
|
|
59
|
+
|
|
60
|
+
## Three Audiences
|
|
61
|
+
|
|
62
|
+
Every wiki page serves three audiences simultaneously:
|
|
63
|
+
|
|
64
|
+
| Audience | What they need | How they read |
|
|
65
|
+
|----------|---------------|---------------|
|
|
66
|
+
| **Junior devs** | Explanations of *why*, step-by-step instructions, examples they can copy | Top to bottom, following links for context |
|
|
67
|
+
| **Senior devs** | Quick reference, architecture decisions, conventions to follow | Scan for the section they need, skip the rest |
|
|
68
|
+
| **AI agents** | Unambiguous specs, exact commands, clear requirements (MUST/SHOULD/MAY) | Load the full wiki into context, act on it |
|
|
69
|
+
|
|
70
|
+
### Writing for All Three
|
|
71
|
+
|
|
72
|
+
- **Lead with a summary** — seniors and agents get what they need fast, juniors get orientation
|
|
73
|
+
- **Explain the *why* before the *how*** — juniors learn the reasoning, seniors confirm their assumptions, agents get decision context
|
|
74
|
+
- **Use tables for reference data** — scannable for seniors, parseable for agents, structured for juniors
|
|
75
|
+
- **Use code blocks for anything copy-pasteable** — all three audiences benefit from exact commands
|
|
76
|
+
- **Use RFC 2119 keywords (MUST/SHOULD/MAY)** — removes ambiguity for everyone, especially agents
|
|
77
|
+
- **Include examples** — juniors learn by example, agents use them as patterns
|
|
78
|
+
|
|
79
|
+
### Keep Pages Self-Contained
|
|
80
|
+
|
|
81
|
+
Each page SHOULD make sense on its own. A junior dev landing on any page SHOULD be able to understand it without reading the rest of the wiki.
|
|
82
|
+
|
|
83
|
+
### Follow the Writing Style Skill
|
|
84
|
+
|
|
85
|
+
All wiki content MUST follow the `simpleapps:writing-style` skill:
|
|
86
|
+
|
|
87
|
+
- **RFC 2119 keywords** — MUST/SHOULD/MAY in ALL CAPS for requirements, lowercase for casual suggestions
|
|
88
|
+
- **Token efficiency** — action verbs first, no filler, specific over generic, Bottom Line Up Front
|
|
89
|
+
- **Developer-facing tone** — technical and concise, include file references and acceptance criteria
|
|
90
|
+
- **Expand for onboarding and architecture** — juniors and future devs need the "why"
|
|
91
|
+
- **Cut everywhere else** — two sentences that answer the question beat two pages that fill the context window
|
|
92
|
+
|
|
93
|
+
The wiki is developer-facing documentation. It is NOT client-facing. Write for devs and AI agents, not for non-technical readers.
|
|
94
|
+
|
|
95
|
+
### Link with Anchor Precision
|
|
96
|
+
|
|
97
|
+
When referencing other wiki pages, MUST link directly to the relevant section using `#` anchors — not just the page.
|
|
98
|
+
|
|
99
|
+
```markdown
|
|
100
|
+
# Good — links to exact section
|
|
101
|
+
See [[Versioning#version-bump-procedure]] for the step-by-step process.
|
|
102
|
+
Check [[Architecture#three-layers]] for how marketplace, plugins, and CLI relate.
|
|
103
|
+
|
|
104
|
+
# Bad — links to top of page, reader has to hunt
|
|
105
|
+
See [[Versioning]] for details.
|
|
106
|
+
Check [[Architecture]] for more info.
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
This matters for two reasons:
|
|
110
|
+
- **Devs** jump straight to the answer instead of scrolling through a page
|
|
111
|
+
- **AI agents** use anchor links as an attention signal — a `#section` reference tells the agent exactly which part of a page is relevant to the current task, reducing noise in a 20K token wiki
|
|
112
|
+
|
|
113
|
+
### The 20K Token Budget
|
|
114
|
+
|
|
115
|
+
The entire wiki MUST stay under **20K tokens** (~60KB of markdown). This is a hard constraint, not a guideline.
|
|
116
|
+
|
|
117
|
+
Why 20K: with a 200K token context window, the full wiki never exceeds 10% of available context. This means an AI agent can load the **entire wiki** into active context at the start of a session and keep it there throughout. No selective loading, no missed context, no stale references — the agent always has the complete picture.
|
|
118
|
+
|
|
119
|
+
If the wiki approaches the budget:
|
|
120
|
+
- Tighten language — cut filler, use tables over prose
|
|
121
|
+
- Merge overlapping pages
|
|
122
|
+
- Move implementation details back to code comments where they belong
|
|
123
|
+
- Archive obsolete pages (delete, don't hoard)
|
|
124
|
+
|
|
125
|
+
To check the current budget:
|
|
126
|
+
```bash
|
|
127
|
+
wc -c {project}/wiki/*.md
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Rough conversion: 1 token ≈ 3 bytes of markdown. So 20K tokens ≈ 60KB.
|
|
131
|
+
|
|
132
|
+
### Right-Size Each Page
|
|
133
|
+
|
|
134
|
+
- Too short = missing context, agent has to search elsewhere
|
|
135
|
+
- Too long = wasted tokens, buried signal
|
|
136
|
+
- Target: enough to act on without reading anything else
|
|
137
|
+
|
|
138
|
+
## The Feedback Loop
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
Wiki defines → Code implements → Learnings update wiki → Repeat
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
When code reveals that the wiki is wrong or incomplete, update the wiki immediately. The wiki MUST reflect reality, not aspirations.
|
|
145
|
+
|
|
146
|
+
## When to Update the Wiki
|
|
147
|
+
|
|
148
|
+
- **New feature** — Write the wiki page first (spec), then implement
|
|
149
|
+
- **Bug fix** — If the fix reveals a gap in documentation, update the wiki
|
|
150
|
+
- **Architecture change** — Update Architecture page before or during the change
|
|
151
|
+
- **New convention** — Add to the relevant wiki page so the team adopts it
|
|
152
|
+
- **Onboarding friction** — If someone asks "where is X?", the answer should be a wiki link. If it's not, create the page.
|
|
153
|
+
|
|
154
|
+
## Anti-Patterns
|
|
155
|
+
|
|
156
|
+
| Don't | Do |
|
|
157
|
+
|-------|-----|
|
|
158
|
+
| Write long README.md files in the repo | Minimal README + wiki link |
|
|
159
|
+
| Duplicate wiki content in `.claude/rules/` | Thin rules that reference wiki |
|
|
160
|
+
| Leave wiki pages stale after code changes | Update wiki in the same session |
|
|
161
|
+
| Use the wiki as a dumping ground for notes | Structure pages with clear purpose |
|
|
162
|
+
| Write wiki pages only humans can understand | Write for both humans and AI agents |
|
|
@@ -34,4 +34,6 @@ The `basecamp` MCP server (bundled with this plugin) provides direct API access
|
|
|
34
34
|
## References
|
|
35
35
|
|
|
36
36
|
- See `basecamp.md` for MCP tools, Chrome fallback, and Basecamp navigation
|
|
37
|
-
- See `github.md` for GitHub
|
|
37
|
+
- See `github.md` for Basecamp-to-GitHub cross-linking
|
|
38
|
+
- See `simpleapps:github` skill for GitHub org conventions and `gh` CLI usage
|
|
39
|
+
- See `simpleapps:fyxer` skill for Fyxer meeting transcript processing and Basecamp posting
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Basecamp 2 Reference
|
|
2
2
|
|
|
3
|
-
IMPORTANT: YOU MUST NOT create, edit, or delete anything in Basecamp
|
|
3
|
+
IMPORTANT: YOU MUST NOT create, edit, or delete anything in Basecamp without user permission.
|
|
4
|
+
|
|
5
|
+
**Content format**: All write tools SHOULD use plain text with line breaks, NOT HTML. Basecamp returns HTML in responses but prefers plain text for creation.
|
|
4
6
|
|
|
5
7
|
## Setup
|
|
6
8
|
|
|
@@ -21,6 +23,10 @@ The `basecamp` MCP server is bundled with this plugin and starts automatically.
|
|
|
21
23
|
|------|-------------|
|
|
22
24
|
| `list_projects` | List projects. status: 'active', 'drafts', or 'archived' |
|
|
23
25
|
| `get_project` | Get project details by project_id |
|
|
26
|
+
| `create_project` | Create a new project (name, description) |
|
|
27
|
+
| `update_project` | Update project name/description |
|
|
28
|
+
| `archive_project` | Archive or unarchive a project (archive=False to reactivate) |
|
|
29
|
+
| `delete_project` | Delete a project permanently |
|
|
24
30
|
|
|
25
31
|
### People
|
|
26
32
|
| Tool | Description |
|
|
@@ -28,16 +34,29 @@ The `basecamp` MCP server is bundled with this plugin and starts automatically.
|
|
|
28
34
|
| `list_people` | List all people on the account |
|
|
29
35
|
| `get_person` | Get person details by person_id |
|
|
30
36
|
| `get_me` | Get the authenticated user's profile |
|
|
37
|
+
| `list_person_projects` | List projects accessible to a person |
|
|
38
|
+
| `delete_person` | Remove a person from the account (admin only) |
|
|
31
39
|
|
|
32
40
|
### Todos
|
|
33
41
|
| Tool | Description |
|
|
34
42
|
|------|-------------|
|
|
35
|
-
| `get_todo` | Get a single todo with comments (project_id, todo_id) |
|
|
43
|
+
| `get_todo` | Get a single todo with comments and attachments (project_id, todo_id) |
|
|
36
44
|
| `list_todos` | List todos in a project. status: 'remaining', 'completed', or 'all' |
|
|
37
45
|
| `list_todos_due_since` | List todos due after a date (YYYY-MM-DD) |
|
|
38
46
|
| `list_my_todos` | List all open todos assigned to the current user (paginated) |
|
|
39
47
|
| `list_assigned_todos` | List open todos assigned to any person_id |
|
|
48
|
+
| `create_todo` | Create a todo in a todo list (project_id, todolist_id, content, assignee_id, due_date) |
|
|
49
|
+
| `update_todo` | Update a todo's content, due date, or assignee |
|
|
40
50
|
| `assign_todo` | Reassign a todo to a different person_id |
|
|
51
|
+
| `close_todo` | Mark a todo as completed/closed |
|
|
52
|
+
| `reopen_todo` | Reopen a completed todo |
|
|
53
|
+
| `delete_todo` | Delete a todo permanently |
|
|
54
|
+
|
|
55
|
+
### Comments
|
|
56
|
+
| Tool | Description |
|
|
57
|
+
|------|-------------|
|
|
58
|
+
| `create_comment` | Add a comment to a todo (plain text) |
|
|
59
|
+
| `delete_comment` | Delete a comment permanently |
|
|
41
60
|
|
|
42
61
|
### Todo Lists
|
|
43
62
|
| Tool | Description |
|
|
@@ -45,12 +64,18 @@ The `basecamp` MCP server is bundled with this plugin and starts automatically.
|
|
|
45
64
|
| `list_todolists` | List active todo lists in a project |
|
|
46
65
|
| `list_all_todolists` | List todo lists across all projects. status: 'active', 'completed', or 'trashed' |
|
|
47
66
|
| `get_todolist` | Get all todos in a specific todo list |
|
|
67
|
+
| `create_todolist` | Create a new todo list (project_id, name, description) |
|
|
68
|
+
| `update_todolist` | Update a todo list's name, description, or position |
|
|
69
|
+
| `delete_todolist` | Delete a todo list permanently |
|
|
48
70
|
|
|
49
71
|
### Messages
|
|
50
72
|
| Tool | Description |
|
|
51
73
|
|------|-------------|
|
|
52
|
-
| `list_messages` | List messages in a project |
|
|
53
|
-
| `get_message` | Get a message with comments |
|
|
74
|
+
| `list_messages` | List messages/discussions in a project (via topics) |
|
|
75
|
+
| `get_message` | Get a message with comments and attachments |
|
|
76
|
+
| `create_message` | Create a new discussion (project_id, subject, content) |
|
|
77
|
+
| `update_message` | Update a message's subject/content |
|
|
78
|
+
| `delete_message` | Delete a message permanently |
|
|
54
79
|
|
|
55
80
|
Note: Messages may not be available on all Basecamp plans.
|
|
56
81
|
|
|
@@ -59,6 +84,9 @@ Note: Messages may not be available on all Basecamp plans.
|
|
|
59
84
|
|------|-------------|
|
|
60
85
|
| `list_documents` | List documents. project_id=0 for all projects |
|
|
61
86
|
| `get_document` | Get a single document (e.g., site-info) |
|
|
87
|
+
| `create_document` | Create a new document (title, content) |
|
|
88
|
+
| `update_document` | Update a document's title/content |
|
|
89
|
+
| `delete_document` | Delete a document permanently |
|
|
62
90
|
|
|
63
91
|
### Calendar Events
|
|
64
92
|
| Tool | Description |
|
|
@@ -66,26 +94,68 @@ Note: Messages may not be available on all Basecamp plans.
|
|
|
66
94
|
| `list_calendars` | List all calendars |
|
|
67
95
|
| `list_calendar_events` | List events. Filter by project_id, start_date, end_date, past |
|
|
68
96
|
| `get_calendar_event` | Get a specific calendar event |
|
|
97
|
+
| `create_calendar_event` | Create an event (summary, starts_at, description, all_day, ends_at, remind_at) |
|
|
98
|
+
| `update_calendar_event` | Update an event's fields |
|
|
99
|
+
| `delete_calendar_event` | Delete a calendar event |
|
|
69
100
|
|
|
70
|
-
### Topics
|
|
101
|
+
### Topics
|
|
71
102
|
| Tool | Description |
|
|
72
103
|
|------|-------------|
|
|
73
104
|
| `list_topics` | List topics. project_id=0 for all. archived=True for archived |
|
|
74
|
-
| `
|
|
105
|
+
| `archive_topic` | Archive a topic |
|
|
106
|
+
| `activate_topic` | Reactivate an archived topic |
|
|
107
|
+
|
|
108
|
+
### Attachments & Uploads
|
|
109
|
+
| Tool | Description |
|
|
110
|
+
|------|-------------|
|
|
75
111
|
| `list_attachments` | List attachments. project_id=0 for all (paginated) |
|
|
112
|
+
| `get_attachment` | Get attachment metadata and download URL (project_id, attachment_id) |
|
|
113
|
+
| `download_attachment` | Download attachment to local file (project_id, attachment_id) |
|
|
76
114
|
| `get_upload` | Get an upload with comments |
|
|
115
|
+
| `create_upload` | Upload a local file to a project's Files section |
|
|
116
|
+
| `delete_upload` | Delete an upload (move to trash) |
|
|
117
|
+
|
|
118
|
+
### Activity
|
|
119
|
+
| Tool | Description |
|
|
120
|
+
|------|-------------|
|
|
121
|
+
| `list_events` | Activity log since a datetime. Filter by project_id or person_id |
|
|
77
122
|
|
|
78
|
-
###
|
|
123
|
+
### Access Management
|
|
79
124
|
| Tool | Description |
|
|
80
125
|
|------|-------------|
|
|
81
126
|
| `list_accesses` | List people with access to a project |
|
|
127
|
+
| `grant_access` | Grant team access (comma-separated ids and/or email_addresses) |
|
|
128
|
+
| `grant_client_access` | Grant client-level access (comma-separated ids and/or email_addresses) |
|
|
129
|
+
| `revoke_access` | Revoke a person's project access |
|
|
130
|
+
|
|
131
|
+
### Stars
|
|
132
|
+
| Tool | Description |
|
|
133
|
+
|------|-------------|
|
|
82
134
|
| `list_stars` | List starred/favorite projects |
|
|
135
|
+
| `star_project` | Star (bookmark) a project |
|
|
136
|
+
| `unstar_project` | Remove star from a project |
|
|
137
|
+
|
|
138
|
+
### Forwards
|
|
139
|
+
| Tool | Description |
|
|
140
|
+
|------|-------------|
|
|
83
141
|
| `list_forwards` | List email forwards. project_id=0 for all |
|
|
84
142
|
| `get_forward` | Get a specific email forward with comments |
|
|
85
|
-
|
|
143
|
+
|
|
144
|
+
**Note**: The BCX API does not have a search endpoint. To find content, use `list_topics(project_id)` to browse, or `list_messages(project_id)` for messages. For cross-project browsing, use `list_topics()` (no project_id) to get recent topics across all projects.
|
|
86
145
|
|
|
87
146
|
**Extracting IDs from Basecamp URLs**: A URL like `https://basecamp.com/2805226/projects/18932786/todos/514631271` gives you project_id=`18932786` and todo_id=`514631271`.
|
|
88
147
|
|
|
148
|
+
## Downloading Attachments
|
|
149
|
+
|
|
150
|
+
Attachments can be on todos, comments, messages, or uploads. To retrieve them:
|
|
151
|
+
|
|
152
|
+
1. **Discover**: Call `get_todo` or `get_message` — attachments appear with IDs in both the top-level section and within individual comments
|
|
153
|
+
2. **Inspect** (optional): Call `get_attachment(project_id, attachment_id)` to see metadata, size, content type, and download URL
|
|
154
|
+
3. **Download**: Call `download_attachment(project_id, attachment_id)` — saves to `~/.simpleapps/downloads/{project_id}/`
|
|
155
|
+
4. **Read**: Use the `Read` tool on the local file path to view content (works for images, PDFs, Excel, text)
|
|
156
|
+
|
|
157
|
+
To browse all attachments in a project, use `list_attachments(project_id)`.
|
|
158
|
+
|
|
89
159
|
## Chrome Fallback
|
|
90
160
|
|
|
91
161
|
If the MCP server is unavailable (credentials expired, server not running), use Chrome:
|
|
@@ -112,6 +182,10 @@ If the MCP server is unavailable (credentials expired, server not running), use
|
|
|
112
182
|
|
|
113
183
|
**JSON API via Chrome**: Navigate to `/api/v1/projects/<project_id>/todos/<todo_id>.json` then use `get_page_text`. WebFetch will NOT work — Chrome carries session cookies.
|
|
114
184
|
|
|
185
|
+
## Fyxer Meeting Transcripts
|
|
186
|
+
|
|
187
|
+
To post Fyxer meeting recordings as Basecamp Discussions, see the `simpleapps:fyxer` skill. It handles extraction, local caching, duplicate detection, and posting via `create_message`.
|
|
188
|
+
|
|
115
189
|
## Site Info Documents
|
|
116
190
|
|
|
117
191
|
Each Basecamp project SHOULD have a **site-info** text document in its Documents section. It contains site-specific details like siteId and domain name needed for GitHub issues and development work. Use `list_documents` + `get_document` to find it. If no site-info document exists, ask the user to create one.
|
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
# GitHub
|
|
1
|
+
# Basecamp → GitHub Cross-Linking
|
|
2
|
+
|
|
3
|
+
When a client request in Basecamp needs development work, create a GitHub issue and cross-link them.
|
|
2
4
|
|
|
3
5
|
## Creating Issues from Basecamp Todos
|
|
4
6
|
|
|
5
|
-
Before creating an issue, gather context:
|
|
6
|
-
1. Use `get_todo`
|
|
7
|
-
2. Use `list_documents` + `get_document`
|
|
7
|
+
Before creating an issue, gather context from Basecamp (see `basecamp.md` for full MCP tool reference):
|
|
8
|
+
1. Use `get_todo` to read the Basecamp todo and summarize the client request
|
|
9
|
+
2. Use `list_documents` + `get_document` to find the project's **site-info** document for siteId and domain name. If no site-info document exists, ask the user to create one in Basecamp.
|
|
10
|
+
|
|
11
|
+
See the `simpleapps:github` skill for `gh` CLI usage and org conventions.
|
|
8
12
|
|
|
9
|
-
|
|
13
|
+
Issue template for Basecamp-linked issues:
|
|
10
14
|
|
|
11
15
|
```bash
|
|
12
16
|
gh issue create --repo simpleapps-com/<repo> \
|
|
@@ -28,19 +32,3 @@ gh issue create --repo simpleapps-com/<repo> \
|
|
|
28
32
|
|
|
29
33
|
- Include the Basecamp todo URL in the GitHub issue body (under a `## Basecamp` heading)
|
|
30
34
|
- After creating the issue, provide the GitHub issue URL to the user so they can add it to the Basecamp todo comments
|
|
31
|
-
|
|
32
|
-
## Conventions
|
|
33
|
-
|
|
34
|
-
- YOU MUST ALWAYS ask the user which GitHub repo to create the issue in — it could be the client site repo, the augur repo, or any other repo in the org
|
|
35
|
-
- Issue title SHOULD be a technical description, not the client's words
|
|
36
|
-
- Reference the Basecamp todo as the source of the request
|
|
37
|
-
- Use labels to categorize (bug, feature, enhancement)
|
|
38
|
-
- Assign to the appropriate developer
|
|
39
|
-
|
|
40
|
-
## Useful Commands
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
gh issue list --repo simpleapps-com/<repo> # List open issues
|
|
44
|
-
gh issue view <number> --repo simpleapps-com/<repo> # View issue details
|
|
45
|
-
gh issue create --repo simpleapps-com/<repo> # Create new issue
|
|
46
|
-
```
|