Skip to content

Commit 128cfc5

Browse files
committed
chore: update README.md & .npmignore
1 parent 780aa0c commit 128cfc5

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.npmignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,10 @@ scripts/
6363
.npmrc
6464
.travis.yml
6565
.circleci/
66+
67+
68+
docker-compose.yml
69+
vitest.config.ts
70+
tsconfig.json
71+
run-inspector.sh
72+
test/

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,35 @@ To use this server with Claude Desktop:
124124
> - `S3_BUCKETS` should contain a comma-separated list of buckets you want to allow access to
125125
> - `AWS_REGION` should be set to the region where your buckets are located
126126
127+
### 💣 If error occurs on Claude Desktop
128+
129+
If you encounter errors with the above configuration in Claude Desktop, try using absolute paths as follows:
130+
131+
```bash
132+
# Get the path of node and aws-s3-mcp
133+
which node
134+
which aws-s3-mcp
135+
```
136+
137+
```json
138+
{
139+
"globalShortcut": "",
140+
"mcpServers": {
141+
"s3": {
142+
"command": "your-absolute-path-to-node",
143+
"args": ["your-absolute-path-to-aws-s3-mcp/dist/index.js"],
144+
"env": {
145+
"AWS_REGION": "your-aws-region",
146+
"S3_BUCKETS": "your-s3-buckets",
147+
"S3_MAX_BUCKETS": "your-max-buckets",
148+
"AWS_ACCESS_KEY_ID": "your-access-key",
149+
"AWS_SECRET_ACCESS_KEY": "your-secret-key"
150+
}
151+
}
152+
}
153+
}
154+
```
155+
127156
## Available Tools
128157

129158
### list-buckets

0 commit comments

Comments
 (0)