codeql-development-mcp-server 2.24.1-rc1

package/LICENSE

@@ -0,0 +1,178 @@
+# GitHub CodeQL Terms and Conditions
+
+These GitHub CodeQL Terms and Conditions ("**Terms**") are a legal
+agreement between you (either as an individual or on behalf of an
+entity) and GitHub, Inc. regarding your use of the GitHub CodeQL
+software and associated documentation (collectively, the
+"**Software**"). By using the Software, you accept these Terms.
+**Please read all of these Terms;** in many cases, provisions set
+forth later in the Terms limit and qualify provisions set forth
+earlier in the Terms. If you do not accept these Terms, do not
+download, install, use, or copy the Software.
+
+## Definitions
+
+In these Terms:
+
+- "OSI-approved License" means an Open Source Initiative
+  (OSI)-approved open source software license.
+
+- "Open Source Codebase" means a codebase that is released under an
+  OSI-approved License.
+
+## Use Rights; Scope of License
+
+The Software is licensed on a per user basis. Here's what you may do
+with the Software, but subject to License Restrictions provisions
+below:
+
+- Use the Software to perform academic research.
+
+- Use the Software to demonstrate the Software.
+
+- Test CodeQL queries that are released under an OSI-approved
+  License to confirm that new versions of those queries continue to
+  find the right vulnerabilities.
+
+Here's what you may also do with the Software, but only with an Open
+Source Codebase and subject to the License Restrictions provisions
+below:
+
+- Perform analysis on the Open Source Codebase.
+
+- If the Open Source Codebase is hosted and maintained on
+  GitHub.com, generate CodeQL databases for or during automated
+  analysis, CI, or CD.
+
+## License Restrictions
+
+These Terms do not authorize, and the Software may not be used for any
+purpose not expressly set forth above, including:
+
+- To otherwise or in any other context generate any CodeQL database
+  for or during automated analysis, CI or CD, whether as part of
+  normal engineering processes or another context.
+
+- To otherwise or in any other context use the Software in
+  connection with any codebase that is not an Open Source Codebase
+  (e.g., code in a private repo in GitHub).
+
+_**Please note:** if your use of the Software is under a paid customer
+license for GitHub Advanced Security, the restrictions with respect to
+automated analysis, CI, and CD and use in connection with non-Open
+Source Codebases do not apply._
+
+At all times, except (and only to the extent) permitted by applicable
+law or applicable third-party license, you will not (and have no right
+to):
+
+- work around any technical limitations in the Software that only
+  allow you to use it in certain ways;
+
+- reverse engineer, decompile or disassemble the Software;
+
+- remove, minimize, block, or modify any notices of GitHub or its
+  suppliers in the Software;
+
+- use the Software in any way that is against the law; or
+
+- share, publish, distribute or lend the Software, provide or make
+  available the Software as a hosted solution (whether on a
+  standalone basis or combined, incorporated or integrated with
+  other software or services) for others to use, or transfer the
+  Software or these Terms to any third party.
+
+The Software is licensed, not sold. GitHub reserves all rights not
+expressly granted in these Terms.
+
+## Open Source Software
+
+The Software may include components licensed under open source
+software licenses. Any such licenses are included in the "Open Source
+Notices" documentation that is included with the Software. Such
+documentation also includes copies of all applicable open source
+licenses.
+
+To the extent the terms of the licenses applicable to open source
+components require GitHub to make an offer to provide source code in
+connection with the Software, such offer is hereby made, and you may
+exercise it by contacting GitHub: https://github.com/contact.
+
+Unless otherwise agreed to in writing with GitHub, your agreement with
+GitHub will always include, at a minimum, these Terms. Open source
+software licenses for the Software's source code constitute separate
+written agreements. To the limited extent that any open source
+software license expressly supersedes these Terms, such open source
+license governs your use of the applicable component(s) of the
+Software subject to such license.
+
+## GitHub Trademarks
+
+These Terms do not grant any right or license to use any of GitHub's
+trademarks or logos, including, without limitation, the names GitHub
+and CodeQL and any Software logo designs in the "logos" folder of the
+Software. You agree not to display or use any of these trademarks or
+logos in any manner without GitHub's prior written permission, except
+as allowed by GitHub's Logos and Usage Policy located at
+https://github.com/logos. GitHub reserves all right, title and
+interest in and to all GitHub trademarks and logos.
+
+## Additional Services
+
+Auto-Updates: The Software may include an auto-update service. If the
+Software automatically enables such service (or, if it is not
+automatically enabled and you choose to use it), GitHub will
+automatically update the Software when a new version is available.
+
+## Support
+
+Because the Software is "as-is," GitHub may not provide support for it.
+
+## Export Control
+
+Customer will comply with all applicable export and import laws and
+regulations that apply to the Software.
+
+## Disclaimer; Limitations of Liability
+
+THE SOFTWARE, INCLUDING ANY ADDITIONAL SERVICES, IS PROVIDED ON AN
+"AS-IS" BASIS, AND GITHUB GIVES NO EXPRESS WARRANTIES, GUARANTEES OR
+CONDITIONS. TO THE EXTENT PERMITTED BY APPLICABLE LAW, GITHUB
+DISCLAIMS THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NON-INFRINGEMENT. YOUR USE OF THE SOFTWARE IS
+AT YOUR SOLE RISK.
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, YOU EXPRESSLY UNDERSTAND
+AND AGREE THAT (1) YOU CAN RECOVER DIRECT DAMAGES RELATING TO THE
+SOFTWARE, INCLUDING ANY ADDITIONAL SERVICES, UP TO U.S. $5.00 FROM
+GITHUB AND ITS SUPPLIERS, AND (2) GITHUB WILL NOT BE LIABLE FOR ANY
+INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR EXEMPLARY DAMAGES,
+INCLUDING, WITHOUT LIMITATION, ANY DAMAGES FOR LOSS OF PROFITS,
+GOODWILL, USE, OR DATA OR OTHER INTANGIBLE LOSSES (EVEN IF GITHUB HAS
+BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES) RELATING TO THE
+SOFTWARE, INCLUDING ANY ADDITIONAL SERVICES.
+
+## Miscellaneous
+
+_No Waiver._ The failure of GitHub to exercise or enforce any right or
+provision of these Terms will not constitute a waiver of such right or
+provision.
+
+_Entire Agreement._ These Terms, together with any open source
+software licenses referenced above, constitute the entire agreement
+between you and GitHub regarding your use of the Software, superseding
+any prior agreements between you and GitHub (including, but not
+limited to, any prior versions of these Terms) regarding such use.
+
+_Governing Law._ You agree that these Terms and your use of the
+Software are governed by the laws of the State of California and any
+dispute relating to the Software or your use thereof must be brought
+in a tribunal of competent jurisdiction located in or near San
+Francisco, California.
+
+_Modifications._ These Terms may only be modified by a written
+amendment signed by an authorized representative of GitHub, or by the
+posting by GitHub of a revised version.
+
+_Contact Us._ Questions about these Terms? Contact us at
+https://support.github.com/contact.

package/README.md

@@ -0,0 +1,113 @@
+# advanced-security/codeql-development-mcp-server:server/README.md
+
+This README provides documentation for the `server` subproject of the `advanced-security/codeql-development-mcp-server` repository.
+The `server` subproject implements the actual Model Context Protocol (MCP) server for CodeQL development and is the main component of the repository.
+
+## For End Users
+
+If you're using the distributed release package (downloaded from GitHub Releases), the server is ready to use. See the [Getting Started Guide](../docs/getting-started.md) for setup instructions.
+
+### Running the Server
+
+The server can run in two modes:
+
+**STDIO Mode (recommended for VS Code):**
+
+```bash
+node dist/codeql-development-mcp-server.js
+```
+
+**HTTP Mode (for debugging):**
+
+```bash
+TRANSPORT_MODE=http node dist/codeql-development-mcp-server.js
+```
+
+### Configuration
+
+Configure the server using environment variables:
+
+| Variable         | Description                            | Default  |
+| ---------------- | -------------------------------------- | -------- |
+| `CODEQL_PATH`    | Absolute path to the CodeQL CLI binary | `codeql` |
+| `TRANSPORT_MODE` | `stdio` or `http`                      | `stdio`  |
+| `HTTP_PORT`      | HTTP port (when using HTTP mode)       | `3000`   |
+| `DEBUG`          | Enable debug logging                   | `false`  |
+
+## Subproject Structure
+
+The `server` subproject is structured as follows:
+
+```text
+server/
+├── dist/                    # Base directory for compiled output
+│   ├── codeql-development-mcp-server.js     # Compiled, bundled MCP server entry point
+│   └── codeql-development-mcp-server.js.map # Source map for the bundled MCP server
+├── src/                     # TypeScript source library code
+│   ├── codeql-development-mcp-server.ts     # MCP server entry point
+│   ├── lib/                 # Core library code
+│   ├── tools/               # Implementation of MCP tools
+├── test/                    # Base directory for tests
+│   ├── src/                 # Base directory for test source files
+│   │   ├── lib/             # Test files for core library code
+│   │   ├── tools/           # Test files for MCP tools
+├── eslint.config.mjs        # ESLint configuration
+├── esbuild.config.js        # esbuild configuration for bundling
+├── package.json             # NPM package configuration
+├── tsconfig.json            # TypeScript configuration
+└── README.md                # This README file
+```
+
+## Troubleshooting
+
+### Server Won't Start
+
+1. **Check Node.js version**: The server requires Node.js v24.13.0 or later
+
+   ```bash
+   node --version
+   ```
+
+2. **Verify the entry point exists**:
+
+   ```bash
+   ls dist/codeql-development-mcp-server.js
+   ```
+
+3. **Check for missing dependencies**: If using the distributed package, ensure `node_modules` is present
+
+### CodeQL Tools Return Errors
+
+1. **Verify CodeQL CLI is installed**:
+
+   ```bash
+   codeql --version
+   ```
+
+2. **Check CodeQL is in PATH**: The server expects `codeql` to be available in the system PATH, or set `CODEQL_PATH` to the absolute path of the CodeQL CLI binary
+
+3. **Ensure you have a valid database**: Most query tools require a CodeQL database
+
+### HTTP Mode Not Working
+
+1. **Check if port is in use**:
+
+   ```bash
+   lsof -i :3000
+   ```
+
+2. **Try a different port**:
+
+   ```bash
+   TRANSPORT_MODE=http HTTP_PORT=8080 node dist/codeql-development-mcp-server.js
+   ```
+
+### VS Code Integration Issues
+
+See the [Getting Started Guide](../docs/getting-started.md#troubleshooting) for troubleshooting steps.
+
+## References
+
+- [MCP Architecture](https://modelcontextprotocol.io/docs/learn/architecture)
+- [Getting Started Guide](../docs/getting-started.md)
+- [Tools Reference](../docs/tools-reference.md)