Skip to content

Commit f54959f

Browse files
committed
chore: replace incorrect occurrences of 'yarn' with 'pnpm'
1 parent 5a9379c commit f54959f

File tree

4 files changed

+132
-113
lines changed

4 files changed

+132
-113
lines changed

AGENTS.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# AGENTS.md
22

33
## Build/Run Commands
4+
45
- Build: `pnpm run build` (uses tsc)
56
- Dev mode: `pnpm run dev` (tsx watch)
67
- Run tests: `pnpm run test` (vitest)
@@ -13,6 +14,7 @@
1314
- Format check: `pnpm run format:check`
1415

1516
## Code Style Guidelines
17+
1618
- Use double quotes for strings
1719
- No semicolons
1820
- Use tabs for indentation (TSConfig sets this)
@@ -27,25 +29,29 @@
2729
- Resolve JSON modules enabled
2830

2931
## Naming Conventions
32+
3033
- Files: kebab-case
3134
- Types: PascalCase
3235
- Functions/variables: camelCase
3336
- Constants: UPPER_SNAKE_CASE
34-
- Test files: *.test.ts
37+
- Test files: \*.test.ts
3538

3639
## Error Handling
40+
3741
- Use custom error classes from utils/errors.ts
3842
- Always provide meaningful error messages
3943
- Use logger.ts for consistent logging
4044
- Handle dry-run mode in all mutating operations
4145

4246
## Testing
47+
4348
- Use vitest with globals
4449
- Place tests alongside source files
4550
- Use .test.ts extension
4651
- Mock filesystem with memfs where needed
4752

4853
## Development Practices
54+
4955
- Use yarn for package management
5056
- Follow workspaces pattern with packages in `packages/{project}`
5157
- All code compatible with Cloudflare Workers runtime
@@ -56,6 +62,7 @@
5662
- Use Wrangler for deployments to Cloudflare Workers
5763

5864
## Project Structure
65+
5966
- `packages/`: Contains all project packages
6067
- `mcp/`: Main MCP implementation for Cloudflare Workers
6168
- `test-utils/`: Utilities for testing
@@ -67,7 +74,9 @@
6774
- Example application: examples/crud-mcp/src/index.ts
6875

6976
## Development Workflow
70-
1. Install dependencies at root level: `yarn install`
71-
2. Build all packages: `yarn build`
72-
3. Run tests: `yarn test`
73-
4. For specific packages, navigate to directory and use specific scripts
77+
78+
1. Install dependencies at root level: `pnpm install`
79+
2. Build all packages: `pnpm build`
80+
3. Run tests: `pnpm test`
81+
4. For specific packages, navigate to directory and use specific scripts
82+

examples/crud-mcp/README.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ This example demonstrates a CRUD (Create, Read, Update, Delete) application usin
3535
### Data Model
3636

3737
The todo items are structured with the following fields:
38+
3839
- `id`: Unique identifier (UUID)
3940
- `title`: Task title (required)
4041
- `description`: Detailed description (optional)
@@ -99,18 +100,19 @@ The application includes interactive prompts to help users understand and use th
99100
- error_type (optional): Get specific help about 'not_found', 'invalid_status', 'invalid_date', or 'other' errors
100101

101102
Example prompt usage:
103+
102104
```typescript
103105
// Get general help about listing todos
104-
const listHelp = await client.getPrompt('list_todos_help');
106+
const listHelp = await client.getPrompt("list_todos_help");
105107

106108
// Get specific help about date filtering
107-
const dateFilterHelp = await client.getPrompt('list_todos_help', {
108-
filter: 'date'
109+
const dateFilterHelp = await client.getPrompt("list_todos_help", {
110+
filter: "date",
109111
});
110112

111113
// Get help about updating a specific field
112-
const updateHelp = await client.getPrompt('update_todo_help', {
113-
field: 'status'
114+
const updateHelp = await client.getPrompt("update_todo_help", {
115+
field: "status",
114116
});
115117
```
116118

@@ -143,6 +145,7 @@ const updateHelp = await client.getPrompt('update_todo_help', {
143145
The application uses Cloudflare Workers with the following configuration:
144146

145147
### wrangler.jsonc
148+
146149
```jsonc
147150
{
148151
"name": "crud-mcp",
@@ -153,24 +156,25 @@ The application uses Cloudflare Workers with the following configuration:
153156
"bindings": [
154157
{
155158
"name": "TODO_MCP_SERVER",
156-
"class_name": "TodoMcpServer"
157-
}
158-
]
159+
"class_name": "TodoMcpServer",
160+
},
161+
],
159162
},
160163
"migrations": [
161164
{
162165
"tag": "v1",
163-
"new_sqlite_classes": ["TodoMcpServer"]
164-
}
166+
"new_sqlite_classes": ["TodoMcpServer"],
167+
},
165168
],
166169
"observability": {
167170
"enabled": true,
168-
"head_sampling_rate": 1
169-
}
171+
"head_sampling_rate": 1,
172+
},
170173
}
171174
```
172175

173176
Key Configuration Points:
177+
174178
- **Durable Objects**: The `TodoMcpServer` class is bound as a Durable Object for state management
175179
- **SQLite Support**: The `TodoMcpServer` class is registered for SQLite functionality via migrations
176180
- **Observability**: Full request sampling enabled for monitoring and debugging
@@ -208,65 +212,70 @@ await client.connect();
208212
### Creating a Todo
209213

210214
```typescript
211-
const result = await client.callTool('create_todo', {
215+
const result = await client.callTool("create_todo", {
212216
title: "Complete project report",
213217
description: "Finalize the quarterly project report",
214-
due_date: "2024-03-20"
218+
due_date: "2024-03-20",
215219
});
216220
```
217221

218222
### Listing Todos with Filters
219223

220224
```typescript
221-
const todos = await client.getResource(new URL(
222-
"d1://database/todos?status=in_progress&sort_by=due_date&sort_direction=asc"
223-
));
225+
const todos = await client.getResource(
226+
new URL(
227+
"d1://database/todos?status=in_progress&sort_by=due_date&sort_direction=asc",
228+
),
229+
);
224230
```
225231

226232
### Getting Today's Tasks
227233

228234
```typescript
229-
const todaysTodos = await client.getResource(new URL(
230-
"d1://database/todos/today?sort_by=created_at&sort_direction=asc"
231-
));
235+
const todaysTodos = await client.getResource(
236+
new URL("d1://database/todos/today?sort_by=created_at&sort_direction=asc"),
237+
);
232238
```
233239

234240
### Updating a Todo
235241

236242
```typescript
237-
const result = await client.callTool('updateTodo', {
243+
const result = await client.callTool("updateTodo", {
238244
id: "todo-uuid",
239245
status: "completed",
240-
description: "Updated description"
246+
description: "Updated description",
241247
});
242248
```
243249

244250
## Setup
245251

246252
1. Prerequisites:
247253
- Node.js (v16 or higher)
248-
- Yarn or npm
254+
- pnpm or npm
249255
- Wrangler CLI
250256

251257
2. Installation:
258+
252259
```bash
253-
yarn install
260+
pnpm install
254261
```
255262

256263
3. Development:
264+
257265
```bash
258-
yarn dev
266+
pnpm dev
259267
```
260268

261269
4. Deployment:
262270
```bash
263271
wrangler login
264-
yarn deploy
272+
pnpm deploy
265273
```
266274

267275
## Error Handling
268276

269277
The implementation includes comprehensive error handling:
278+
270279
- Input validation using Zod schemas
271280
- Database operation error handling
272281
- Detailed error messages and logging
@@ -281,4 +290,5 @@ The implementation includes comprehensive error handling:
281290

282291
## License
283292

284-
MIT
293+
MIT
294+

packages/mcp-toolbox/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A WebSocket server for managing MCP (Model Context Protocol) packages with SQLit
99
- 🧪 MCP server connection testing
1010
- 🐳 Docker containerized
1111
- ⚡ TypeScript with Node.js 22
12-
- 🧶 Yarn package manager
12+
- 🧶 pnpm package manager
1313

1414
## Quick Start
1515

@@ -29,13 +29,13 @@ pnpm dev
2929

3030
```bash
3131
# Build the Docker image (run from packages/mcp-toolbox directory - make sure you have done `pnpm i` in ../playground dir listed above)
32-
yarn docker:build
32+
pnpm docker:build
3333

3434
# Run the container with all necessary environment variables and volume mounts (refer to package.json if you want to edit this command)
35-
yarn docker:run
35+
pnpm docker:run
3636

3737
# Build and run using docker-compose (recommended for development)
38-
yarn docker:dev
38+
pnpm docker:dev
3939
```
4040

4141
**Command Details:**
@@ -304,7 +304,7 @@ ws.on("open", () => {
304304
],
305305
env: {},
306306
},
307-
})
307+
}),
308308
);
309309
});
310310

@@ -326,15 +326,15 @@ ws.send(
326326
args: ["-y", "figma-developer-mcp", "--figma-api-key=NEW-KEY", "--stdio"],
327327
env: { FIGMA_API_KEY: "NEW-KEY-VALUE" },
328328
},
329-
})
329+
}),
330330
);
331331

332332
// Delete package
333333
ws.send(
334334
JSON.stringify({
335335
verb: "delete",
336336
data: { "unique-name": "figma-mcp" },
337-
})
337+
}),
338338
);
339339
```
340340

@@ -413,22 +413,22 @@ PROXY_ID=your-uuid-here
413413

414414
```bash
415415
# Start server with proxyId
416-
yarn dev --proxy-id your-uuid-here
416+
pnpm dev --proxy-id your-uuid-here
417417

418418
# Or using environment variable
419-
PROXY_ID=your-uuid-here yarn dev
419+
PROXY_ID=your-uuid-here pnpm dev
420420

421421
# Run tests
422-
yarn test:mcp
422+
pnpm test:mcp
423423

424424
# Send test message
425-
yarn send
425+
pnpm send
426426

427427
# Build for production
428-
yarn build
428+
pnpm build
429429

430430
# Start production server with proxyId
431-
yarn start --proxy-id your-uuid-here
431+
pnpm start --proxy-id your-uuid-here
432432
```
433433

434434
## Database

0 commit comments

Comments
 (0)