-
Notifications
You must be signed in to change notification settings - Fork 202
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #163 from modelcontextprotocol/ashwin/claudemd
Add CLAUDE.md with SDK development guide
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# MCP TypeScript SDK Guide | ||
|
||
## Build & Test Commands | ||
``` | ||
npm run build # Build ESM and CJS versions | ||
npm run lint # Run ESLint | ||
npm test # Run all tests | ||
npx jest path/to/file.test.ts # Run specific test file | ||
npx jest -t "test name" # Run tests matching pattern | ||
``` | ||
|
||
## Code Style Guidelines | ||
- **TypeScript**: Strict type checking, ES modules, explicit return types | ||
- **Naming**: PascalCase for classes/types, camelCase for functions/variables | ||
- **Files**: Lowercase with hyphens, test files with `.test.ts` suffix | ||
- **Imports**: ES module style, include `.js` extension, group imports logically | ||
- **Error Handling**: Use TypeScript's strict mode, explicit error checking in tests | ||
- **Formatting**: 2-space indentation, semicolons required, single quotes preferred | ||
- **Testing**: Co-locate tests with source files, use descriptive test names | ||
- **Comments**: JSDoc for public APIs, inline comments for complex logic | ||
|
||
## Project Structure | ||
- `/src`: Source code with client, server, and shared modules | ||
- Tests alongside source files with `.test.ts` suffix | ||
- Node.js >= 18 required |