@ythalorossy/openfda 1.0.11 → 1.0.13

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Ythalo Saldanha
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 Ythalo Saldanha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE. 

package/README.md

@@ -1,87 +1,84 @@
-# OpenFDA MCP Server
-
-A Model Context Protocol (MCP) server for querying drug information from the OpenFDA API.
-
-## Features
-
-- Retrieve drug label information by brand name
-- Retrieve drug information by generic (active ingredient) name
-- Get all brand versions of a generic drug
-- Get adverse event (side effect) reports for a drug (by brand or generic name)
-- Retrieve all drugs manufactured by a specific company
-- Get comprehensive drug safety information (warnings, contraindications, interactions, precautions, etc.)
-- Normalize and validate NDC (National Drug Code) formats
-- Helpful error messages and suggestions for failed queries
-
-1. **Set up your OpenFDA API Key**
-
-   The MCP server requires an OpenFDA API key to access the OpenFDA API.  
-   Create a `.env` file in the root of your project and add the following line:
-
-   ```env
-   OPENFDA_API_KEY=your_openfda_api_key_here
-   ```
-
-   > **Note:** Never commit your real API key to version control.  
-   > You can obtain an API key from [OpenFDA API Key Registration](https://open.fda.gov/apis/authentication/).
-
-2. **Example MCP Server Configuration**
-
-   If you are integrating this server with a larger MCP system, your configuration might look like:
-
-   ```json
-   {
-     "mcpServers": {
-       "openfda": {
-         "command": "npx",
-         "args": ["@ythalorossy/openfda"],
-         "env": {
-           "OPENFDA_API_KEY": "************"
-         },
-         "timeout": 60000
-       }
-     }
-   }
-   ```
-
-   Replace the asterisks with your actual API key, or ensure it is loaded from your `.env` file.
-
-## Want to run it local?
-
-```bash
-git clone https://github.com/ythalorossy/openfda.git
-cd openfda
-npm install
-```
-
-## Usage
-
-First, build the project:
-
-```bash
-npm run build
-```
-
-Then, start the server from the build folder:
-
-```bash
-node build/index.js
-```
-
-**Key Points:**
-- The build step (`npm run build`) compiles your source files into the build/ directory.
-- You should run the compiled output (e.g., `build/bin/index.js`), not the source file (`bin/index.js`), unless your project is set up to run directly from source.
-
-
-## Configuration
-
-Create a `.env` file for any required environment variables.
-
-## License
-
-MIT 
-
-
-[Buy me a Coffee](https://buymeacoffee.com/ythalorossy)
-
-![coff.ee/ythalorossy](https://raw.githubusercontent.com/ythalorossy/openfda/refs/heads/main/bmc_qr.png "Buy me a Coffee")
+# OpenFDA MCP Server
+
+A Model Context Protocol (MCP) server for querying drug information from the OpenFDA API.
+
+<a href="https://glama.ai/mcp/servers/@ythalorossy/openfda">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/@ythalorossy/openfda/badge" alt="OpenFDA MCP server" />
+</a>
+
+## Features
+
+- Retrieve drug label information by brand name
+- Retrieve drug information by generic (active ingredient) name
+- Get all brand versions of a generic drug
+- Get adverse event (side effect) reports for a drug (by brand or generic name)
+- Retrieve all drugs manufactured by a specific company
+- Get comprehensive drug safety information (warnings, contraindications, interactions, precautions, etc.)
+- Normalize and validate NDC (National Drug Code) formats
+- Helpful error messages and suggestions for failed queries
+
+1. **Set up your OpenFDA API Key**
+
+   The MCP server requires an OpenFDA API key to access the OpenFDA API.  
+   Create a `.env` file in the root of your project and add the following line:
+
+   ```env
+   OPENFDA_API_KEY=your_openfda_api_key_here
+   ```
+
+   > **Note:** Never commit your real API key to version control.  
+   > You can obtain an API key from [OpenFDA API Key Registration](https://open.fda.gov/apis/authentication/).
+
+2. **Example MCP Server Configuration**
+
+   If you are integrating this server with a larger MCP system, your configuration might look like:
+
+   ```json
+   {
+     "mcpServers": {
+       "openfda": {
+         "command": "npx",
+         "args": ["@ythalorossy/openfda"],
+         "env": {
+           "OPENFDA_API_KEY": "************"
+         },
+         "timeout": 60000
+       }
+     }
+   }
+   ```
+
+   Replace the asterisks with your actual API key, or ensure it is loaded from your `.env` file.
+
+## Want to run it locally?
+
+```bash
+git clone https://github.com/ythalorossy/openfda.git
+cd openfda
+npm install
+npm run build
+```
+
+Then start the server:
+
+```bash
+node bin/index.js
+```
+
+Or use it directly with npx:
+
+```bash
+npx @ythalorossy/openfda
+```
+
+## Configuration
+
+Create a `.env` file for any required environment variables.
+
+## License
+
+MIT 
+
+[Buy me a Coffee](https://buymeacoffee.com/ythalorossy)
+
+![coff.ee/ythalorossy](https://raw.githubusercontent.com/ythalorossy/openfda/refs/heads/main/bmc_qr.png "Buy me a Coffee")

package/bin/OpenFDABuilder.js

@@ -1,45 +1,49 @@
-/**
- * The OpenFDABuilder class helps construct URLs for the OpenFDA API.
- *
- * Usage:
- *   - Set the context (such as 'label', 'ndc', or 'event') using the context() method.
- *   - Set the search query using the search() method.
- *   - Optionally set the result limit using the limit() method (default is 1).
- *   - Call build() to assemble and return the final API URL.
- *
- * Example:
- *   const url = new OpenFDABuilder()
- *     .context('label')
- *     .search('openfda.brand_name:"Advil"')
- *     .limit(1)
- *     .build();
- *
- * The build() method will throw an error if any required parameter is missing.
- * The API key is read from the OPENFDA_API_KEY environment variable.
- */
-export class OpenFDABuilder {
-    url = "https://api.fda.gov/drug/";
-    params = new Map();
-    context(context) {
-        this.params.set("context", context);
-        return this;
-    }
-    search(query) {
-        this.params.set("search", query);
-        return this;
-    }
-    limit(max = 1) {
-        this.params.set("limit", max);
-        return this;
-    }
-    build() {
-        const context = this.params.get("context");
-        const search = this.params.get("search");
-        const limit = this.params.get("limit");
-        const apiKey = process.env.OPENFDA_API_KEY;
-        if (!context || !search || !limit) {
-            throw new Error("Missing required parameters: context, search, or limit");
-        }
-        return `${this.url}${context}.json?api_key=${apiKey}&search=${search}&limit=${limit}`;
-    }
-}
+/*
+ * Copyright (c) 2025 Ythalo Saldanha
+ * Licensed under the MIT License
+ */
+/**
+ * The OpenFDABuilder class helps construct URLs for the OpenFDA API.
+ *
+ * Usage:
+ *   - Set the context (such as 'label', 'ndc', or 'event') using the context() method.
+ *   - Set the search query using the search() method.
+ *   - Optionally set the result limit using the limit() method (default is 1).
+ *   - Call build() to assemble and return the final API URL.
+ *
+ * Example:
+ *   const url = new OpenFDABuilder()
+ *     .context('label')
+ *     .search('openfda.brand_name:"Advil"')
+ *     .limit(1)
+ *     .build();
+ *
+ * The build() method will throw an error if any required parameter is missing.
+ * The API key is read from the OPENFDA_API_KEY environment variable.
+ */
+export class OpenFDABuilder {
+    url = "https://api.fda.gov/drug/";
+    params = new Map();
+    context(context) {
+        this.params.set("context", context);
+        return this;
+    }
+    search(query) {
+        this.params.set("search", query);
+        return this;
+    }
+    limit(max = 1) {
+        this.params.set("limit", max);
+        return this;
+    }
+    build() {
+        const context = this.params.get("context");
+        const search = this.params.get("search");
+        const limit = this.params.get("limit");
+        const apiKey = process.env.OPENFDA_API_KEY;
+        if (!context || !search || !limit) {
+            throw new Error("Missing required parameters: context, search, or limit");
+        }
+        return `${this.url}${context}.json?api_key=${apiKey}&search=${search}&limit=${limit}`;
+    }
+}