Skip to content

Commit afeea23

Browse files
fedorovclaude
andcommitted
Update USAGE.md installation instructions
- Point ZIP upload to the Releases page instead of repo ZIP export - Fix npx skills add syntax: use owner/repo format, drop --skill flag - Replace invalid /read slash command in Option 4 with plain-language instructions - Expand reference guides list to cover all 10 files (was only bigquery + dicomweb) - Fix API example model ID: claude-sonnet-4-20250514 → claude-sonnet-4-6 - Add references/ entry to Resources section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 1804ddd commit afeea23

1 file changed

Lines changed: 29 additions & 14 deletions

File tree

USAGE.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This document provides technical instructions for integrating the IDC Claude ski
44

55
## Claude.ai Web Interface
66

7-
### Upload Repository as ZIP
7+
### Upload Release ZIP
88

9-
1. Download this repository as a ZIP file (Code → Download ZIP on GitHub)
9+
1. Download the latest release ZIP from the [Releases page](https://github.com/ImagingDataCommons/idc-claude-skill/releases/latest)
1010
2. Start a new conversation at [claude.ai](https://claude.ai)
1111
3. Click the attachment icon and upload the ZIP file
1212
4. Claude will have access to all skill content including reference guides
@@ -49,7 +49,7 @@ If you're using [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (t
4949
The simplest way to install this skill using the [Skills.sh](https://skills.sh/) framework:
5050

5151
```bash
52-
npx skills add https://github.com/imagingdatacommons/idc-claude-skill --skill imaging-data-commons
52+
npx skills add ImagingDataCommons/idc-claude-skill
5353
```
5454

5555
This command will automatically detect all AI agents on your system and offer to install the skill across all of them, making it available system-wide. Once installed, invoke with `/imaging-data-commons` or let your AI assistant auto-detect based on questions about IDC.
@@ -81,15 +81,25 @@ This makes the skill available only when working in that project.
8181

8282
### Option 4: Import During Session
8383

84-
For one-time use, read the skill files directly:
84+
For one-time use without permanent installation, ask Claude to read the skill file at the start of your session:
85+
8586
```
86-
/read /path/to/idc-claude-skill/SKILL.md
87+
Please read /path/to/idc-claude-skill/SKILL.md and use it for IDC queries.
8788
```
8889

89-
For BigQuery or DICOMweb features, also read the reference guides:
90+
Ask Claude to load reference guides as needed for specific topics:
91+
9092
```
91-
/read /path/to/idc-claude-skill/references/bigquery_guide.md
92-
/read /path/to/idc-claude-skill/references/dicomweb_guide.md
93+
Please also read /path/to/idc-claude-skill/references/bigquery_guide.md # BigQuery advanced queries
94+
Please also read /path/to/idc-claude-skill/references/dicomweb_guide.md # DICOMweb API access
95+
Please also read /path/to/idc-claude-skill/references/index_tables_guide.md # Table schemas and join columns
96+
Please also read /path/to/idc-claude-skill/references/sql_patterns.md # Quick-reference SQL patterns
97+
Please also read /path/to/idc-claude-skill/references/use_cases.md # End-to-end workflow examples
98+
Please also read /path/to/idc-claude-skill/references/digital_pathology_guide.md # Pathology (SM, ANN, SEG)
99+
Please also read /path/to/idc-claude-skill/references/clinical_data_guide.md # Clinical/tabular data
100+
Please also read /path/to/idc-claude-skill/references/cloud_storage_guide.md # Direct GCS/S3 access
101+
Please also read /path/to/idc-claude-skill/references/cli_guide.md # idc-index CLI tools
102+
Please also read /path/to/idc-claude-skill/references/parquet_access_guide.md # Direct Parquet queries
93103
```
94104

95105
### Verifying Installation
@@ -106,7 +116,7 @@ Or invoke directly:
106116

107117
## Claude API Setup
108118

109-
If you're using the Claude API directly, include the contents of `SKILL.md` in your system prompt. For BigQuery or DICOMweb features, also include the relevant reference guides.
119+
If you're using the Claude API directly, include the contents of `SKILL.md` in your system prompt. Include additional reference guides from [references/](references/) as needed for advanced features.
110120

111121
### Example with Anthropic API
112122

@@ -117,14 +127,18 @@ from pathlib import Path
117127
# Read skill files
118128
skill_content = Path('SKILL.md').read_text()
119129

120-
# Optionally include reference guides for advanced features
121-
# skill_content += "\n\n" + Path('references/bigquery_guide.md').read_text()
122-
# skill_content += "\n\n" + Path('references/dicomweb_guide.md').read_text()
130+
# Optionally include reference guides for advanced features:
131+
# skill_content += "\n\n" + Path('references/bigquery_guide.md').read_text() # BigQuery queries
132+
# skill_content += "\n\n" + Path('references/dicomweb_guide.md').read_text() # DICOMweb API
133+
# skill_content += "\n\n" + Path('references/index_tables_guide.md').read_text() # Table schemas
134+
# skill_content += "\n\n" + Path('references/digital_pathology_guide.md').read_text() # Pathology
135+
# skill_content += "\n\n" + Path('references/clinical_data_guide.md').read_text() # Clinical data
136+
# skill_content += "\n\n" + Path('references/cloud_storage_guide.md').read_text() # GCS/S3 access
123137

124138
client = anthropic.Anthropic(api_key="your-api-key")
125139

126140
message = client.messages.create(
127-
model="claude-sonnet-4-20250514",
141+
model="claude-sonnet-4-6",
128142
max_tokens=1024,
129143
system=skill_content, # Include skill as system context
130144
messages=[
@@ -174,7 +188,7 @@ Claude: [Checks license and explains usage restrictions]
174188
### Skill Not Loading
175189

176190
- **Claude Code**: Verify the symlink exists at `~/.claude/skills/imaging-data-commons` and points to the correct directory
177-
- **ZIP attachment** (Claude.ai): Ensure the repository ZIP is attached to your conversation before asking IDC-related questions
191+
- **ZIP attachment** (Claude.ai): Ensure the release ZIP is attached to your conversation before asking IDC-related questions
178192
- **File size**: The ZIP file is large. If Claude seems unaware of IDC, the file may not have been fully loaded
179193

180194
### Skill Not Responding as Expected
@@ -198,6 +212,7 @@ Claude: [Checks license and explains usage restrictions]
198212
## Resources
199213

200214
- [SKILL.md](SKILL.md) - Comprehensive skill documentation
215+
- [references/](references/) - Reference guides (BigQuery, DICOMweb, SQL patterns, pathology, clinical data, cloud storage, CLI, Parquet)
201216
- [IDC Documentation](https://learn.canceridc.dev/)
202217
- [idc-index Package](https://pypi.org/project/idc-index/)
203218
- [IDC Portal](https://portal.imaging.datacommons.cancer.gov/)

0 commit comments

Comments
 (0)