File tree Expand file tree Collapse file tree 2 files changed +51
-6
lines changed Expand file tree Collapse file tree 2 files changed +51
-6
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing to MCP TypeScript SDK
2
+
3
+ We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project.
4
+
5
+ ## Getting Started
6
+
7
+ 1 . Fork the repository
8
+ 2 . Clone your fork: ` git clone https://github.com/YOUR-USERNAME/typescript-sdk.git `
9
+ 3 . Install dependencies: ` npm install `
10
+ 4 . Build the project: ` npm run build `
11
+ 5 . Run tests: ` npm test `
12
+
13
+ ## Development Process
14
+
15
+ 1 . Create a new branch for your changes
16
+ 2 . Make your changes
17
+ 3 . Run ` npm run lint ` to ensure code style compliance
18
+ 4 . Run ` npm test ` to verify all tests pass
19
+ 5 . Submit a pull request
20
+
21
+ ## Pull Request Guidelines
22
+
23
+ - Follow the existing code style
24
+ - Include tests for new functionality
25
+ - Update documentation as needed
26
+ - Keep changes focused and atomic
27
+ - Provide a clear description of changes
28
+
29
+ ## Running Examples
30
+
31
+ - Start the server: ` npm run server `
32
+ - Run the client: ` npm run client `
33
+
34
+ ## Code of Conduct
35
+
36
+ This project follows our [ Code of Conduct] ( CODE_OF_CONDUCT.md ) . Please review it before contributing.
37
+
38
+ ## Reporting Issues
39
+
40
+ - Use the [ GitHub issue tracker] ( https://github.com/modelcontextprotocol/typescript-sdk/issues )
41
+ - Search existing issues before creating a new one
42
+ - Provide clear reproduction steps
43
+
44
+ ## Security Issues
45
+
46
+ Please review our [ Security Policy] ( SECURITY.md ) for reporting security vulnerabilities.
47
+
48
+ ## License
49
+
50
+ By contributing, you agree that your contributions will be licensed under the MIT License.
Original file line number Diff line number Diff line change 1
1
# MCP TypeScript SDK ![ NPM Version] ( https://img.shields.io/npm/v/%40modelcontextprotocol%2Fsdk )
2
2
3
- TypeScript implementation of the Model Context Protocol (MCP), providing both client and server capabilities for integrating with LLM surfaces.
3
+ TypeScript implementation of the [ Model Context Protocol] ( https://modelcontextprotocol.io ) (MCP), providing both client and server capabilities for integrating with LLM surfaces.
4
4
5
5
## Overview
6
6
@@ -96,11 +96,6 @@ const transport = new StdioServerTransport();
96
96
await server .connect (transport );
97
97
```
98
98
99
- ## Documentation
100
-
101
- - [ MCP Specification] ( https://modelcontextprotocol.github.io )
102
- - [ Example Servers] ( https://github.com/modelcontextprotocol/example-servers )
103
-
104
99
## Contributing
105
100
106
101
Issues and pull requests are welcome on GitHub at https://github.com/modelcontextprotocol/typescript-sdk .
You can’t perform that action at this time.
0 commit comments