From e4a5b437e9247e1a88d17a5cc4cb9731d45f9c02 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 15:20:30 +0000 Subject: [PATCH 1/2] Add CONTRIBUTING.md --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ace9542 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to MCP TypeScript SDK + +We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project. + +## Getting Started + +1. Fork the repository +2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/typescript-sdk.git` +3. Install dependencies: `npm install` +4. Build the project: `npm run build` +5. Run tests: `npm test` + +## Development Process + +1. Create a new branch for your changes +2. Make your changes +3. Run `npm run lint` to ensure code style compliance +4. Run `npm test` to verify all tests pass +5. Submit a pull request + +## Pull Request Guidelines + +- Follow the existing code style +- Include tests for new functionality +- Update documentation as needed +- Keep changes focused and atomic +- Provide a clear description of changes + +## Running Examples + +- Start the server: `npm run server` +- Run the client: `npm run client` + +## Code of Conduct + +This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it before contributing. + +## Reporting Issues + +- Use the [GitHub issue tracker](https://github.com/modelcontextprotocol/typescript-sdk/issues) +- Search existing issues before creating a new one +- Provide clear reproduction steps + +## Security Issues + +Please review our [Security Policy](SECURITY.md) for reporting security vulnerabilities. + +## License + +By contributing, you agree that your contributions will be licensed under the MIT License. From 28cc5af325dac6eeb21bced68cee913c7855d609 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 15:20:36 +0000 Subject: [PATCH 2/2] Fix README links --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 034c18f..e774a10 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MCP TypeScript SDK ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fsdk) -TypeScript implementation of the Model Context Protocol (MCP), providing both client and server capabilities for integrating with LLM surfaces. +TypeScript implementation of the [Model Context Protocol](https://modelcontextprotocol.io) (MCP), providing both client and server capabilities for integrating with LLM surfaces. ## Overview @@ -96,11 +96,6 @@ const transport = new StdioServerTransport(); await server.connect(transport); ``` -## Documentation - -- [MCP Specification](https://modelcontextprotocol.github.io) -- [Example Servers](https://github.com/modelcontextprotocol/example-servers) - ## Contributing Issues and pull requests are welcome on GitHub at https://github.com/modelcontextprotocol/typescript-sdk.