mcp-ts-template 1.1.6

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Casey Hand @cyanheads
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,233 @@
+# MCP TypeScript Template 🚀
+
+[![TypeScript](https://img.shields.io/badge/TypeScript-^5.8.3-blue.svg)](https://www.typescriptlang.org/)
+[![Model Context Protocol SDK](https://img.shields.io/badge/MCP%20SDK-1.11.0-green.svg)](https://github.com/modelcontextprotocol/typescript-sdk)
+[![MCP Spec Version](https://img.shields.io/badge/MCP%20Spec-2025--03--26-lightgrey.svg)](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/changelog.mdx)
+[![Version](https://img.shields.io/badge/Version-1.1.5-blue.svg)](./CHANGELOG.md)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Status](https://img.shields.io/badge/Status-Stable-green.svg)](https://github.com/cyanheads/mcp-ts-template/issues)
+[![GitHub](https://img.shields.io/github/stars/cyanheads/mcp-ts-template?style=social)](https://github.com/cyanheads/mcp-ts-template)
+
+**Jumpstart your [Model Context Protocol (MCP) Client & Server](https://modelcontextprotocol.io/) development with this TypeScript Repo Template!**
+
+This template provides a solid, beginner-friendly foundation for building robust MCP servers and clients, adhering to the **MCP 2025-03-26 specification**. It includes production-ready utilities, a well-structured codebase, working examples, and clear documentation to get you up and running quickly.
+
+Whether you're creating a new MCP server to extend an AI's capabilities or integrating MCP client features into your application, this template is your starting point.
+
+## ✨ Key Features
+
+| Feature Area                | Description                                                                                                                      | Key Components / Location                                                      |
+| :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- |
+| **🔌 MCP Server**           | Functional server example with Echo Tool & Resource. Supports `stdio` and `http` (SSE) transports.                               | `src/mcp-server/`                                                              |
+| **💻 MCP Client**           | Working client aligned with **MCP 2025-03-26 spec**. Connects via `mcp-config.json`. Includes detailed comments.                 | `src/mcp-client/`                                                              |
+| **🚀 Production Utilities** | Logging, Error Handling, ID Generation, Rate Limiting, Request Context tracking, Input Sanitization.                             | `src/utils/`                                                                   |
+| **🔒 Type Safety/Security** | Strong type checking via TypeScript & Zod validation. Built-in security utilities (sanitization, auth middleware stub for HTTP). | Throughout, `src/utils/security/`, `src/mcp-server/transports/authentication/` |
+| **⚙️ Error Handling**       | Consistent error categorization (`BaseErrorCode`), detailed logging, centralized handling (`ErrorHandler`).                      | `src/utils/internal/errorHandler.ts`, `src/types-global/`                      |
+| **📚 Documentation**        | Comprehensive `README.md`, inline JSDoc comments.                                                                                | `README.md`, Codebase                                                          |
+| **🤖 Agent Ready**          | Includes a [.clinerules](.clinerules) developer cheatsheet tailored for LLM coding agents.                                       | `.clinerules`                                                                  |
+| **🛠️ Utility Scripts**      | Scripts for cleaning builds, setting executable permissions, generating directory trees, and fetching OpenAPI specs.             | `scripts/`                                                                     |
+
+_For a more granular breakdown, see the [Detailed Features Table](#detailed-features-table) below._
+
+## 🚀 Projects Using This Template
+
+This template is already powering several MCP servers, demonstrating its flexibility and robustness:
+
+| Project                                                                                                   | Description                                                                                                                                                                                                                  | Status / Notes                                                                                                                           |
+| :-------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
+| [**git-mcp-server**](https://github.com/cyanheads/git-mcp-server)                                         | Provides an enterprise-ready MCP interface for Git operations. Allows LLM agents to initialize, clone, branch, commit, and manage repositories via STDIO & Streamable HTTP.                                                  | Actively using this template.                                                                                                            |
+| [**obsidian-mcp-server**](https://github.com/cyanheads/obsidian-mcp-server/tree/mcp-ts-template-refactor) | Enables LLMs to interact securely with Obsidian vaults via MCP. Offers token-aware tools for searching, navigating, and updating Obsidian notes, facilitating seamless knowledge base management with Properties management. | Refactor in progress using this template ([see branch](https://github.com/cyanheads/obsidian-mcp-server/tree/mcp-ts-template-refactor)). |
+| [**filesystem-mcp-server**](https://github.com/cyanheads/filesystem-mcp-server)                           | Offers platform-agnostic file system capabilities for AI agents via MCP. Enables reading, writing, updating, and managing files/directories, featuring advanced search/replace and directory traversal.                      | Actively using this template.                                                                                                            |
+
+_Note: [**toolkit-mcp-server**](https://github.com/cyanheads/toolkit-mcp-server) and [**atlas-mcp-server**](https://github.com/cyanheads/atlas-mcp-server) were initially built using an older version of this template and are pending updates to the latest structure._
+
+You can also **see my [GitHub profile](https://github.com/cyanheads/)** for additional MCP servers I've created, many of which are planned to be migrated to or built upon this template in the future.
+
+## 📋 Table of Contents
+
+[✨ Key Features](#-key-features) | [🚀 Projects Using This Template](#-projects-using-this-template) | [🚀 Quick Start](#quick-start) | [⚙️ Configuration](#️-configuration) | [Server Configuration](#server-configuration-environment-variables) | [Client Configuration](#client-configuration-mcp-configjson) | [🏗️ Project Structure](#️-project-structure) | [🧩 Adding Tools/Resources](#-adding-your-own-tools--resources) | [🌍 More MCP Resources](#-explore-more-mcp-resources) | [📜 License](#-license) | [Detailed Features](#detailed-features-table)
+
+## Quick Start
+
+Get the example server running in minutes:
+
+1.  **Clone the repository:**
+
+    ```bash
+    git clone https://github.com/cyanheads/mcp-ts-template.git
+    cd mcp-ts-template
+    ```
+
+2.  **Install dependencies:**
+
+    ```bash
+    npm install
+    ```
+
+3.  **Build the project:**
+
+    ```bash
+    npm run build
+    # Or use 'npm run rebuild' for a clean install (deletes node_modules, logs, dist)
+    ```
+
+4.  **Run the Example Server:**
+
+    - **Via Stdio (Default):** Many MCP host applications will run this automatically using `stdio`. To run manually for testing:
+      ```bash
+      npm start
+      # or 'npm run start:stdio'
+      ```
+    - **Via HTTP (SSE):**
+      ```bash
+      npm run start:http
+      ```
+      This starts an HTTP server (default: `http://127.0.0.1:3010`) using Server-Sent Events. The port, host, and allowed origins are configurable via environment variables (see [Configuration](#configuration)).
+
+## ⚙️ Configuration
+
+### Server Configuration (Environment Variables)
+
+Configure the MCP server's behavior using these environment variables:
+
+| Variable              | Description                                                                                         | Default                                |
+| :-------------------- | :-------------------------------------------------------------------------------------------------- | :------------------------------------- |
+| `MCP_TRANSPORT_TYPE`  | Server transport: `stdio` or `http`.                                                                | `stdio`                                |
+| `MCP_HTTP_PORT`       | Port for the HTTP server (if `MCP_TRANSPORT_TYPE=http`).                                            | `3010`                                 |
+| `MCP_HTTP_HOST`       | Host address for the HTTP server (if `MCP_TRANSPORT_TYPE=http`).                                    | `127.0.0.1`                            |
+| `MCP_ALLOWED_ORIGINS` | Comma-separated allowed origins for CORS (if `MCP_TRANSPORT_TYPE=http`).                            | (none)                                 |
+| `MCP_SERVER_NAME`     | Optional server name (used in MCP initialization).                                                  | (from package.json)                    |
+| `MCP_SERVER_VERSION`  | Optional server version (used in MCP initialization).                                               | (from package.json)                    |
+| `MCP_LOG_LEVEL`       | Server logging level (`debug`, `info`, `warning`, `error`, etc.).                                   | `info`                                 |
+| `NODE_ENV`            | Runtime environment (`development`, `production`).                                                  | `development`                          |
+| `MCP_AUTH_SECRET_KEY` | **Required for HTTP transport.** Secret key (min 32 chars) for signing/verifying auth tokens (JWT). | (none - **MUST be set in production**) |
+
+**Note on HTTP Port Retries:** If the `MCP_HTTP_PORT` is busy, the server automatically tries the next port (up to 15 times).
+
+**Security Note for HTTP Transport:** When using `MCP_TRANSPORT_TYPE=http`, authentication is **mandatory** as per the MCP specification. This template includes JWT-based authentication middleware (`src/mcp-server/transports/authentication/authMiddleware.ts`). You **MUST** set a strong, unique `MCP_AUTH_SECRET_KEY` in your production environment for this security mechanism to function correctly. Failure to do so will result in bypassed authentication checks in development and fatal errors in production.
+
+### Client Configuration (`mcp-config.json`)
+
+Configure the connections for the built-in **MCP client** using `src/mcp-client/mcp-config.json`. If this file is missing, it falls back to `src/mcp-client/mcp-config.json.example`.
+
+This file defines external MCP servers the client can connect to. The client implementation adheres to the **MCP 2025-03-26 specification**.
+
+**Example `mcp-config.json` (see `mcp-config.json.example` for the full version):**
+
+```json
+{
+  "mcpServers": {
+    "my-stdio-server": {
+      "command": "node", // Command or executable
+      "args": ["/path/to/my-server/index.js"], // Arguments for stdio
+      "env": { "LOG_LEVEL": "debug" }, // Optional environment variables
+      "transportType": "stdio" // Explicitly stdio (or omit for default)
+    },
+    "my-http-server": {
+      "command": "http://localhost:8080", // Base URL for HTTP
+      "args": [], // Not used for HTTP
+      "env": {}, // Not used for HTTP
+      "transportType": "http" // Explicitly http
+    }
+    // ... add other servers
+  }
+}
+```
+
+- **`command`**: Executable path (`stdio`) or Base URL (`http`).
+- **`args`**: Array of arguments (required for `stdio`).
+- **`env`**: Optional environment variables to set for the server process (`stdio`).
+- **`transportType`**: `stdio` (default) or `http`.
+
+See `src/mcp-client/configLoader.ts` for the Zod validation schema and `src/mcp-client/mcp-config.json.example` for a complete example.
+
+## 🏗️ Project Structure
+
+The `src/` directory is organized for clarity:
+
+- `config/`: Loads environment variables and package info.
+- `mcp-client/`: Logic for the client connecting to _external_ MCP servers (updated to MCP 2025-03-26 spec).
+  - `client.ts`: Core connection management, initialization, capability declaration.
+  - `configLoader.ts`: Loads and validates `mcp-config.json`.
+  - `transport.ts`: Creates `stdio` or `http` client transports based on config.
+  - `mcp-config.json.example`: Example client config. Copy to `mcp-config.json`.
+- `mcp-server/`: Logic for the MCP server _provided by this template_.
+  - `server.ts`: Initializes the server, registers tools/resources.
+  - `resources/`: Example resource implementations (e.g., EchoResource).
+  - `tools/`: Example tool implementations (e.g., EchoTool).
+  - `transports/`: Handles `stdio` and `http` communication for the server.
+- `types-global/`: Shared TypeScript definitions (Errors, MCP types).
+- `utils/`: Reusable utilities (logging, errors, security, parsing, etc.). Exported via `index.ts`.
+
+**Explore the structure yourself:**
+
+```bash
+npm run tree
+```
+
+(This uses `scripts/tree.ts` to generate a current file tree.)
+
+## 🧩 Adding Your Own Tools & Resources
+
+This template is designed for extension! Follow the high-level SDK patterns:
+
+1.  **Create Directories**: Add new directories under `src/mcp-server/tools/yourToolName/` or `src/mcp-server/resources/yourResourceName/`.
+2.  **Implement Logic (`logic.ts`)**: Define Zod schemas for inputs/outputs and write your core processing function.
+3.  **Register (`registration.ts`)**:
+    - **Tools**: Use `server.tool(name, description, zodSchemaShape, handler)` (SDK v1.10.2+). This handles schema generation, validation, and routing. Remember to add relevant annotations (`readOnlyHint`, `destructiveHint`, etc.) as untrusted hints.
+    - **Resources**: Use `server.resource(regName, template, metadata, handler)`.
+    - Wrap logic in `ErrorHandler.tryCatch` for robust error handling.
+4.  **Export & Import**: Export the registration function from your new directory's `index.ts` and call it within `createMcpServerInstance` in `src/mcp-server/server.ts`.
+
+Refer to the included `EchoTool` and `EchoResource` examples and the [.clinerules](.clinerules) cheatsheet for detailed patterns.
+
+## 🌍 Explore More MCP Resources
+
+Looking for more examples, guides, and pre-built MCP servers? Check out the companion repository:
+
+➡️ **[cyanheads/model-context-protocol-resources](https://github.com/cyanheads/model-context-protocol-resources)**
+
+This collection includes servers for Filesystem, Obsidian, Git, GitHub, Perplexity, Atlas, Ntfy, and more, along with in-depth guides based on my real-world MCP development.
+
+## 📜 License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
+
+## Detailed Features Table
+
+| Category                 | Feature                         | Description                                                                                                  | Location(s)                                      |
+| :----------------------- | :------------------------------ | :----------------------------------------------------------------------------------------------------------- | :----------------------------------------------- |
+| **Core Components**      | MCP Server                      | Core server logic, tool/resource registration, transport handling. Includes Echo Tool & Resource examples.   | `src/mcp-server/`                                |
+|                          | MCP Client                      | Logic for connecting to external MCP servers (updated to **MCP 2025-03-26 spec**).                           | `src/mcp-client/`                                |
+|                          | Configuration                   | Environment-aware settings with Zod validation.                                                              | `src/config/`, `src/mcp-client/configLoader.ts`  |
+|                          | HTTP Transport                  | Express-based server with SSE, session management, CORS, port retries.                                       | `src/mcp-server/transports/httpTransport.ts`     |
+|                          | Stdio Transport                 | Handles MCP communication over standard input/output.                                                        | `src/mcp-server/transports/stdioTransport.ts`    |
+| **Utilities (Core)**     | Logger                          | Structured, context-aware logging (files & MCP notifications).                                               | `src/utils/internal/logger.ts`                   |
+|                          | ErrorHandler                    | Centralized error processing, classification, and logging.                                                   | `src/utils/internal/errorHandler.ts`             |
+|                          | RequestContext                  | Request/operation tracking and correlation.                                                                  | `src/utils/internal/requestContext.ts`           |
+| **Utilities (Metrics)**  | TokenCounter                    | Estimates token counts using `tiktoken`.                                                                     | `src/utils/metrics/tokenCounter.ts`              |
+| **Utilities (Parsing)**  | DateParser                      | Parses natural language date strings using `chrono-node`.                                                    | `src/utils/parsing/dateParser.ts`                |
+|                          | JsonParser                      | Parses potentially partial JSON, handles `<think>` blocks.                                                   | `src/utils/parsing/jsonParser.ts`                |
+| **Utilities (Security)** | IdGenerator                     | Generates unique IDs (prefixed or UUIDs).                                                                    | `src/utils/security/idGenerator.ts`              |
+|                          | RateLimiter                     | Request throttling based on keys.                                                                            | `src/utils/security/rateLimiter.ts`              |
+|                          | Sanitization                    | Input validation/cleaning (HTML, paths, URLs, numbers, JSON) & log redaction (`validator`, `sanitize-html`). | `src/utils/security/sanitization.ts`             |
+| **Type Safety**          | Global Types                    | Shared TypeScript definitions for consistent interfaces (Errors, MCP types).                                 | `src/types-global/`                              |
+|                          | Zod Schemas                     | Used for robust validation of configuration files and tool/resource inputs.                                  | Throughout (`config`, `mcp-client`, tools, etc.) |
+| **Error Handling**       | Pattern-Based Classification    | Automatically categorize errors based on message patterns.                                                   | `src/utils/internal/errorHandler.ts`             |
+|                          | Consistent Formatting           | Standardized error responses with additional context.                                                        | `src/utils/internal/errorHandler.ts`             |
+|                          | Safe Try/Catch Patterns         | Centralized error processing helpers (`ErrorHandler.tryCatch`).                                              | `src/utils/internal/errorHandler.ts`             |
+|                          | Client/Transport Error Handling | Specific handlers for MCP client and transport error handling.                                               | `src/mcp-client/client.ts`, `transport.ts`       |
+| **Security**             | Input Validation                | Using `validator` and `zod` for various data type checks.                                                    | `src/utils/security/sanitization.ts`, etc.       |
+|                          | Input Sanitization              | Using `sanitize-html` to prevent injection attacks.                                                          | `src/utils/security/sanitization.ts`             |
+|                          | Sensitive Data Redaction        | Automatic redaction in logs.                                                                                 | `src/utils/security/sanitization.ts`             |
+|                          | Configuration Fallback          | Safely falls back to `mcp-config.json.example` if primary client config is missing.                          | `src/mcp-client/configLoader.ts`                 |
+| **Scripts**              | Clean Script                    | Removes `dist` and `logs` directories (or custom targets).                                                   | `scripts/clean.ts`                               |
+|                          | Make Executable Script          | Sets executable permissions (`chmod +x`) on specified files (Unix-like only).                                | `scripts/make-executable.ts`                     |
+|                          | Tree Script                     | Generates a directory structure tree, respecting `.gitignore`.                                               | `scripts/tree.ts`                                |
+|                          | Fetch OpenAPI Spec Script       | Fetches an OpenAPI spec (YAML/JSON) from a URL with fallbacks, saves locally.                                | `scripts/fetch-openapi-spec.ts`                  |
+
+---
+
+<div align="center">
+Built with ❤️ and the <a href="https://modelcontextprotocol.io/">Model Context Protocol</a>
+</div>

package/dist/config/index.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Main application configuration object.
+ * Aggregates settings from environment variables and package.json.
+ */
+export declare const config: {
+    /**
+     * The name of the MCP server.
+     * Prioritizes MCP_SERVER_NAME env var, falls back to package.json name.
+     * Default: 'mcp-ts-template' (from package.json)
+     */
+    mcpServerName: string;
+    /**
+     * The version of the MCP server.
+     * Prioritizes MCP_SERVER_VERSION env var, falls back to package.json version.
+     * Default: (from package.json)
+     */
+    mcpServerVersion: string;
+    /**
+     * Logging level for the application (e.g., "debug", "info", "warning", "error").
+     * Controlled by MCP_LOG_LEVEL env var.
+     * Default: "info"
+     */
+    logLevel: string;
+    /**
+     * The runtime environment (e.g., "development", "production").
+     * Controlled by NODE_ENV env var.
+     * Default: "development"
+     */
+    environment: string;
+    /**
+     * Specifies the transport mechanism for the server.
+     * Controlled by MCP_TRANSPORT_TYPE env var. Options: 'stdio', 'http'.
+     * Default: "stdio"
+     */
+    mcpTransportType: "stdio" | "http";
+    /**
+     * The port number for the HTTP server to listen on (if MCP_TRANSPORT_TYPE is 'http').
+     * Controlled by MCP_HTTP_PORT env var.
+     * Default: 3010
+     */
+    mcpHttpPort: number;
+    /**
+     * The host address for the HTTP server to bind to (if MCP_TRANSPORT_TYPE is 'http').
+     * Controlled by MCP_HTTP_HOST env var.
+     * Default: "127.0.0.1"
+     */
+    mcpHttpHost: string;
+    /**
+     * Comma-separated list of allowed origins for CORS requests when using the 'http' transport.
+     * Controlled by MCP_ALLOWED_ORIGINS env var.
+     * Default: undefined (meaning CORS might be restrictive by default in the transport layer)
+     */
+    mcpAllowedOrigins: string[] | undefined;
+    /**
+     * A secret key used for signing and verifying authentication tokens (e.g., JWT).
+     * MUST be set in production for HTTP transport security.
+     * Controlled by MCP_AUTH_SECRET_KEY env var.
+     * Default: undefined (Auth middleware should throw error if not set in production)
+     */
+    mcpAuthSecretKey: string | undefined;
+};
+/**
+ * The configured logging level for the application.
+ * Exported separately for convenience (e.g., logger initialization).
+ * @type {string}
+ */
+export declare const logLevel: string;
+/**
+ * The configured runtime environment for the application.
+ * Exported separately for convenience.
+ * @type {string}
+ */
+export declare const environment: string;

package/dist/config/index.js

@@ -0,0 +1,125 @@
+import dotenv from "dotenv";
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { z } from 'zod';
+dotenv.config(); // Load environment variables from .env file
+// Determine the directory name of the current module
+const __dirname = dirname(fileURLToPath(import.meta.url));
+// Construct the path to package.json relative to the current file
+const pkgPath = join(__dirname, '../../package.json');
+// Default package information in case package.json is unreadable
+let pkg = { name: 'mcp-ts-template', version: '0.0.0' };
+try {
+    // Read and parse package.json to get default server name and version
+    pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+}
+catch (error) {
+    // Silently use default pkg info if reading fails.
+    // Consider adding logging here if robust error handling is needed.
+    if (process.stdout.isTTY) {
+        console.error("Warning: Could not read package.json for default config values.", error);
+    }
+}
+// Define a schema for environment variables for validation and type safety
+const EnvSchema = z.object({
+    MCP_SERVER_NAME: z.string().optional(),
+    MCP_SERVER_VERSION: z.string().optional(),
+    MCP_LOG_LEVEL: z.string().default("info"),
+    NODE_ENV: z.string().default("development"),
+    MCP_TRANSPORT_TYPE: z.enum(['stdio', 'http']).default('stdio'),
+    MCP_HTTP_PORT: z.coerce.number().int().positive().default(3010), // Updated default port
+    MCP_HTTP_HOST: z.string().default('127.0.0.1'),
+    MCP_ALLOWED_ORIGINS: z.string().optional(), // Comma-separated string
+    MCP_AUTH_SECRET_KEY: z.string().min(32, "MCP_AUTH_SECRET_KEY must be at least 32 characters long for security").optional(), // Secret for signing/verifying tokens
+});
+// Parse and validate environment variables
+const parsedEnv = EnvSchema.safeParse(process.env);
+if (!parsedEnv.success) {
+    if (process.stdout.isTTY) {
+        console.error("❌ Invalid environment variables:", parsedEnv.error.flatten().fieldErrors);
+    }
+    // Decide if the application should exit or continue with defaults
+    // For critical configs, you might want to throw an error:
+    // throw new Error("Invalid environment configuration.");
+    // For now, we'll log the error and proceed with defaults where possible.
+}
+const env = parsedEnv.success ? parsedEnv.data : EnvSchema.parse({}); // Use defaults on failure
+/**
+ * Main application configuration object.
+ * Aggregates settings from environment variables and package.json.
+ */
+export const config = {
+    /**
+     * The name of the MCP server.
+     * Prioritizes MCP_SERVER_NAME env var, falls back to package.json name.
+     * Default: 'mcp-ts-template' (from package.json)
+     */
+    mcpServerName: env.MCP_SERVER_NAME || pkg.name,
+    /**
+     * The version of the MCP server.
+     * Prioritizes MCP_SERVER_VERSION env var, falls back to package.json version.
+     * Default: (from package.json)
+     */
+    mcpServerVersion: env.MCP_SERVER_VERSION || pkg.version,
+    /**
+     * Logging level for the application (e.g., "debug", "info", "warning", "error").
+     * Controlled by MCP_LOG_LEVEL env var.
+     * Default: "info"
+     */
+    logLevel: env.MCP_LOG_LEVEL,
+    /**
+     * The runtime environment (e.g., "development", "production").
+     * Controlled by NODE_ENV env var.
+     * Default: "development"
+     */
+    environment: env.NODE_ENV,
+    /**
+     * Specifies the transport mechanism for the server.
+     * Controlled by MCP_TRANSPORT_TYPE env var. Options: 'stdio', 'http'.
+     * Default: "stdio"
+     */
+    mcpTransportType: env.MCP_TRANSPORT_TYPE,
+    /**
+     * The port number for the HTTP server to listen on (if MCP_TRANSPORT_TYPE is 'http').
+     * Controlled by MCP_HTTP_PORT env var.
+     * Default: 3010
+     */
+    mcpHttpPort: env.MCP_HTTP_PORT,
+    /**
+     * The host address for the HTTP server to bind to (if MCP_TRANSPORT_TYPE is 'http').
+     * Controlled by MCP_HTTP_HOST env var.
+     * Default: "127.0.0.1"
+     */
+    mcpHttpHost: env.MCP_HTTP_HOST,
+    /**
+     * Comma-separated list of allowed origins for CORS requests when using the 'http' transport.
+     * Controlled by MCP_ALLOWED_ORIGINS env var.
+     * Default: undefined (meaning CORS might be restrictive by default in the transport layer)
+     */
+    mcpAllowedOrigins: env.MCP_ALLOWED_ORIGINS?.split(',').map(origin => origin.trim()).filter(Boolean),
+    /**
+     * A secret key used for signing and verifying authentication tokens (e.g., JWT).
+     * MUST be set in production for HTTP transport security.
+     * Controlled by MCP_AUTH_SECRET_KEY env var.
+     * Default: undefined (Auth middleware should throw error if not set in production)
+     */
+    mcpAuthSecretKey: env.MCP_AUTH_SECRET_KEY,
+    // Note: mcpClient configuration is loaded separately via src/mcp-client/configLoader.ts
+    // Note: Logger-specific configurations (LOG_FILE_PATH, LOG_MAX_FILES, etc.)
+    //       are typically handled directly within the logger utility (src/utils/internal/logger.ts)
+};
+/**
+ * The configured logging level for the application.
+ * Exported separately for convenience (e.g., logger initialization).
+ * @type {string}
+ */
+export const logLevel = config.logLevel;
+/**
+ * The configured runtime environment for the application.
+ * Exported separately for convenience.
+ * @type {string}
+ */
+export const environment = config.environment;
+// Logger initialization and validation logic should occur at the application entry point (e.g., src/index.ts)
+// after configuration is loaded.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};