@dedesfr/prompter 0.9.0 → 1.0.0

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.
Files changed (216) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +105 -77
  3. package/dist/cli/index.js +25 -1
  4. package/dist/cli/index.js.map +1 -1
  5. package/dist/commands/init.d.ts.map +1 -1
  6. package/dist/commands/init.js +32 -9
  7. package/dist/commands/init.js.map +1 -1
  8. package/dist/commands/login.d.ts +4 -0
  9. package/dist/commands/login.d.ts.map +1 -0
  10. package/dist/commands/login.js +56 -0
  11. package/dist/commands/login.js.map +1 -0
  12. package/dist/commands/logout.d.ts +4 -0
  13. package/dist/commands/logout.d.ts.map +1 -0
  14. package/dist/commands/logout.js +14 -0
  15. package/dist/commands/logout.js.map +1 -0
  16. package/dist/commands/update.d.ts.map +1 -1
  17. package/dist/commands/update.js +18 -5
  18. package/dist/commands/update.js.map +1 -1
  19. package/dist/commands/whoami.d.ts +4 -0
  20. package/dist/commands/whoami.d.ts.map +1 -0
  21. package/dist/commands/whoami.js +42 -0
  22. package/dist/commands/whoami.js.map +1 -0
  23. package/dist/core/auth-store.d.ts +10 -0
  24. package/dist/core/auth-store.d.ts.map +1 -0
  25. package/dist/core/auth-store.js +39 -0
  26. package/dist/core/auth-store.js.map +1 -0
  27. package/dist/core/registry.d.ts +18 -0
  28. package/dist/core/registry.d.ts.map +1 -0
  29. package/dist/core/registry.js +94 -0
  30. package/dist/core/registry.js.map +1 -0
  31. package/package.json +7 -1
  32. package/AGENTS.md +0 -123
  33. package/CLAUDE.md +0 -17
  34. package/build.js +0 -20
  35. package/convex-setup.md +0 -403
  36. package/prompt/ai-humanizer.md +0 -45
  37. package/prompt/api-contract-generator.md +0 -234
  38. package/prompt/apply.md +0 -17
  39. package/prompt/archive.md +0 -21
  40. package/prompt/design-system.md +0 -210
  41. package/prompt/document-explainer.md +0 -149
  42. package/prompt/epic-generator.md +0 -198
  43. package/prompt/epic-single.md +0 -47
  44. package/prompt/erd-generator.md +0 -130
  45. package/prompt/fsd-generator.md +0 -157
  46. package/prompt/prd-agent-generator.md +0 -147
  47. package/prompt/prd-generator.md +0 -195
  48. package/prompt/product-brief.md +0 -289
  49. package/prompt/proposal.md +0 -22
  50. package/prompt/qa-test-scenario.md +0 -133
  51. package/prompt/skill-creator.md +0 -350
  52. package/prompt/story-generator.md +0 -278
  53. package/prompt/story-single.md +0 -70
  54. package/prompt/tdd-generator.md +0 -294
  55. package/prompt/tdd-lite-generator.md +0 -224
  56. package/prompt/wireframe-generator.md +0 -219
  57. package/skills/ai-context-generator/SKILL.md +0 -54
  58. package/skills/ai-context-generator/references/AGENTS.template.md +0 -83
  59. package/skills/ai-context-generator/references/CLAUDE.template.md +0 -39
  60. package/skills/ai-context-generator/references/behavioral-guidelines.md +0 -71
  61. package/skills/ai-context-generator/references/discovery-checklist.md +0 -40
  62. package/skills/ai-context-generator/references/examples/AGENTS.good.md +0 -103
  63. package/skills/ai-context-generator/references/extraction-checklist.md +0 -23
  64. package/skills/ai-context-generator/references/overlays/laravel.md +0 -44
  65. package/skills/ai-humanizer/SKILL.md +0 -50
  66. package/skills/api-contract-generator/SKILL.md +0 -243
  67. package/skills/apply/SKILL.md +0 -23
  68. package/skills/archive/SKILL.md +0 -27
  69. package/skills/cerebro/SKILL.md +0 -187
  70. package/skills/cerebro/references/agents.md +0 -213
  71. package/skills/code-review/SKILL.md +0 -373
  72. package/skills/code-review/assets/report-template-agent.md +0 -212
  73. package/skills/code-review/assets/report-template-compact.md +0 -81
  74. package/skills/code-review/assets/report-template-full.md +0 -264
  75. package/skills/code-review/assets/report-template-human.md +0 -168
  76. package/skills/code-review/references/universal-patterns.md +0 -495
  77. package/skills/design-md/README.md +0 -34
  78. package/skills/design-md/SKILL.md +0 -172
  79. package/skills/design-md/examples/DESIGN.md +0 -154
  80. package/skills/design-system/SKILL.md +0 -216
  81. package/skills/design-system-generator/SKILL.md +0 -324
  82. package/skills/design-system-generator/assets/design-system-template.md +0 -348
  83. package/skills/design-system-generator/references/extraction-patterns.md +0 -321
  84. package/skills/doc-builder/SKILL.md +0 -115
  85. package/skills/doc-builder/references/ui-patterns.md +0 -394
  86. package/skills/document-explainer/SKILL.md +0 -155
  87. package/skills/document-translator/SKILL.md +0 -58
  88. package/skills/enhance/SKILL.md +0 -47
  89. package/skills/enhance-prompt/README.md +0 -34
  90. package/skills/enhance-prompt/SKILL.md +0 -204
  91. package/skills/enhance-prompt/references/KEYWORDS.md +0 -114
  92. package/skills/epic-generator/SKILL.md +0 -204
  93. package/skills/epic-single/SKILL.md +0 -63
  94. package/skills/erd-generator/SKILL.md +0 -138
  95. package/skills/feature-planner/SKILL.md +0 -305
  96. package/skills/feature-planner/assets/implementation-plan-template.md +0 -85
  97. package/skills/frontend-design/LICENSE.txt +0 -177
  98. package/skills/frontend-design/SKILL.md +0 -42
  99. package/skills/fsd-generator/SKILL.md +0 -163
  100. package/skills/gamma-builder/SKILL.md +0 -134
  101. package/skills/laravel-code-review/SKILL.md +0 -383
  102. package/skills/laravel-code-review/assets/report-template-agent.md +0 -195
  103. package/skills/laravel-code-review/assets/report-template-compact.md +0 -79
  104. package/skills/laravel-code-review/assets/report-template-full.md +0 -253
  105. package/skills/laravel-code-review/assets/report-template-human.md +0 -159
  106. package/skills/laravel-code-review/references/laravel-patterns.md +0 -571
  107. package/skills/laravel-code-review/references/php84-features.md +0 -442
  108. package/skills/mcp-builder/LICENSE.txt +0 -202
  109. package/skills/mcp-builder/SKILL.md +0 -236
  110. package/skills/mcp-builder/reference/evaluation.md +0 -602
  111. package/skills/mcp-builder/reference/mcp_best_practices.md +0 -249
  112. package/skills/mcp-builder/reference/node_mcp_server.md +0 -970
  113. package/skills/mcp-builder/reference/python_mcp_server.md +0 -719
  114. package/skills/mcp-builder/scripts/connections.py +0 -151
  115. package/skills/mcp-builder/scripts/evaluation.py +0 -373
  116. package/skills/mcp-builder/scripts/example_evaluation.xml +0 -22
  117. package/skills/mcp-builder/scripts/requirements.txt +0 -2
  118. package/skills/meeting-notes/SKILL.md +0 -159
  119. package/skills/meeting-notes/evals/evals.json +0 -23
  120. package/skills/prd-agent-generator/SKILL.md +0 -132
  121. package/skills/prd-generator/SKILL.md +0 -211
  122. package/skills/product-brief/SKILL.md +0 -141
  123. package/skills/project-orchestrator/SKILL.md +0 -487
  124. package/skills/project-orchestrator/assets/caddy-vps-setup.md +0 -180
  125. package/skills/project-orchestrator/assets/plan-summary-template.md +0 -159
  126. package/skills/prompter-specs/SKILL.md +0 -115
  127. package/skills/prompter-workflow/SKILL.md +0 -166
  128. package/skills/prompter-workflow/evals/evals.json +0 -89
  129. package/skills/proposal/SKILL.md +0 -28
  130. package/skills/qa-test-scenario/SKILL.md +0 -149
  131. package/skills/skill-creator/SKILL.md +0 -173
  132. package/skills/sph-generator/SKILL.md +0 -488
  133. package/skills/story-generator/SKILL.md +0 -285
  134. package/skills/story-single/SKILL.md +0 -86
  135. package/skills/tdd-generator/SKILL.md +0 -300
  136. package/skills/tdd-lite-generator/SKILL.md +0 -230
  137. package/skills/ui-ux-pro/SKILL.md +0 -199
  138. package/skills/ui-ux-pro/assets/design-spec-template.md +0 -173
  139. package/skills/ui-ux-pro/references/component-patterns.md +0 -255
  140. package/skills/ui-ux-pro/references/design-principles.md +0 -167
  141. package/skills/wireframe-generator/SKILL.md +0 -227
  142. package/src/cli/index.ts +0 -223
  143. package/src/commands/archive.ts +0 -302
  144. package/src/commands/change.ts +0 -292
  145. package/src/commands/config.ts +0 -233
  146. package/src/commands/guide.ts +0 -50
  147. package/src/commands/init.ts +0 -597
  148. package/src/commands/list.ts +0 -194
  149. package/src/commands/show.ts +0 -138
  150. package/src/commands/spec.ts +0 -251
  151. package/src/commands/update.ts +0 -129
  152. package/src/commands/upgrade.ts +0 -30
  153. package/src/commands/validate.ts +0 -326
  154. package/src/core/artifact-graph/graph.ts +0 -167
  155. package/src/core/artifact-graph/index.ts +0 -44
  156. package/src/core/artifact-graph/instruction-loader.ts +0 -302
  157. package/src/core/artifact-graph/resolver.ts +0 -226
  158. package/src/core/artifact-graph/schema.ts +0 -124
  159. package/src/core/artifact-graph/state.ts +0 -64
  160. package/src/core/artifact-graph/types.ts +0 -65
  161. package/src/core/completions/command-registry.ts +0 -382
  162. package/src/core/completions/completion-provider.ts +0 -128
  163. package/src/core/completions/generators/bash-generator.ts +0 -191
  164. package/src/core/completions/generators/fish-generator.ts +0 -188
  165. package/src/core/completions/generators/powershell-generator.ts +0 -223
  166. package/src/core/completions/generators/zsh-generator.ts +0 -281
  167. package/src/core/completions/templates/bash-templates.ts +0 -24
  168. package/src/core/completions/templates/fish-templates.ts +0 -40
  169. package/src/core/completions/templates/powershell-templates.ts +0 -25
  170. package/src/core/completions/templates/zsh-templates.ts +0 -36
  171. package/src/core/completions/types.ts +0 -90
  172. package/src/core/config-schema.ts +0 -230
  173. package/src/core/config.ts +0 -181
  174. package/src/core/configurators/slash/antigravity.ts +0 -10
  175. package/src/core/configurators/slash/base.ts +0 -109
  176. package/src/core/configurators/slash/claude.ts +0 -10
  177. package/src/core/configurators/slash/codex.ts +0 -10
  178. package/src/core/configurators/slash/droid.ts +0 -10
  179. package/src/core/configurators/slash/forge.ts +0 -10
  180. package/src/core/configurators/slash/github-copilot.ts +0 -10
  181. package/src/core/configurators/slash/index.ts +0 -10
  182. package/src/core/configurators/slash/kilocode.ts +0 -10
  183. package/src/core/configurators/slash/opencode.ts +0 -10
  184. package/src/core/configurators/slash/registry.ts +0 -51
  185. package/src/core/converters/json-converter.ts +0 -62
  186. package/src/core/global-config.ts +0 -136
  187. package/src/core/parsers/change-parser.ts +0 -234
  188. package/src/core/parsers/markdown-parser.ts +0 -237
  189. package/src/core/parsers/requirement-blocks.ts +0 -234
  190. package/src/core/prompt-templates.ts +0 -3504
  191. package/src/core/schemas/base.schema.ts +0 -20
  192. package/src/core/schemas/change.schema.ts +0 -42
  193. package/src/core/schemas/index.ts +0 -20
  194. package/src/core/schemas/spec.schema.ts +0 -17
  195. package/src/core/skill-discovery.ts +0 -68
  196. package/src/core/specs-apply.ts +0 -483
  197. package/src/core/styles/palette.ts +0 -8
  198. package/src/core/templates/agents-template.ts +0 -459
  199. package/src/core/templates/claude-template.ts +0 -2
  200. package/src/core/templates/index.ts +0 -3
  201. package/src/core/templates/project-template.ts +0 -32
  202. package/src/core/validation/constants.ts +0 -48
  203. package/src/core/validation/types.ts +0 -19
  204. package/src/core/validation/validator.ts +0 -449
  205. package/src/core/view.ts +0 -219
  206. package/src/index.ts +0 -1
  207. package/src/utils/change-metadata.ts +0 -171
  208. package/src/utils/change-utils.ts +0 -131
  209. package/src/utils/file-system.ts +0 -252
  210. package/src/utils/index.ts +0 -12
  211. package/src/utils/interactive.ts +0 -29
  212. package/src/utils/item-discovery.ts +0 -66
  213. package/src/utils/match.ts +0 -26
  214. package/src/utils/shell-detection.ts +0 -62
  215. package/src/utils/task-progress.ts +0 -43
  216. package/tsconfig.json +0 -28
@@ -1,970 +0,0 @@
1
- # Node/TypeScript MCP Server Implementation Guide
2
-
3
- ## Overview
4
-
5
- This document provides Node/TypeScript-specific best practices and examples for implementing MCP servers using the MCP TypeScript SDK. It covers project structure, server setup, tool registration patterns, input validation with Zod, error handling, and complete working examples.
6
-
7
- ---
8
-
9
- ## Quick Reference
10
-
11
- ### Key Imports
12
- ```typescript
13
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
14
- import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
15
- import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
16
- import express from "express";
17
- import { z } from "zod";
18
- ```
19
-
20
- ### Server Initialization
21
- ```typescript
22
- const server = new McpServer({
23
- name: "service-mcp-server",
24
- version: "1.0.0"
25
- });
26
- ```
27
-
28
- ### Tool Registration Pattern
29
- ```typescript
30
- server.registerTool(
31
- "tool_name",
32
- {
33
- title: "Tool Display Name",
34
- description: "What the tool does",
35
- inputSchema: { param: z.string() },
36
- outputSchema: { result: z.string() }
37
- },
38
- async ({ param }) => {
39
- const output = { result: `Processed: ${param}` };
40
- return {
41
- content: [{ type: "text", text: JSON.stringify(output) }],
42
- structuredContent: output // Modern pattern for structured data
43
- };
44
- }
45
- );
46
- ```
47
-
48
- ---
49
-
50
- ## MCP TypeScript SDK
51
-
52
- The official MCP TypeScript SDK provides:
53
- - `McpServer` class for server initialization
54
- - `registerTool` method for tool registration
55
- - Zod schema integration for runtime input validation
56
- - Type-safe tool handler implementations
57
-
58
- **IMPORTANT - Use Modern APIs Only:**
59
- - **DO use**: `server.registerTool()`, `server.registerResource()`, `server.registerPrompt()`
60
- - **DO NOT use**: Old deprecated APIs such as `server.tool()`, `server.setRequestHandler(ListToolsRequestSchema, ...)`, or manual handler registration
61
- - The `register*` methods provide better type safety, automatic schema handling, and are the recommended approach
62
-
63
- See the MCP SDK documentation in the references for complete details.
64
-
65
- ## Server Naming Convention
66
-
67
- Node/TypeScript MCP servers must follow this naming pattern:
68
- - **Format**: `{service}-mcp-server` (lowercase with hyphens)
69
- - **Examples**: `github-mcp-server`, `jira-mcp-server`, `stripe-mcp-server`
70
-
71
- The name should be:
72
- - General (not tied to specific features)
73
- - Descriptive of the service/API being integrated
74
- - Easy to infer from the task description
75
- - Without version numbers or dates
76
-
77
- ## Project Structure
78
-
79
- Create the following structure for Node/TypeScript MCP servers:
80
-
81
- ```
82
- {service}-mcp-server/
83
- ├── package.json
84
- ├── tsconfig.json
85
- ├── README.md
86
- ├── src/
87
- │ ├── index.ts # Main entry point with McpServer initialization
88
- │ ├── types.ts # TypeScript type definitions and interfaces
89
- │ ├── tools/ # Tool implementations (one file per domain)
90
- │ ├── services/ # API clients and shared utilities
91
- │ ├── schemas/ # Zod validation schemas
92
- │ └── constants.ts # Shared constants (API_URL, CHARACTER_LIMIT, etc.)
93
- └── dist/ # Built JavaScript files (entry point: dist/index.js)
94
- ```
95
-
96
- ## Tool Implementation
97
-
98
- ### Tool Naming
99
-
100
- Use snake_case for tool names (e.g., "search_users", "create_project", "get_channel_info") with clear, action-oriented names.
101
-
102
- **Avoid Naming Conflicts**: Include the service context to prevent overlaps:
103
- - Use "slack_send_message" instead of just "send_message"
104
- - Use "github_create_issue" instead of just "create_issue"
105
- - Use "asana_list_tasks" instead of just "list_tasks"
106
-
107
- ### Tool Structure
108
-
109
- Tools are registered using the `registerTool` method with the following requirements:
110
- - Use Zod schemas for runtime input validation and type safety
111
- - The `description` field must be explicitly provided - JSDoc comments are NOT automatically extracted
112
- - Explicitly provide `title`, `description`, `inputSchema`, and `annotations`
113
- - The `inputSchema` must be a Zod schema object (not a JSON schema)
114
- - Type all parameters and return values explicitly
115
-
116
- ```typescript
117
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
118
- import { z } from "zod";
119
-
120
- const server = new McpServer({
121
- name: "example-mcp",
122
- version: "1.0.0"
123
- });
124
-
125
- // Zod schema for input validation
126
- const UserSearchInputSchema = z.object({
127
- query: z.string()
128
- .min(2, "Query must be at least 2 characters")
129
- .max(200, "Query must not exceed 200 characters")
130
- .describe("Search string to match against names/emails"),
131
- limit: z.number()
132
- .int()
133
- .min(1)
134
- .max(100)
135
- .default(20)
136
- .describe("Maximum results to return"),
137
- offset: z.number()
138
- .int()
139
- .min(0)
140
- .default(0)
141
- .describe("Number of results to skip for pagination"),
142
- response_format: z.nativeEnum(ResponseFormat)
143
- .default(ResponseFormat.MARKDOWN)
144
- .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
145
- }).strict();
146
-
147
- // Type definition from Zod schema
148
- type UserSearchInput = z.infer<typeof UserSearchInputSchema>;
149
-
150
- server.registerTool(
151
- "example_search_users",
152
- {
153
- title: "Search Example Users",
154
- description: `Search for users in the Example system by name, email, or team.
155
-
156
- This tool searches across all user profiles in the Example platform, supporting partial matches and various search filters. It does NOT create or modify users, only searches existing ones.
157
-
158
- Args:
159
- - query (string): Search string to match against names/emails
160
- - limit (number): Maximum results to return, between 1-100 (default: 20)
161
- - offset (number): Number of results to skip for pagination (default: 0)
162
- - response_format ('markdown' | 'json'): Output format (default: 'markdown')
163
-
164
- Returns:
165
- For JSON format: Structured data with schema:
166
- {
167
- "total": number, // Total number of matches found
168
- "count": number, // Number of results in this response
169
- "offset": number, // Current pagination offset
170
- "users": [
171
- {
172
- "id": string, // User ID (e.g., "U123456789")
173
- "name": string, // Full name (e.g., "John Doe")
174
- "email": string, // Email address
175
- "team": string, // Team name (optional)
176
- "active": boolean // Whether user is active
177
- }
178
- ],
179
- "has_more": boolean, // Whether more results are available
180
- "next_offset": number // Offset for next page (if has_more is true)
181
- }
182
-
183
- Examples:
184
- - Use when: "Find all marketing team members" -> params with query="team:marketing"
185
- - Use when: "Search for John's account" -> params with query="john"
186
- - Don't use when: You need to create a user (use example_create_user instead)
187
-
188
- Error Handling:
189
- - Returns "Error: Rate limit exceeded" if too many requests (429 status)
190
- - Returns "No users found matching '<query>'" if search returns empty`,
191
- inputSchema: UserSearchInputSchema,
192
- annotations: {
193
- readOnlyHint: true,
194
- destructiveHint: false,
195
- idempotentHint: true,
196
- openWorldHint: true
197
- }
198
- },
199
- async (params: UserSearchInput) => {
200
- try {
201
- // Input validation is handled by Zod schema
202
- // Make API request using validated parameters
203
- const data = await makeApiRequest<any>(
204
- "users/search",
205
- "GET",
206
- undefined,
207
- {
208
- q: params.query,
209
- limit: params.limit,
210
- offset: params.offset
211
- }
212
- );
213
-
214
- const users = data.users || [];
215
- const total = data.total || 0;
216
-
217
- if (!users.length) {
218
- return {
219
- content: [{
220
- type: "text",
221
- text: `No users found matching '${params.query}'`
222
- }]
223
- };
224
- }
225
-
226
- // Prepare structured output
227
- const output = {
228
- total,
229
- count: users.length,
230
- offset: params.offset,
231
- users: users.map((user: any) => ({
232
- id: user.id,
233
- name: user.name,
234
- email: user.email,
235
- ...(user.team ? { team: user.team } : {}),
236
- active: user.active ?? true
237
- })),
238
- has_more: total > params.offset + users.length,
239
- ...(total > params.offset + users.length ? {
240
- next_offset: params.offset + users.length
241
- } : {})
242
- };
243
-
244
- // Format text representation based on requested format
245
- let textContent: string;
246
- if (params.response_format === ResponseFormat.MARKDOWN) {
247
- const lines = [`# User Search Results: '${params.query}'`, "",
248
- `Found ${total} users (showing ${users.length})`, ""];
249
- for (const user of users) {
250
- lines.push(`## ${user.name} (${user.id})`);
251
- lines.push(`- **Email**: ${user.email}`);
252
- if (user.team) lines.push(`- **Team**: ${user.team}`);
253
- lines.push("");
254
- }
255
- textContent = lines.join("\n");
256
- } else {
257
- textContent = JSON.stringify(output, null, 2);
258
- }
259
-
260
- return {
261
- content: [{ type: "text", text: textContent }],
262
- structuredContent: output // Modern pattern for structured data
263
- };
264
- } catch (error) {
265
- return {
266
- content: [{
267
- type: "text",
268
- text: handleApiError(error)
269
- }]
270
- };
271
- }
272
- }
273
- );
274
- ```
275
-
276
- ## Zod Schemas for Input Validation
277
-
278
- Zod provides runtime type validation:
279
-
280
- ```typescript
281
- import { z } from "zod";
282
-
283
- // Basic schema with validation
284
- const CreateUserSchema = z.object({
285
- name: z.string()
286
- .min(1, "Name is required")
287
- .max(100, "Name must not exceed 100 characters"),
288
- email: z.string()
289
- .email("Invalid email format"),
290
- age: z.number()
291
- .int("Age must be a whole number")
292
- .min(0, "Age cannot be negative")
293
- .max(150, "Age cannot be greater than 150")
294
- }).strict(); // Use .strict() to forbid extra fields
295
-
296
- // Enums
297
- enum ResponseFormat {
298
- MARKDOWN = "markdown",
299
- JSON = "json"
300
- }
301
-
302
- const SearchSchema = z.object({
303
- response_format: z.nativeEnum(ResponseFormat)
304
- .default(ResponseFormat.MARKDOWN)
305
- .describe("Output format")
306
- });
307
-
308
- // Optional fields with defaults
309
- const PaginationSchema = z.object({
310
- limit: z.number()
311
- .int()
312
- .min(1)
313
- .max(100)
314
- .default(20)
315
- .describe("Maximum results to return"),
316
- offset: z.number()
317
- .int()
318
- .min(0)
319
- .default(0)
320
- .describe("Number of results to skip")
321
- });
322
- ```
323
-
324
- ## Response Format Options
325
-
326
- Support multiple output formats for flexibility:
327
-
328
- ```typescript
329
- enum ResponseFormat {
330
- MARKDOWN = "markdown",
331
- JSON = "json"
332
- }
333
-
334
- const inputSchema = z.object({
335
- query: z.string(),
336
- response_format: z.nativeEnum(ResponseFormat)
337
- .default(ResponseFormat.MARKDOWN)
338
- .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
339
- });
340
- ```
341
-
342
- **Markdown format**:
343
- - Use headers, lists, and formatting for clarity
344
- - Convert timestamps to human-readable format
345
- - Show display names with IDs in parentheses
346
- - Omit verbose metadata
347
- - Group related information logically
348
-
349
- **JSON format**:
350
- - Return complete, structured data suitable for programmatic processing
351
- - Include all available fields and metadata
352
- - Use consistent field names and types
353
-
354
- ## Pagination Implementation
355
-
356
- For tools that list resources:
357
-
358
- ```typescript
359
- const ListSchema = z.object({
360
- limit: z.number().int().min(1).max(100).default(20),
361
- offset: z.number().int().min(0).default(0)
362
- });
363
-
364
- async function listItems(params: z.infer<typeof ListSchema>) {
365
- const data = await apiRequest(params.limit, params.offset);
366
-
367
- const response = {
368
- total: data.total,
369
- count: data.items.length,
370
- offset: params.offset,
371
- items: data.items,
372
- has_more: data.total > params.offset + data.items.length,
373
- next_offset: data.total > params.offset + data.items.length
374
- ? params.offset + data.items.length
375
- : undefined
376
- };
377
-
378
- return JSON.stringify(response, null, 2);
379
- }
380
- ```
381
-
382
- ## Character Limits and Truncation
383
-
384
- Add a CHARACTER_LIMIT constant to prevent overwhelming responses:
385
-
386
- ```typescript
387
- // At module level in constants.ts
388
- export const CHARACTER_LIMIT = 25000; // Maximum response size in characters
389
-
390
- async function searchTool(params: SearchInput) {
391
- let result = generateResponse(data);
392
-
393
- // Check character limit and truncate if needed
394
- if (result.length > CHARACTER_LIMIT) {
395
- const truncatedData = data.slice(0, Math.max(1, data.length / 2));
396
- response.data = truncatedData;
397
- response.truncated = true;
398
- response.truncation_message =
399
- `Response truncated from ${data.length} to ${truncatedData.length} items. ` +
400
- `Use 'offset' parameter or add filters to see more results.`;
401
- result = JSON.stringify(response, null, 2);
402
- }
403
-
404
- return result;
405
- }
406
- ```
407
-
408
- ## Error Handling
409
-
410
- Provide clear, actionable error messages:
411
-
412
- ```typescript
413
- import axios, { AxiosError } from "axios";
414
-
415
- function handleApiError(error: unknown): string {
416
- if (error instanceof AxiosError) {
417
- if (error.response) {
418
- switch (error.response.status) {
419
- case 404:
420
- return "Error: Resource not found. Please check the ID is correct.";
421
- case 403:
422
- return "Error: Permission denied. You don't have access to this resource.";
423
- case 429:
424
- return "Error: Rate limit exceeded. Please wait before making more requests.";
425
- default:
426
- return `Error: API request failed with status ${error.response.status}`;
427
- }
428
- } else if (error.code === "ECONNABORTED") {
429
- return "Error: Request timed out. Please try again.";
430
- }
431
- }
432
- return `Error: Unexpected error occurred: ${error instanceof Error ? error.message : String(error)}`;
433
- }
434
- ```
435
-
436
- ## Shared Utilities
437
-
438
- Extract common functionality into reusable functions:
439
-
440
- ```typescript
441
- // Shared API request function
442
- async function makeApiRequest<T>(
443
- endpoint: string,
444
- method: "GET" | "POST" | "PUT" | "DELETE" = "GET",
445
- data?: any,
446
- params?: any
447
- ): Promise<T> {
448
- try {
449
- const response = await axios({
450
- method,
451
- url: `${API_BASE_URL}/${endpoint}`,
452
- data,
453
- params,
454
- timeout: 30000,
455
- headers: {
456
- "Content-Type": "application/json",
457
- "Accept": "application/json"
458
- }
459
- });
460
- return response.data;
461
- } catch (error) {
462
- throw error;
463
- }
464
- }
465
- ```
466
-
467
- ## Async/Await Best Practices
468
-
469
- Always use async/await for network requests and I/O operations:
470
-
471
- ```typescript
472
- // Good: Async network request
473
- async function fetchData(resourceId: string): Promise<ResourceData> {
474
- const response = await axios.get(`${API_URL}/resource/${resourceId}`);
475
- return response.data;
476
- }
477
-
478
- // Bad: Promise chains
479
- function fetchData(resourceId: string): Promise<ResourceData> {
480
- return axios.get(`${API_URL}/resource/${resourceId}`)
481
- .then(response => response.data); // Harder to read and maintain
482
- }
483
- ```
484
-
485
- ## TypeScript Best Practices
486
-
487
- 1. **Use Strict TypeScript**: Enable strict mode in tsconfig.json
488
- 2. **Define Interfaces**: Create clear interface definitions for all data structures
489
- 3. **Avoid `any`**: Use proper types or `unknown` instead of `any`
490
- 4. **Zod for Runtime Validation**: Use Zod schemas to validate external data
491
- 5. **Type Guards**: Create type guard functions for complex type checking
492
- 6. **Error Handling**: Always use try-catch with proper error type checking
493
- 7. **Null Safety**: Use optional chaining (`?.`) and nullish coalescing (`??`)
494
-
495
- ```typescript
496
- // Good: Type-safe with Zod and interfaces
497
- interface UserResponse {
498
- id: string;
499
- name: string;
500
- email: string;
501
- team?: string;
502
- active: boolean;
503
- }
504
-
505
- const UserSchema = z.object({
506
- id: z.string(),
507
- name: z.string(),
508
- email: z.string().email(),
509
- team: z.string().optional(),
510
- active: z.boolean()
511
- });
512
-
513
- type User = z.infer<typeof UserSchema>;
514
-
515
- async function getUser(id: string): Promise<User> {
516
- const data = await apiCall(`/users/${id}`);
517
- return UserSchema.parse(data); // Runtime validation
518
- }
519
-
520
- // Bad: Using any
521
- async function getUser(id: string): Promise<any> {
522
- return await apiCall(`/users/${id}`); // No type safety
523
- }
524
- ```
525
-
526
- ## Package Configuration
527
-
528
- ### package.json
529
-
530
- ```json
531
- {
532
- "name": "{service}-mcp-server",
533
- "version": "1.0.0",
534
- "description": "MCP server for {Service} API integration",
535
- "type": "module",
536
- "main": "dist/index.js",
537
- "scripts": {
538
- "start": "node dist/index.js",
539
- "dev": "tsx watch src/index.ts",
540
- "build": "tsc",
541
- "clean": "rm -rf dist"
542
- },
543
- "engines": {
544
- "node": ">=18"
545
- },
546
- "dependencies": {
547
- "@modelcontextprotocol/sdk": "^1.6.1",
548
- "axios": "^1.7.9",
549
- "zod": "^3.23.8"
550
- },
551
- "devDependencies": {
552
- "@types/node": "^22.10.0",
553
- "tsx": "^4.19.2",
554
- "typescript": "^5.7.2"
555
- }
556
- }
557
- ```
558
-
559
- ### tsconfig.json
560
-
561
- ```json
562
- {
563
- "compilerOptions": {
564
- "target": "ES2022",
565
- "module": "Node16",
566
- "moduleResolution": "Node16",
567
- "lib": ["ES2022"],
568
- "outDir": "./dist",
569
- "rootDir": "./src",
570
- "strict": true,
571
- "esModuleInterop": true,
572
- "skipLibCheck": true,
573
- "forceConsistentCasingInFileNames": true,
574
- "declaration": true,
575
- "declarationMap": true,
576
- "sourceMap": true,
577
- "allowSyntheticDefaultImports": true
578
- },
579
- "include": ["src/**/*"],
580
- "exclude": ["node_modules", "dist"]
581
- }
582
- ```
583
-
584
- ## Complete Example
585
-
586
- ```typescript
587
- #!/usr/bin/env node
588
- /**
589
- * MCP Server for Example Service.
590
- *
591
- * This server provides tools to interact with Example API, including user search,
592
- * project management, and data export capabilities.
593
- */
594
-
595
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
596
- import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
597
- import { z } from "zod";
598
- import axios, { AxiosError } from "axios";
599
-
600
- // Constants
601
- const API_BASE_URL = "https://api.example.com/v1";
602
- const CHARACTER_LIMIT = 25000;
603
-
604
- // Enums
605
- enum ResponseFormat {
606
- MARKDOWN = "markdown",
607
- JSON = "json"
608
- }
609
-
610
- // Zod schemas
611
- const UserSearchInputSchema = z.object({
612
- query: z.string()
613
- .min(2, "Query must be at least 2 characters")
614
- .max(200, "Query must not exceed 200 characters")
615
- .describe("Search string to match against names/emails"),
616
- limit: z.number()
617
- .int()
618
- .min(1)
619
- .max(100)
620
- .default(20)
621
- .describe("Maximum results to return"),
622
- offset: z.number()
623
- .int()
624
- .min(0)
625
- .default(0)
626
- .describe("Number of results to skip for pagination"),
627
- response_format: z.nativeEnum(ResponseFormat)
628
- .default(ResponseFormat.MARKDOWN)
629
- .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
630
- }).strict();
631
-
632
- type UserSearchInput = z.infer<typeof UserSearchInputSchema>;
633
-
634
- // Shared utility functions
635
- async function makeApiRequest<T>(
636
- endpoint: string,
637
- method: "GET" | "POST" | "PUT" | "DELETE" = "GET",
638
- data?: any,
639
- params?: any
640
- ): Promise<T> {
641
- try {
642
- const response = await axios({
643
- method,
644
- url: `${API_BASE_URL}/${endpoint}`,
645
- data,
646
- params,
647
- timeout: 30000,
648
- headers: {
649
- "Content-Type": "application/json",
650
- "Accept": "application/json"
651
- }
652
- });
653
- return response.data;
654
- } catch (error) {
655
- throw error;
656
- }
657
- }
658
-
659
- function handleApiError(error: unknown): string {
660
- if (error instanceof AxiosError) {
661
- if (error.response) {
662
- switch (error.response.status) {
663
- case 404:
664
- return "Error: Resource not found. Please check the ID is correct.";
665
- case 403:
666
- return "Error: Permission denied. You don't have access to this resource.";
667
- case 429:
668
- return "Error: Rate limit exceeded. Please wait before making more requests.";
669
- default:
670
- return `Error: API request failed with status ${error.response.status}`;
671
- }
672
- } else if (error.code === "ECONNABORTED") {
673
- return "Error: Request timed out. Please try again.";
674
- }
675
- }
676
- return `Error: Unexpected error occurred: ${error instanceof Error ? error.message : String(error)}`;
677
- }
678
-
679
- // Create MCP server instance
680
- const server = new McpServer({
681
- name: "example-mcp",
682
- version: "1.0.0"
683
- });
684
-
685
- // Register tools
686
- server.registerTool(
687
- "example_search_users",
688
- {
689
- title: "Search Example Users",
690
- description: `[Full description as shown above]`,
691
- inputSchema: UserSearchInputSchema,
692
- annotations: {
693
- readOnlyHint: true,
694
- destructiveHint: false,
695
- idempotentHint: true,
696
- openWorldHint: true
697
- }
698
- },
699
- async (params: UserSearchInput) => {
700
- // Implementation as shown above
701
- }
702
- );
703
-
704
- // Main function
705
- // For stdio (local):
706
- async function runStdio() {
707
- if (!process.env.EXAMPLE_API_KEY) {
708
- console.error("ERROR: EXAMPLE_API_KEY environment variable is required");
709
- process.exit(1);
710
- }
711
-
712
- const transport = new StdioServerTransport();
713
- await server.connect(transport);
714
- console.error("MCP server running via stdio");
715
- }
716
-
717
- // For streamable HTTP (remote):
718
- async function runHTTP() {
719
- if (!process.env.EXAMPLE_API_KEY) {
720
- console.error("ERROR: EXAMPLE_API_KEY environment variable is required");
721
- process.exit(1);
722
- }
723
-
724
- const app = express();
725
- app.use(express.json());
726
-
727
- app.post('/mcp', async (req, res) => {
728
- const transport = new StreamableHTTPServerTransport({
729
- sessionIdGenerator: undefined,
730
- enableJsonResponse: true
731
- });
732
- res.on('close', () => transport.close());
733
- await server.connect(transport);
734
- await transport.handleRequest(req, res, req.body);
735
- });
736
-
737
- const port = parseInt(process.env.PORT || '3000');
738
- app.listen(port, () => {
739
- console.error(`MCP server running on http://localhost:${port}/mcp`);
740
- });
741
- }
742
-
743
- // Choose transport based on environment
744
- const transport = process.env.TRANSPORT || 'stdio';
745
- if (transport === 'http') {
746
- runHTTP().catch(error => {
747
- console.error("Server error:", error);
748
- process.exit(1);
749
- });
750
- } else {
751
- runStdio().catch(error => {
752
- console.error("Server error:", error);
753
- process.exit(1);
754
- });
755
- }
756
- ```
757
-
758
- ---
759
-
760
- ## Advanced MCP Features
761
-
762
- ### Resource Registration
763
-
764
- Expose data as resources for efficient, URI-based access:
765
-
766
- ```typescript
767
- import { ResourceTemplate } from "@modelcontextprotocol/sdk/types.js";
768
-
769
- // Register a resource with URI template
770
- server.registerResource(
771
- {
772
- uri: "file://documents/{name}",
773
- name: "Document Resource",
774
- description: "Access documents by name",
775
- mimeType: "text/plain"
776
- },
777
- async (uri: string) => {
778
- // Extract parameter from URI
779
- const match = uri.match(/^file:\/\/documents\/(.+)$/);
780
- if (!match) {
781
- throw new Error("Invalid URI format");
782
- }
783
-
784
- const documentName = match[1];
785
- const content = await loadDocument(documentName);
786
-
787
- return {
788
- contents: [{
789
- uri,
790
- mimeType: "text/plain",
791
- text: content
792
- }]
793
- };
794
- }
795
- );
796
-
797
- // List available resources dynamically
798
- server.registerResourceList(async () => {
799
- const documents = await getAvailableDocuments();
800
- return {
801
- resources: documents.map(doc => ({
802
- uri: `file://documents/${doc.name}`,
803
- name: doc.name,
804
- mimeType: "text/plain",
805
- description: doc.description
806
- }))
807
- };
808
- });
809
- ```
810
-
811
- **When to use Resources vs Tools:**
812
- - **Resources**: For data access with simple URI-based parameters
813
- - **Tools**: For complex operations requiring validation and business logic
814
- - **Resources**: When data is relatively static or template-based
815
- - **Tools**: When operations have side effects or complex workflows
816
-
817
- ### Transport Options
818
-
819
- The TypeScript SDK supports two main transport mechanisms:
820
-
821
- #### Streamable HTTP (Recommended for Remote Servers)
822
-
823
- ```typescript
824
- import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
825
- import express from "express";
826
-
827
- const app = express();
828
- app.use(express.json());
829
-
830
- app.post('/mcp', async (req, res) => {
831
- // Create new transport for each request (stateless, prevents request ID collisions)
832
- const transport = new StreamableHTTPServerTransport({
833
- sessionIdGenerator: undefined,
834
- enableJsonResponse: true
835
- });
836
-
837
- res.on('close', () => transport.close());
838
-
839
- await server.connect(transport);
840
- await transport.handleRequest(req, res, req.body);
841
- });
842
-
843
- app.listen(3000);
844
- ```
845
-
846
- #### stdio (For Local Integrations)
847
-
848
- ```typescript
849
- import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
850
-
851
- const transport = new StdioServerTransport();
852
- await server.connect(transport);
853
- ```
854
-
855
- **Transport selection:**
856
- - **Streamable HTTP**: Web services, remote access, multiple clients
857
- - **stdio**: Command-line tools, local development, subprocess integration
858
-
859
- ### Notification Support
860
-
861
- Notify clients when server state changes:
862
-
863
- ```typescript
864
- // Notify when tools list changes
865
- server.notification({
866
- method: "notifications/tools/list_changed"
867
- });
868
-
869
- // Notify when resources change
870
- server.notification({
871
- method: "notifications/resources/list_changed"
872
- });
873
- ```
874
-
875
- Use notifications sparingly - only when server capabilities genuinely change.
876
-
877
- ---
878
-
879
- ## Code Best Practices
880
-
881
- ### Code Composability and Reusability
882
-
883
- Your implementation MUST prioritize composability and code reuse:
884
-
885
- 1. **Extract Common Functionality**:
886
- - Create reusable helper functions for operations used across multiple tools
887
- - Build shared API clients for HTTP requests instead of duplicating code
888
- - Centralize error handling logic in utility functions
889
- - Extract business logic into dedicated functions that can be composed
890
- - Extract shared markdown or JSON field selection & formatting functionality
891
-
892
- 2. **Avoid Duplication**:
893
- - NEVER copy-paste similar code between tools
894
- - If you find yourself writing similar logic twice, extract it into a function
895
- - Common operations like pagination, filtering, field selection, and formatting should be shared
896
- - Authentication/authorization logic should be centralized
897
-
898
- ## Building and Running
899
-
900
- Always build your TypeScript code before running:
901
-
902
- ```bash
903
- # Build the project
904
- npm run build
905
-
906
- # Run the server
907
- npm start
908
-
909
- # Development with auto-reload
910
- npm run dev
911
- ```
912
-
913
- Always ensure `npm run build` completes successfully before considering the implementation complete.
914
-
915
- ## Quality Checklist
916
-
917
- Before finalizing your Node/TypeScript MCP server implementation, ensure:
918
-
919
- ### Strategic Design
920
- - [ ] Tools enable complete workflows, not just API endpoint wrappers
921
- - [ ] Tool names reflect natural task subdivisions
922
- - [ ] Response formats optimize for agent context efficiency
923
- - [ ] Human-readable identifiers used where appropriate
924
- - [ ] Error messages guide agents toward correct usage
925
-
926
- ### Implementation Quality
927
- - [ ] FOCUSED IMPLEMENTATION: Most important and valuable tools implemented
928
- - [ ] All tools registered using `registerTool` with complete configuration
929
- - [ ] All tools include `title`, `description`, `inputSchema`, and `annotations`
930
- - [ ] Annotations correctly set (readOnlyHint, destructiveHint, idempotentHint, openWorldHint)
931
- - [ ] All tools use Zod schemas for runtime input validation with `.strict()` enforcement
932
- - [ ] All Zod schemas have proper constraints and descriptive error messages
933
- - [ ] All tools have comprehensive descriptions with explicit input/output types
934
- - [ ] Descriptions include return value examples and complete schema documentation
935
- - [ ] Error messages are clear, actionable, and educational
936
-
937
- ### TypeScript Quality
938
- - [ ] TypeScript interfaces are defined for all data structures
939
- - [ ] Strict TypeScript is enabled in tsconfig.json
940
- - [ ] No use of `any` type - use `unknown` or proper types instead
941
- - [ ] All async functions have explicit Promise<T> return types
942
- - [ ] Error handling uses proper type guards (e.g., `axios.isAxiosError`, `z.ZodError`)
943
-
944
- ### Advanced Features (where applicable)
945
- - [ ] Resources registered for appropriate data endpoints
946
- - [ ] Appropriate transport configured (stdio or streamable HTTP)
947
- - [ ] Notifications implemented for dynamic server capabilities
948
- - [ ] Type-safe with SDK interfaces
949
-
950
- ### Project Configuration
951
- - [ ] Package.json includes all necessary dependencies
952
- - [ ] Build script produces working JavaScript in dist/ directory
953
- - [ ] Main entry point is properly configured as dist/index.js
954
- - [ ] Server name follows format: `{service}-mcp-server`
955
- - [ ] tsconfig.json properly configured with strict mode
956
-
957
- ### Code Quality
958
- - [ ] Pagination is properly implemented where applicable
959
- - [ ] Large responses check CHARACTER_LIMIT constant and truncate with clear messages
960
- - [ ] Filtering options are provided for potentially large result sets
961
- - [ ] All network operations handle timeouts and connection errors gracefully
962
- - [ ] Common functionality is extracted into reusable functions
963
- - [ ] Return types are consistent across similar operations
964
-
965
- ### Testing and Build
966
- - [ ] `npm run build` completes successfully without errors
967
- - [ ] dist/index.js created and executable
968
- - [ ] Server runs: `node dist/index.js --help`
969
- - [ ] All imports resolve correctly
970
- - [ ] Sample tool calls work as expected