├── .gitignore ├── .release-please-manifest.json ├── eslint.config.mjs ├── tests └── McpClient.test.ts ├── tsconfig.json ├── src ├── tools │ ├── McpToolListResponse.ts │ ├── McpToolsListResponse.ts │ ├── McpToolContent.ts │ └── McpToolCallResponse.ts ├── prompts │ ├── McpPromptListResponse.ts │ ├── McpPromptMessage.ts │ ├── McpPromptsListResponse.ts │ └── McpPromptGetResponse.ts ├── resources │ ├── McpResourceListResponse.ts │ ├── McpResourcesListResponse.ts │ ├── McpResourcesReadResponseContent.ts │ └── McpResourcesReadResponse.ts ├── resource-templates │ ├── McpResourceTemplateListResponse.ts │ └── McpResourceTemplatesListResponse.ts ├── index.ts └── McpClient.ts ├── release-please-config.json ├── package.json ├── .github └── workflows │ └── ci.yml ├── CHANGELOG.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | dist/ 3 | -------------------------------------------------------------------------------- /.release-please-manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | ".": "0.7.0" 3 | } 4 | -------------------------------------------------------------------------------- /eslint.config.mjs: -------------------------------------------------------------------------------- 1 | import eslintConfigCodely from "eslint-config-codely"; 2 | 3 | export default [...eslintConfigCodely.ts]; 4 | -------------------------------------------------------------------------------- /tests/McpClient.test.ts: -------------------------------------------------------------------------------- 1 | describe("McpClient", () => { 2 | it("should", () => { 3 | expect(true).toBe(true); 4 | }); 5 | }); 6 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "ESNext", 5 | "moduleResolution": "node", 6 | "strict": true, 7 | "skipLibCheck": true, 8 | "esModuleInterop": true, 9 | "allowSyntheticDefaultImports": true, 10 | "experimentalDecorators": true, 11 | "outDir": "dist/", 12 | "declaration": true, 13 | "removeComments": true, 14 | "sourceMap": true 15 | }, 16 | "include": ["src/**/*.ts", "tests/**/*.ts"], 17 | "exclude": ["node_modules"] 18 | } 19 | -------------------------------------------------------------------------------- /src/tools/McpToolListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpToolListResponse { 4 | constructor( 5 | public readonly name: string, 6 | public readonly title: string, 7 | public readonly description: string, 8 | public readonly inputSchema: object, 9 | ) {} 10 | 11 | static fromPrimitives(tool: Primitives): McpToolListResponse { 12 | return new McpToolListResponse(tool.name, tool.title, tool.description, tool.inputSchema); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/prompts/McpPromptListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpPromptListResponse { 4 | constructor( 5 | public readonly name: string, 6 | public readonly title: string, 7 | public readonly description: string, 8 | public readonly args: object, 9 | ) {} 10 | 11 | static fromPrimitives(prompt: Primitives): McpPromptListResponse { 12 | return new McpPromptListResponse(prompt.name, prompt.title, prompt.description, prompt.args); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/prompts/McpPromptMessage.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpPromptMessage { 4 | constructor( 5 | public readonly role: "user" | "assistant", 6 | public readonly content: { type: string; text: string }, 7 | ) {} 8 | 9 | static fromPrimitives(message: Primitives): McpPromptMessage { 10 | return new McpPromptMessage(message.role, message.content); 11 | } 12 | 13 | toPrimitives(): Primitives { 14 | return { 15 | role: this.role, 16 | content: this.content, 17 | }; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/resources/McpResourceListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpResourceListResponse { 4 | constructor( 5 | public readonly uri: string, 6 | public readonly name: string, 7 | public readonly title: string, 8 | public readonly description: string, 9 | ) {} 10 | 11 | static fromPrimitives(resource: Primitives): McpResourceListResponse { 12 | return new McpResourceListResponse( 13 | resource.uri, 14 | resource.name, 15 | resource.title, 16 | resource.description, 17 | ); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/tools/McpToolsListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpToolListResponse } from "./McpToolListResponse"; 4 | 5 | export class McpToolsListResponse { 6 | constructor(public readonly tools: McpToolListResponse[]) {} 7 | 8 | static fromPrimitives(primitives: Primitives): McpToolsListResponse { 9 | return new McpToolsListResponse( 10 | primitives.tools.map((tool) => McpToolListResponse.fromPrimitives(tool)), 11 | ); 12 | } 13 | 14 | names(): string[] { 15 | return this.tools.map((tool) => tool.name); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /release-please-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "packages": { 3 | ".": { 4 | "changelog-path": "CHANGELOG.md", 5 | "release-type": "node", 6 | "pull-request-title-pattern": "chore: release ${version}", 7 | "pull-request-header": "🍄 Release bump", 8 | "bump-minor-pre-major": true, 9 | "bump-patch-for-minor-pre-major": false, 10 | "draft": false, 11 | "prerelease": false, 12 | "include-v-in-tag": true, 13 | "include-component-in-tag": false 14 | } 15 | }, 16 | "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json" 17 | } 18 | -------------------------------------------------------------------------------- /src/prompts/McpPromptsListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpPromptListResponse } from "./McpPromptListResponse"; 4 | 5 | export class McpPromptsListResponse { 6 | constructor(public readonly prompts: McpPromptListResponse[]) {} 7 | 8 | static fromPrimitives(primitives: Primitives): McpPromptsListResponse { 9 | return new McpPromptsListResponse( 10 | primitives.prompts.map((prompt) => McpPromptListResponse.fromPrimitives(prompt)), 11 | ); 12 | } 13 | 14 | names(): string[] { 15 | return this.prompts.map((prompt) => prompt.name); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/resources/McpResourcesListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpResourceListResponse } from "./McpResourceListResponse"; 4 | 5 | export class McpResourcesListResponse { 6 | constructor(public readonly resources: McpResourceListResponse[]) {} 7 | 8 | static fromPrimitives( 9 | primitives: Primitives, 10 | ): McpResourcesListResponse { 11 | return new McpResourcesListResponse( 12 | primitives.resources.map((resource) => McpResourceListResponse.fromPrimitives(resource)), 13 | ); 14 | } 15 | 16 | uris(): string[] { 17 | return this.resources.map((resource) => resource.uri); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/resource-templates/McpResourceTemplateListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpResourceTemplateListResponse { 4 | constructor( 5 | public readonly name: string, 6 | public readonly title: string, 7 | public readonly uriTemplate: string, 8 | public readonly description: string, 9 | ) {} 10 | 11 | static fromPrimitives( 12 | resourceTemplate: Primitives, 13 | ): McpResourceTemplateListResponse { 14 | return new McpResourceTemplateListResponse( 15 | resourceTemplate.name, 16 | resourceTemplate.title, 17 | resourceTemplate.uriTemplate, 18 | resourceTemplate.description, 19 | ); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/prompts/McpPromptGetResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpPromptMessage } from "./McpPromptMessage"; 4 | 5 | export class McpPromptGetResponse { 6 | constructor(public readonly messages: McpPromptMessage[]) {} 7 | 8 | static fromPrimitives(primitives: Primitives): McpPromptGetResponse { 9 | return new McpPromptGetResponse( 10 | primitives.messages.map((message) => McpPromptMessage.fromPrimitives(message)), 11 | ); 12 | } 13 | 14 | toPrimitives(): Primitives { 15 | return { 16 | messages: this.messages.map((message) => message.toPrimitives()), 17 | }; 18 | } 19 | 20 | firstPromptText(): string { 21 | return this.messages[0].content.text; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/resource-templates/McpResourceTemplatesListResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpResourceTemplateListResponse } from "./McpResourceTemplateListResponse"; 4 | 5 | export class McpResourceTemplatesListResponse { 6 | constructor(public readonly resourceTemplates: McpResourceTemplateListResponse[]) {} 7 | 8 | static fromPrimitives( 9 | primitives: Primitives, 10 | ): McpResourceTemplatesListResponse { 11 | return new McpResourceTemplatesListResponse( 12 | primitives.resourceTemplates.map((resourceTemplate) => 13 | McpResourceTemplateListResponse.fromPrimitives(resourceTemplate), 14 | ), 15 | ); 16 | } 17 | 18 | uris(): string[] { 19 | return this.resourceTemplates.map((resource) => resource.uriTemplate); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/resources/McpResourcesReadResponseContent.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpResourcesReadResponseContent { 4 | constructor( 5 | public readonly uri: string, 6 | public readonly mimeType?: string, 7 | public readonly text?: string, 8 | public readonly blob?: string, 9 | ) {} 10 | 11 | static fromPrimitives( 12 | content: Primitives, 13 | ): McpResourcesReadResponseContent { 14 | return new McpResourcesReadResponseContent( 15 | content.uri, 16 | content.mimeType, 17 | content.text, 18 | content.blob, 19 | ); 20 | } 21 | 22 | toPrimitives(): Primitives { 23 | return { 24 | uri: this.uri, 25 | mimeType: this.mimeType, 26 | text: this.text, 27 | blob: this.blob, 28 | }; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/tools/McpToolContent.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | export class McpToolContent { 4 | constructor( 5 | public readonly type: "text" | "image" | "resource", 6 | public readonly text?: string, 7 | public readonly data?: string, 8 | public readonly mimeType?: string, 9 | public readonly resource?: { 10 | uri: string; 11 | text?: string; 12 | mimeType?: string; 13 | }, 14 | ) {} 15 | 16 | static fromPrimitives(content: Primitives): McpToolContent { 17 | return new McpToolContent( 18 | content.type, 19 | content.text, 20 | content.data, 21 | content.mimeType, 22 | content.resource, 23 | ); 24 | } 25 | 26 | toPrimitives(): Primitives { 27 | return { 28 | type: this.type, 29 | text: this.text, 30 | data: this.data, 31 | mimeType: this.mimeType, 32 | resource: this.resource, 33 | }; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/tools/McpToolCallResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpToolContent } from "./McpToolContent"; 4 | 5 | export class McpToolCallResponse { 6 | constructor( 7 | public readonly content: McpToolContent[], 8 | public readonly structuredContent?: Record, 9 | public readonly isError?: boolean, 10 | ) {} 11 | 12 | static fromPrimitives(primitives: Primitives): McpToolCallResponse { 13 | return new McpToolCallResponse( 14 | primitives.content.map((content) => McpToolContent.fromPrimitives(content)), 15 | primitives.structuredContent, 16 | primitives.isError, 17 | ); 18 | } 19 | 20 | toPrimitives(): Primitives { 21 | return { 22 | content: this.content.map((content) => content.toPrimitives()), 23 | structuredContent: this.structuredContent, 24 | isError: this.isError, 25 | }; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export { McpClient } from "./McpClient"; 2 | export { McpPromptGetResponse } from "./prompts/McpPromptGetResponse"; 3 | export { McpPromptListResponse } from "./prompts/McpPromptListResponse"; 4 | export { McpPromptMessage } from "./prompts/McpPromptMessage"; 5 | export { McpPromptsListResponse } from "./prompts/McpPromptsListResponse"; 6 | export { McpResourceTemplateListResponse } from "./resource-templates/McpResourceTemplateListResponse"; 7 | export { McpResourceTemplatesListResponse } from "./resource-templates/McpResourceTemplatesListResponse"; 8 | export { McpResourceListResponse } from "./resources/McpResourceListResponse"; 9 | export { McpResourcesListResponse } from "./resources/McpResourcesListResponse"; 10 | export { McpResourcesReadResponse } from "./resources/McpResourcesReadResponse"; 11 | export { McpResourcesReadResponseContent } from "./resources/McpResourcesReadResponseContent"; 12 | export { McpToolCallResponse } from "./tools/McpToolCallResponse"; 13 | export { McpToolContent } from "./tools/McpToolContent"; 14 | export { McpToolListResponse } from "./tools/McpToolListResponse"; 15 | export { McpToolsListResponse } from "./tools/McpToolsListResponse"; 16 | -------------------------------------------------------------------------------- /src/resources/McpResourcesReadResponse.ts: -------------------------------------------------------------------------------- 1 | import { Primitives } from "@codelytv/primitives-type"; 2 | 3 | import { McpResourcesReadResponseContent } from "./McpResourcesReadResponseContent"; 4 | 5 | type McpError = { 6 | code: number; 7 | message: string; 8 | data?: unknown; 9 | }; 10 | 11 | export class McpResourcesReadResponse { 12 | constructor( 13 | public readonly contents?: McpResourcesReadResponseContent[], 14 | public readonly error?: McpError, 15 | ) {} 16 | 17 | static fromPrimitives( 18 | primitives: Primitives, 19 | ): McpResourcesReadResponse { 20 | if (primitives.error) { 21 | return new McpResourcesReadResponse(undefined, primitives.error); 22 | } 23 | 24 | return new McpResourcesReadResponse( 25 | primitives.contents?.map((content) => 26 | McpResourcesReadResponseContent.fromPrimitives(content), 27 | ), 28 | ); 29 | } 30 | 31 | static fromError(error: McpError): McpResourcesReadResponse { 32 | return new McpResourcesReadResponse(undefined, error); 33 | } 34 | 35 | toPrimitives(): Primitives { 36 | if (this.error) { 37 | return { error: this.error }; 38 | } 39 | 40 | return { 41 | contents: this.contents?.map((content) => content.toPrimitives()) ?? [], 42 | }; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@codelytv/mcp-client", 3 | "version": "0.7.0", 4 | "description": "A typed TypeScript client for Model Context Protocol (MCP) servers", 5 | "keywords": [ 6 | "mcp", 7 | "model-context-protocol", 8 | "testing", 9 | "typescript" 10 | ], 11 | "scripts": { 12 | "build": "tsc", 13 | "lint": "eslint src eslint.config.mjs", 14 | "lint:fix": "npm run lint -- --fix", 15 | "clean": "rm -rf dist" 16 | }, 17 | "main": "dist/src/index.js", 18 | "types": "dist/src/index.d.ts", 19 | "repository": { 20 | "type": "git", 21 | "url": "git+https://github.com/CodelyTV/typescript-mcp-test-client" 22 | }, 23 | "author": "codelytv", 24 | "license": "GPL-3.0", 25 | "bugs": { 26 | "url": "https://github.com/CodelyTV/typescript-mcp-client/issues" 27 | }, 28 | "homepage": "https://github.com/CodelyTV/typescript-mcp-client#readme", 29 | "dependencies": { 30 | "@codelytv/primitives-type": "^3.1.0", 31 | "@modelcontextprotocol/sdk": "^1.17.2" 32 | }, 33 | "devDependencies": { 34 | "@types/jest": "^29.5.14", 35 | "@typescript-eslint/eslint-plugin": "^8.23.0", 36 | "@typescript-eslint/parser": "^8.23.0", 37 | "eslint": "^8.56.0", 38 | "eslint-config-codely": "^4.4.0", 39 | "eslint-import-resolver-typescript": "^3.7.0", 40 | "jest": "^29.7.0", 41 | "prettier": "^3.4.2", 42 | "ts-jest": "^29.2.5", 43 | "typescript": "^5.8.3" 44 | }, 45 | "eslintIgnore": [ 46 | "dist/**/*" 47 | ] 48 | } 49 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json 2 | name: CI 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | lint-test: 11 | name: 🚀 Lint and test 12 | runs-on: ubuntu-latest 13 | timeout-minutes: 5 14 | steps: 15 | - uses: actions/checkout@v4 16 | - uses: actions/setup-node@v4 17 | with: 18 | node-version: lts/* 19 | cache: npm 20 | - name: 📥 Install dependencies 21 | run: npm install 22 | - name: 💅 Lint code style 23 | run: npm run lint 24 | - name: 💻 Build 25 | run: npm run build 26 | 27 | publish: 28 | if: github.ref == 'refs/heads/main' && github.event_name == 'push' 29 | name: 📦 Publish 30 | runs-on: ubuntu-latest 31 | needs: lint-test 32 | timeout-minutes: 5 33 | permissions: 34 | # Needed by googleapis/release-please-action@v4 35 | contents: write 36 | pull-requests: write 37 | # Needed by `npm publish --provenance` 38 | id-token: write 39 | steps: 40 | - name: 🍄 Bump package version, create GitHub release, and update changelog 41 | uses: googleapis/release-please-action@v4 42 | id: release 43 | - uses: actions/checkout@v4 44 | if: ${{ steps.release.outputs.release_created }} 45 | - uses: actions/setup-node@v4 46 | if: ${{ steps.release.outputs.release_created }} 47 | with: 48 | node-version: lts/* 49 | cache: npm 50 | registry-url: https://registry.npmjs.org 51 | - name: 🚀 Publish to npm 52 | if: ${{ steps.release.outputs.release_created }} 53 | run: | 54 | npm install 55 | npm run build --if-present 56 | npm publish --access public 57 | env: 58 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 59 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## [0.7.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.6.0...v0.7.0) (2025-08-26) 4 | 5 | 6 | ### Features 7 | 8 | * rename to mcp-client ([#8](https://github.com/CodelyTV/typescript-mcp-client/issues/8)) ([dd8753b](https://github.com/CodelyTV/typescript-mcp-client/commit/dd8753be4afa37cfd15152c520d731e142cb62f0)) 9 | 10 | ## [0.6.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.5.0...v0.6.0) (2025-08-26) 11 | 12 | 13 | ### Features 14 | 15 | * rename to mcp-client ([#6](https://github.com/CodelyTV/typescript-mcp-client/issues/6)) ([97a0e35](https://github.com/CodelyTV/typescript-mcp-client/commit/97a0e350f06900cea7af0e8a88660615cc416586)) 16 | 17 | ## [0.5.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.4.0...v0.5.0) (2025-08-18) 18 | 19 | 20 | ### Features 21 | 22 | * export in one level ([c37fe6f](https://github.com/CodelyTV/typescript-mcp-client/commit/c37fe6ff8c1c81fc9e9c734dbe8793695e4cbda2)) 23 | 24 | ## [0.4.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.3.0...v0.4.0) (2025-08-18) 25 | 26 | 27 | ### Features 28 | 29 | * disable provenance while the repo is private ([42f75a7](https://github.com/CodelyTV/typescript-mcp-client/commit/42f75a7ed8aab71725f620d056a6a02f5b0125a8)) 30 | 31 | ## [0.3.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.2.0...v0.3.0) (2025-08-18) 32 | 33 | 34 | ### Features 35 | 36 | * export using subfolders ([2f57fa6](https://github.com/CodelyTV/typescript-mcp-client/commit/2f57fa6a1739b5a1cac82ff2fa9a29a1599e92e4)) 37 | 38 | ## [0.2.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.1.0...v0.2.0) (2025-08-18) 39 | 40 | 41 | ### Features 42 | 43 | * add initial version ([e1366aa](https://github.com/CodelyTV/typescript-mcp-client/commit/e1366aaba676d3a29ec14a5a2a880d9e1fb8bf2a)) 44 | 45 | ## [0.1.0](https://github.com/CodelyTV/typescript-mcp-client/compare/v0.0.1...v0.1.0) (2025-08-18) 46 | 47 | 48 | ### Features 49 | 50 | * add initial version ([e1366aa](https://github.com/CodelyTV/typescript-mcp-client/commit/e1366aaba676d3a29ec14a5a2a880d9e1fb8bf2a)) 51 | 52 | ## Changelog 53 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | Codely logo 4 | 5 |

6 | 7 |

8 | 🔌 MCP Client 9 |

10 | 11 |

12 | Codely Open Source 13 | CodelyTV Courses 14 |

15 | 16 |

17 | A TypeScript test client for Model Context Protocol (MCP) servers that provides a convenient way to test MCP functionality in your test suites. 18 |
19 |
20 | Take a look, play and have fun with this. 21 | Stars are welcome 😊 22 |

23 | 24 | 25 | # ⬇️ Installation 26 | 27 | ```bash 28 | npm install --save-dev @codelytv/mcp-client 29 | ``` 30 | 31 | # 💻 Usage 32 | 33 | ## Basic Example 34 | 35 | ```typescript 36 | import { McpClient } from '@codelytv/mcp-client'; 37 | 38 | const mcpClient = new McpClient("stdio", [ 39 | "npx", 40 | "ts-node", 41 | "./src/app/mcp/server.ts", 42 | ]); 43 | 44 | await mcpClient.connect(); 45 | 46 | // List available tools 47 | const tools = await mcpClient.listTools(); 48 | console.log('Available tools:', tools.names()); 49 | 50 | // Call a tool 51 | const response = await mcpClient.callTool('search-course-by-id', { id: 'course-123' }); 52 | 53 | // List resources 54 | const resources = await mcpClient.listResources(); 55 | console.log('Available resources:', resources.uris()); 56 | 57 | // Read a resource 58 | const resource = await mcpClient.readResource('courses://all'); 59 | 60 | await mcpClient.disconnect(); 61 | ``` 62 | 63 | ## HTTP Transport 64 | 65 | ```typescript 66 | const mcpClient = new McpClient("http", ["http://localhost:3000/mcp"]); 67 | ``` 68 | 69 | # 🔡 API 70 | 71 | ## McpClient 72 | 73 | The main client class for interacting with MCP servers. 74 | 75 | ### Constructor 76 | 77 | - `new McpClient(transport: "stdio" | "http", args: string[])` 78 | 79 | ### Methods 80 | 81 | - `connect()` - Connect to the MCP server 82 | - `disconnect()` - Disconnect from the MCP server 83 | - `listTools()` - List available tools 84 | - `callTool(name: string, args?: Record)` - Call a tool 85 | - `listResources()` - List available resources 86 | - `readResource(uri: string)` - Read a resource 87 | - `listResourceTemplates()` - List resource templates 88 | - `completeResourceTemplateParam(uri: string, paramName: string, textToComplete: string)` - Complete resource template parameters 89 | - `listPrompts()` - List available prompts 90 | - `getPrompt(name: string, args?: Record)` - Get a prompt 91 | 92 | # 👌 Codely Code Quality Standards 93 | 94 | Publishing this package we are committing ourselves to the following code quality standards: 95 | 96 | - 🤝 Respect **Semantic Versioning**: No breaking changes in patch or minor versions 97 | - 🤏 No surprises in transitive dependencies: Use the **bare minimum dependencies** needed to meet the purpose 98 | - 🎯 **One specific purpose** to meet without having to carry a bunch of unnecessary other utilities 99 | - ✅ **Tests** as documentation and usage examples 100 | - 📖 **Well documented ReadMe** showing how to install and use 101 | - ⚖️ **License favoring Open Source** and collaboration 102 | 103 | # ⚖️ License 104 | 105 | See [LICENSE](LICENSE) 106 | -------------------------------------------------------------------------------- /src/McpClient.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable @typescript-eslint/no-explicit-any */ 2 | import { Primitives } from "@codelytv/primitives-type"; 3 | import { Client } from "@modelcontextprotocol/sdk/client/index"; 4 | import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio"; 5 | import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp"; 6 | import { Transport } from "@modelcontextprotocol/sdk/shared/transport"; 7 | 8 | import { McpPromptGetResponse } from "./prompts/McpPromptGetResponse"; 9 | import { McpPromptsListResponse } from "./prompts/McpPromptsListResponse"; 10 | import { McpResourceTemplatesListResponse } from "./resource-templates/McpResourceTemplatesListResponse"; 11 | import { McpResourcesListResponse } from "./resources/McpResourcesListResponse"; 12 | import { McpResourcesReadResponse } from "./resources/McpResourcesReadResponse"; 13 | import { McpToolCallResponse } from "./tools/McpToolCallResponse"; 14 | import { McpToolsListResponse } from "./tools/McpToolsListResponse"; 15 | 16 | export class McpClient { 17 | private readonly client: Client; 18 | private readonly transport: Transport; 19 | 20 | constructor( 21 | transport: "stdio" | "http", 22 | private readonly args: string[], 23 | ) { 24 | this.client = new Client( 25 | { 26 | name: "mcp-client", 27 | version: "1.0.0", 28 | }, 29 | { 30 | capabilities: { 31 | resources: {}, 32 | tools: {}, 33 | prompts: {}, 34 | }, 35 | }, 36 | ); 37 | 38 | if (transport === "stdio") { 39 | this.transport = new StdioClientTransport({ 40 | command: this.args[0], 41 | args: this.args.slice(1), 42 | }); 43 | } else { 44 | this.transport = new StreamableHTTPClientTransport(new URL(this.args[0])); 45 | } 46 | } 47 | 48 | async connect(): Promise { 49 | await this.client.connect(this.transport); 50 | } 51 | 52 | async disconnect(): Promise { 53 | await this.client.close(); 54 | } 55 | 56 | async listTools(): Promise { 57 | const response = await this.client.listTools(); 58 | 59 | return McpToolsListResponse.fromPrimitives(response as Primitives); 60 | } 61 | 62 | async listResources(): Promise { 63 | const response = await this.client.listResources(); 64 | 65 | return McpResourcesListResponse.fromPrimitives( 66 | response as Primitives, 67 | ); 68 | } 69 | 70 | async listResourceTemplates(): Promise { 71 | const response = await this.client.listResourceTemplates(); 72 | 73 | return McpResourceTemplatesListResponse.fromPrimitives( 74 | response as Primitives, 75 | ); 76 | } 77 | 78 | async completeResourceTemplateParam( 79 | uri: string, 80 | paramName: string, 81 | textToComplete: string, 82 | ): Promise { 83 | const response = await this.client.complete({ 84 | ref: { 85 | type: `ref/resource`, 86 | uri, 87 | }, 88 | argument: { 89 | name: paramName, 90 | value: textToComplete, 91 | }, 92 | }); 93 | 94 | return response.completion.values; 95 | } 96 | 97 | async readResource(uri: string): Promise { 98 | const response = await this.client.readResource({ uri }); 99 | 100 | return McpResourcesReadResponse.fromPrimitives( 101 | response as Primitives, 102 | ); 103 | } 104 | 105 | async callTool(name: string, args: Record = {}): Promise { 106 | const response = await this.client.callTool({ 107 | name, 108 | arguments: args, 109 | }); 110 | 111 | return McpToolCallResponse.fromPrimitives(response as Primitives); 112 | } 113 | 114 | async listPrompts(): Promise { 115 | const response = await this.client.listPrompts(); 116 | 117 | return McpPromptsListResponse.fromPrimitives({ 118 | prompts: response.prompts.map((prompt: any) => ({ 119 | name: prompt.name, 120 | title: prompt.title ?? "", 121 | description: prompt.description ?? "", 122 | args: prompt.arguments ?? {}, 123 | })), 124 | }); 125 | } 126 | 127 | async getPrompt(name: string, args: Record = {}): Promise { 128 | const response = await this.client.getPrompt({ 129 | name, 130 | arguments: Object.fromEntries( 131 | Object.entries(args).map(([key, value]) => [key, String(value)]), 132 | ), 133 | }); 134 | 135 | return McpPromptGetResponse.fromPrimitives({ 136 | messages: response.messages.map((message: any) => ({ 137 | role: message.role, 138 | content: 139 | message.content.type === "text" 140 | ? { 141 | type: message.content.type, 142 | text: message.content.text, 143 | } 144 | : message.content, 145 | })), 146 | }); 147 | } 148 | } 149 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2022 Codely Enseña y Entretiene SL. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------