├── .gitignore ├── BACKEND-REQS.md ├── COPYING.txt ├── README.md ├── lisp-eval-examples.md └── scripts ├── handlers ├── httpRequest.js ├── index.js ├── initialize.js ├── lispEval.js ├── ping.js ├── toolCall.js └── toolsList.js ├── lib ├── config.js ├── docker.js ├── logger.js ├── server.js └── utils.js ├── mcp-wrapper.js ├── package-lock.json ├── package.json └── robot-lambda.png /.gitignore: -------------------------------------------------------------------------------- 1 | system-index.txt 2 | *~ 3 | *.*x64fsl 4 | node_modules -------------------------------------------------------------------------------- /BACKEND-REQS.md: -------------------------------------------------------------------------------- 1 | # Lisply Backend Requirements 2 | 3 | This document outlines the requirements for any Lisp-based program to 4 | become a "Lisply-compliant" backend for use with the MCP (Model 5 | Context Protocol) wrapper implemented by this repository. Compliant 6 | Lisply backend Lisp environments enable direct AI-assisted symbolic 7 | programming, through protocols defined in this document. 8 | 9 | ## Core Requirements 10 | 11 | ### 2. Some kind of Lisp 12 | 13 | It should be a [Lisp](https://common-lisp.net/). What is a Lisp? Well 14 | for our purposes let's say a Lisp is a program which can accept 15 | _expressions_ in some known syntax, and can _evaluate_ the expression 16 | to produce possibly some output and probably one or more _return 17 | values_. So, strictly speaking, according to our rather loose 18 | definition, we're really talking more about a 19 | [REPL](https://common-lisp.net/project/slime/) than a 20 | [Lisp](https://www.paulgraham.com/lisp.html) per se. But you'll have a 21 | better time if the engine behind your 22 | [REPL](https://lisp-lang.org/learn/repl) is indeed a 23 | [Lisp](https://franz.com/products/allegro-common-lisp/). 24 | 25 | ### 1. HTTP Server Capability 26 | 27 | A Lisply backend must provide an HTTP server that exposes the 28 | following endpoints: 29 | 30 | - `/lisply/ping-lisp`: Simple ping endpoint for availability checks 31 | - `/lisply/lisp-eval`: Endpoint for evaluating Lisp expressions 32 | - `/lisply/tools/list`: Endpoint that returns a list of available tools 33 | 34 | Note: The endpoint prefix (`/lisply/`) can be configured in the MCP 35 | wrapper, but backends should support this as the default. 36 | 37 | ### 2. Lisp Evaluation Protocol 38 | 39 | The backend must support Lisp code evaluation through the 40 | `/lisply/lisp-eval` endpoint with the following characteristics: 41 | 42 | - **Request Format**: HTTP POST accepting JSON payload with: 43 | ```json 44 | { 45 | "code": "Lisp code to evaluate", 46 | "package": "Optional package name" 47 | } 48 | ``` 49 | 50 | - **Response Format**: JSON response with the following structure: 51 | ```json 52 | { 53 | "success": true, 54 | "result": "Result of evaluation", 55 | "stdout": "Any stdout output generated" 56 | } 57 | ``` 58 | 59 | Or in case of error: 60 | ```json 61 | { 62 | "success": false, 63 | "error": "Error message" 64 | } 65 | ``` 66 | 67 | ### 3. Tool Definitions 68 | 69 | The backend must expose a list of its capabilities through the 70 | `/lisply/tools/list` endpoint, which returns a JSON object with the 71 | structure: 72 | 73 | ```json 74 | { 75 | "tools": [ 76 | { 77 | "name": "lisp_eval", 78 | "description": "Evaluates Lisp code directly within the Lisply environment", 79 | "inputSchema": { 80 | "type": "object", 81 | "properties": { 82 | "code": { 83 | "type": "string", 84 | "description": "The Lisp code to evaluate" 85 | }, 86 | "package": { 87 | "type": "string", 88 | "description": "The package to use for the evaluation (optional)" 89 | } 90 | }, 91 | "required": ["code"] 92 | } 93 | }, 94 | { 95 | "name": "ping_lisp", 96 | "description": "Checks if the Lisply backend is available", 97 | "inputSchema": { 98 | "type": "object", 99 | "properties": {} 100 | } 101 | } 102 | ] 103 | } 104 | ``` 105 | 106 | **Note**: The backend is only expected to implement the `lisp_eval` 107 | and `ping_lisp` tools. The `http_request` tool and the `mode` 108 | parameter for `lisp_eval` are handled by the MCP wrapper middleware 109 | (mcp-wrapper.js) and should not be implemented or documented by the 110 | backend. The backend is not aware of these features, as they are an 111 | abstraction provided by the middleware. 112 | 113 | ## Optional Capabilities 114 | 115 | ### 1. SWANK Server Support 116 | 117 | For enhanced integration with development environments: 118 | 119 | - **SWANK Protocol**: Support for connecting via SWANK (Superior Lisp 120 | Interaction Mode for Emacs) for Lisply backends which support that 121 | (e.g. Common Lisp based backends) 122 | - **Default Port**: 4200 (internal to container) / 4201 (visible on 123 | docker host) 124 | 125 | ### 2. Interactive Debugger 126 | 127 | For local deployments, provide interactive debugging capabilities: 128 | 129 | - Interactive REPL via stdio mode 130 | - Debugger interface with the ability to: 131 | - Display debug information for errors 132 | - Present multiple restart options 133 | - Support for common debugging commands (abort, continue, backtrace, etc.) 134 | - Return to normal evaluation upon command 135 | - Proper handling of debugger prompt detection (implementation-specific) 136 | 137 | ### 3. Communication Modes 138 | 139 | The middleware supports two evaluation modes with the Lisply 140 | backend: 141 | 142 | - **HTTP Mode**: Structured communication with separate result and 143 | stdout fields. The backend returns a JSON response with success, 144 | result, and stdout fields. This is the standard mode of 145 | communication and the only one the backend needs to implement 146 | directly. 147 | 148 | - **Stdio Mode**: To support this (optional) mode, the backend must 149 | present a Lisp REPL (read-eval-print-loop) as the foreground process 150 | attached to its standard input/output. The communication for this 151 | mode is managed by the middleware (mcp-wrapper.js), which expects a 152 | native REPL interface on the standard input/output streams of the 153 | local backend container. Implementing/configuring this standard I/O 154 | behavior may be easier on some backends (e.g. Common Lisp, where a 155 | repl on standard I/O is typically the default anyway, vs. Emacs 156 | Lisp, where some tricks may be necessary to get something like 157 | [IELM](https://www.emacswiki.org/emacs/InferiorEmacsLispMode) to 158 | show up on standard I/O. 159 | 160 | 161 | ### 4. HTTPS Support 162 | 163 | For secure deployments: 164 | 165 | - HTTPS server with valid certificates 166 | - Default port: 9443 (internal to container) / 9444 (visible on docker host) 167 | 168 | ### 5. Telnet Interface 169 | 170 | For legacy access methods: 171 | 172 | - Telnet server for direct Lisp interaction 173 | - Default port: 4023 (internal to container) / 4024 (visible on docker host) 174 | 175 | ## Containerization Support (optional in principle, but required for local operation of lisply-mcp) 176 | 177 | For standardized deployment, backends should support: 178 | 179 | 1. **Docker Container**: A Docker image containing the Lisply backend 180 | 2. **Service Configuration**: Environment variables to configure service startup: 181 | - START_HTTP, HTTP_PORT 182 | - START_HTTPS, HTTPS_PORT 183 | - START_SWANK, SWANK_PORT 184 | - START_TELNET, TELNET_PORT 185 | 186 | 3. **Volume Mounting**: Support for mounting host directories into the container 187 | 188 | ## Implementation Examples 189 | 190 | Currently, there are implementations or planned implementations for: 191 | 192 | 1. **Gendl**: A full implementation available at [Gendl on GitLab](https://gitlab.common-lisp.net/gendl/gendl) 193 | with Lisply implementation [here](https://gitlab.common-lisp.net/gendl/gendl/gwl/lisply-backend) 194 | 2. **GNU Emacs Backend**: In development at [Skewed Emacs on GitHub](https://github.com/gornskew/skewed-emacs.git) 195 | 196 | 197 | ## Testing for Compliance 198 | 199 | To test a backend for compliance, implement the following checks: 200 | 201 | 1. Ping test: `GET /lisply/ping-lisp` 202 | 2. Tool list retrieval: `GET /lisply/tools/list` 203 | 3. Basic Lisp evaluation: 204 | ``` 205 | POST /lisply/lisp-eval 206 | {"code": "(+ 1 2 3)"} 207 | ``` 208 | 4. Package specification (for backends that support package-based namespaces): 209 | ``` 210 | POST /lisply/lisp-eval 211 | {"code": "(package-name *package*)", "package": "gdl-user"} 212 | ``` 213 | 214 | Note: Testing of the `mode` parameter should be done at the middleware 215 | level, not directly with the backend, as this feature is handled by 216 | the MCP wrapper and is expected to be ignored by the backend. 217 | 218 | A successful implementation should respond correctly to all these tests. 219 | -------------------------------------------------------------------------------- /COPYING.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Model Context Protocol (MCP) Middleware for Lisp-based and Lisp-like Environments 3 | 4 | Robot with Lambda machine 6 | 7 | This project is a [Model Context Protocol 8 | (MCP)](https://modelcontextprotocol.org) middleware that enables 9 | [Large Language Models 10 | (LLMs)](https://en.wikipedia.org/wiki/Large_language_model) to 11 | interact with [Lisp-based](https://common-lisp.net/) development and 12 | runtime environments using a lightweight protocol called _Lisply_. 13 | 14 | 15 | ## Who Is this Meant For? 16 | 17 | - AI practitioners curious about Lisp 18 | - Lisp practitioners curious about AI 19 | - Anyone interested in Neuro-Symbolic Programming 20 | - Mechanical/Civil Engineers and Designers interested in CAD 21 | Automation and Knowledge Based Engineering 22 | - Tinkerers, meddlers, and tamperers from all walks of life 23 | 24 | ## What Is it Meant to Do? 25 | 26 | The Lisply-MCP middleware connects 27 | [MCP-capable](https://modelcontextprotocol.org) AI Agent programs, or 28 | _MCP Clients_, such as 29 | [ClaudeDesktop](https://www.anthropic.com/claude), to Lisp-based 30 | systems which support a REPL, or Read-Eval-Print Loop. The connection 31 | is meant to facilitate AI-assisted symbolic programming sometimes 32 | referred to as _Neuro-Symbolic Programming_. We have coined the term 33 | "Lisply" to refer to a lightweight protocol which most any Lisp-like 34 | system can implement to render it compatible with this Lisply-MCP 35 | middleware. 36 | 37 | The idea is that the LLM will be able to generate and evaluate 38 | arbitrary Lisp expressions, including creating, compiling, loading, 39 | and testing entire files and projects. 40 | 41 | 42 | ## Quick Start 43 | 44 | The following will get you up and running quickly with a minimal 45 | default configuration and a default public Common Lisp based backend 46 | running as a Docker container. See the main Contents below for more 47 | background and detailed configuration options. 48 | 49 | ### 1. Install 50 | 51 | 1. Install Node.js (18+ recommended). If on Windows, this can be 52 | installed directly in Windows or in WSL. 53 | 54 | 2. Install [Docker](https://docs.docker.com/engine/install/) (20+ 55 | recommended) on the same host as where the Node.js is installed. 56 | 57 | 3. Clone this `lisply-mcp` repository to a location where your 58 | MCP-capable AI Agent (e.g. Claude Desktop) can access it. 59 | 60 | 61 | ### 2. Configure your MCP-capabile AI Agent 62 | 63 | Edit or create your AI Agent's configuration file as shown below. In 64 | the case of Claude Desktop, the configuration file is typically: 65 | 66 | 67 | ``` 68 | /mnt/c/Users//AppData/Roaming/Claude/claude_desktop_config.json 69 | ``` 70 | 71 | or 72 | 73 | ``` 74 | c:\Users\\AppData\Roaming\Claude\claude_desktop_config.json 75 | ``` 76 | 77 | In the example below, replace `/path/to/cloned/` with the correct path 78 | to the `./scripts/mcp-wrapper.js` file from the cloned repo: 79 | 80 | ```json 81 | { 82 | "mcpServers": { 83 | "lisply-mcp-1": { 84 | "command": "node", 85 | "args": [ 86 | "/path/to/cloned/lisply-mcp/scripts/mcp-wrapper.js" 87 | ] 88 | } 89 | } 90 | } 91 | ``` 92 | 93 | 94 | Or in a WSL scenario (where the Claude Desktop is running in the 95 | Windows host): 96 | 97 | ```json 98 | { 99 | "mcpServers": { 100 | "lisply-mcp-1": { 101 | "command": "wsl", 102 | "args": [ 103 | "node", "/path/to/cloned/lisply-mcp/scripts/mcp-wrapper.js" 104 | ] 105 | } 106 | } 107 | } 108 | ``` 109 | 110 | See the main Contents below for further configuration options, for 111 | example how to have your `~/projects/` filesystem directory be shared 112 | ("mounted") from your host to the default Lisply backend, or how to 113 | specify an alternative Lisply backend container or service host/port. 114 | 115 | 116 | ### 3. Restart your AI Agent and Test 117 | 118 | With the above configuration in place, your freshly restarted AI Agent 119 | will now have access to an MCP server called `lisply-mcp-1`, with a 120 | `lisp_eval` MCP tool (among a few other tools discussed in the main 121 | Contents below). In order to test your setup, you can prompt your LLM 122 | as follows: 123 | 124 | > 125 | > Evaluate `(+ 1 2 3)` using the lisp_eval tool, and let me know the 126 | > result. 127 | > 128 | 129 | The LLM should invoke the requested evaluation and respond with `6` as 130 | expected. Feel free to experiment with more complex expressions before 131 | proceeding. 132 | 133 | 134 | ## How Does the Default Minimal Configuration Work? 135 | 136 | The minimal default configuration described in the Quick Start aboves 137 | will pull and run a 138 | [Gendl](https://gitlab.common-lisp.net/gendl/gendl) docker container 139 | which contains a Common Lisp superset sporting a standard REPL 140 | (Read-Eval-Print Loop). Note that work is also in progress on a second 141 | Lisply backend implementation for Emacs lisp, within the [Skewed 142 | Emacs](https://github.com/gornskew/skewed-emacs/dot-files/emacs.d/sideloaded/lisply-backend/README.md) 143 | project. 144 | 145 | 146 | 147 | ## System Overview 148 | 149 | The Lisply MCP middleware is implemented as a Javascript program meant 150 | to run in Node.js, and provides a bridge between your AI Agent and any 151 | [compliant Lisply backend system](BACKEND-REQS.md). This wrapper 152 | enables the AI Agent to: 153 | 154 | 1. Evaluate Lisp code in the Lisply Backend and receive the results. 155 | 2. Make HTTP requests to any web endpoints implemented in the backend. 156 | 3. Access introspection and documentation lookup facilities in the LB 157 | using Lisp evaluation. 158 | 4. Create, manipulate, compile, load, and analyze files, again using 159 | Lisp evaluation. 160 | 5. Interact with Lisp debuggers (for locally running backends). 161 | 162 | [Lisply](./BACKEND-REQS.md) is a lightweight protocol that specifies a 163 | minimal yet flexible set of HTTP and standard input/output interfaces, 164 | a standard set of environment variables, Docker container image naming 165 | conventions, and several optional capabilities to facilitate AI agents 166 | controlling your running Lisp system. 167 | 168 | ## Architecture 169 | 170 | The diagram below roughly captures how the components interact: 171 | 172 | 173 | ```mermaid 174 | flowchart TB 175 | User("User") <--> Claude("Claude Desktop") 176 | User <-.-> Emacs("Emacs Text Editor (Optional)") 177 | 178 | Claude <--> MCP("MCP Protocol") 179 | MCP <--> Wrapper("Node.js MCP Wrapper") 180 | 181 | Wrapper --> LisplyHttp("Lisply HTTP Server") 182 | 183 | subgraph Docker ["Docker Container"] 184 | subgraph LisplyExec["Lisply Executable"] 185 | LisplyHttp 186 | LisplySwank("Lisply SWANK Server (for Emacs connection)") 187 | end 188 | end 189 | 190 | Wrapper <-- "Manages" --> Docker 191 | 192 | Emacs <-.-> LisplySwank 193 | 194 | KB[("Lisply Knowledge Base")] <--> Wrapper 195 | 196 | LisplyHttp --> Endpoints("RESTful Endpoints") 197 | LisplyHttp --> LispEval("Lisp Evaluation") 198 | 199 | style User fill:#ff9,stroke:#333,stroke-width:2px 200 | style Claude fill:#f9f,stroke:#333,stroke-width:2px 201 | style Emacs fill:#9ff,stroke:#333,stroke-width:2px,stroke-dasharray:5 202 | style Wrapper fill:#bbf,stroke:#333,stroke-width:2px 203 | style MCP fill:#bbf,stroke:#333,stroke-width:1px 204 | style Docker fill:#bfb,stroke:#333,stroke-width:2px 205 | style LisplyExec fill:#8f8,stroke:#333,stroke-width:2px 206 | style LisplyHttp fill:#bfb,stroke:#333,stroke-width:1px 207 | style LisplySwank fill:#bfb,stroke:#333,stroke-width:1px 208 | style KB fill:#bfb,stroke:#333,stroke-width:1px 209 | style Endpoints fill:#bfb,stroke:#333,stroke-width:1px 210 | style LispEval fill:#bfb,stroke:#333,stroke-width:1px 211 | ``` 212 | 213 | The middleware handles: 214 | 1. Starting and managing a Lisply-compliant Docker container if needed 215 | 2. Translating Lisp evaluation requests between the MCP protocol and 216 | the backend [Lisply API](BACKEND-REQS.md) 217 | 3. Error handling, Lisp debugger interaction, and logging 218 | 219 | ## Security Considerations 220 | 221 | Because Lisply-MCP allows arbitrary Lisp code to be evaluated against 222 | a running Lisp-based backend, there are certain risks in case the LLM 223 | were to go "haywire." Therefore, best practices are: 224 | 225 | - Allow the wrapper to connect only to a containerized version of a 226 | Lisply backend. If overriding default host/port, the wrapper will 227 | happily connect to any live Lisply-compliant http port. Avoid 228 | allowing this to happen for any http ports being served by programs 229 | running directly on your host. 230 | 231 | - Make sure not to mount any non-expendable directories to that 232 | container (see directory mounting configuration instructions below) 233 | 234 | - Consider taking steps to [limit RAM and CPU 235 | usage](https://docs.docker.com/engine/containers/resource_constraints/) 236 | of the container. 237 | 238 | 239 | ### Code Modules/Files 240 | 241 | - **lib/config.js**: Configuration loading and environment handling 242 | - **lib/logger.js**: Logging functionality 243 | - **lib/docker.js**: Docker container management 244 | - **lib/server.js**: HTTP server and MCP wrapper implementation 245 | - **lib/utils.js**: Utility functions for response handling 246 | - **handlers/**: Tool-specific request handlers 247 | - **initialize.js**: Initialization handler 248 | - **toolsList.js**: Tools list handler 249 | - **toolCall.js**: Main tool call dispatcher 250 | - **httpRequest.js**: HTTP request handler 251 | - **ping.js**: Ping handler 252 | - **lispEval.js**: Lisp evaluation handler 253 | - **mcp-wrapper.js**: <--- Main entry point <--- 254 | 255 | 256 | 257 | ## Detailed Installation 258 | 259 | 1. Clone this repository: 260 | ```bash 261 | git clone https://github.com/gornskew/lisply-mcp.git 262 | ``` 263 | 264 | 2. Install the required dependencies (optional, as the wrapper auto-installs dependencies): 265 | ```bash 266 | cd lisply-mcp/scripts 267 | npm install # optional - the script will attempt to do this also if needed 268 | chmod +x mcp-wrapper.js # needed on some systems 269 | ``` 270 | 271 | 3. Ensure Docker is installed on your system. 272 | 273 | 4. Test the script: 274 | ```bash 275 | node mcp-wrapper.js --help 276 | ``` 277 | 278 | ## Advanced Configuration 279 | 280 | Optional settings for advanced users, with defaults suitable for most 281 | cases: 282 | 283 | ### Command-Line Arguments 284 | 285 | ```bash 286 | Options: 287 | -H, --backend-host Lisply server host (default: 127.0.0.1) 288 | --swank-host-port SWANK port on host system (external) (default: 4201) 289 | --http-host-port HTTP port on host system (external) (default: 9081) 290 | --https-host-port HTTPS port on host system (external) (default: 9444) 291 | --telnet-host-port TELNET port on host system (external) (default: 4024) 292 | --http-port HTTP port inside container (internal) (default: 9080) 293 | --https-port HTTPS port inside container (internal) (default: 9443) 294 | --swank-port SWANK port inside container (internal) (default: 4200) 295 | --telnet-port TELNET port inside container (internal) (default: 4023) 296 | --image-base-name Base name for Docker image (default: dcooper8/gendl) 297 | --image-branch Branch to use for Docker image (default: auto-detected) 298 | --docker-image Full Docker image for backend (overrides base name and branch) 299 | --lisp-impl Lisp implementation to use, ccl or sbcl (default: ccl) 300 | --no-auto-start Do not auto-start backend Docker container if not running 301 | --docker-socket Path to Docker socket (default: /var/run/docker.sock) 302 | --log-file Path to log file (default: /tmp/lisply-mcp-wrapper.log) 303 | --debug Enable debug logging 304 | --mount Mount volumes in format "src:dst" (can specify multiple times) 305 | --start-http Start HTTP service in backend container (default: true) 306 | --start-https Start HTTPS service in backend container (default: false) 307 | --start-swank Start SWANK service in backend container (default: true) 308 | --start-telnet Start TELNET service in backend container (default: false) 309 | --no-use-stdio Disable stdio capability for local containers (default: false) 310 | --repl-prompt REPL prompt pattern to detect Lisp evaluation completion (default: ?) 311 | --eval-timeout Timeout for Lisp evaluation in milliseconds (default: 30000) 312 | --endpoint-prefix Prefix for all endpoints (default: lisply) 313 | --lisp-eval-endpoint Endpoint name for Lisp evaluation (default: lisp-eval) 314 | --http-request-endpoint Endpoint name for HTTP requests (default: http-request) 315 | --ping-endpoint Endpoint name for ping (default: ping-lisp) 316 | -h, --help Display help for command 317 | ``` 318 | 319 | ### Environment Variables 320 | 321 | The script also supports configuration via environment variables. You 322 | can specify variables with the "LISPLY_" prefix or with no prefix: 323 | 324 | **Note:** It is important to keep straight the difference between host 325 | ports (listening on and reachable from the host system) and container 326 | ports (internal to the container, visible to the Lisply backend 327 | service process): 328 | 329 | | Environment Variable | Description | Default | 330 | |----------------------|-------------|---------| 331 | | `BACKEND_HOST` or `LISPLY_BACKEND_HOST` | Lisply server host | 127.0.0.1 | 332 | | `SWANK_HOST_PORT` or `LISPLY_SWANK_HOST_PORT` | SWANK port on host system (external) | 4201 | 333 | | `HTTP_HOST_PORT` or `LISPLY_HTTP_HOST_PORT` | HTTP port on host system (external) | 9081 | 334 | | `HTTPS_HOST_PORT` or `LISPLY_HTTPS_HOST_PORT` | HTTPS port on host system (external) | 9444 | 335 | | `TELNET_HOST_PORT` or `LISPLY_TELNET_HOST_PORT` | TELNET port on host system (external) | 4024 | 336 | | `HTTP_PORT` or `LISPLY_HTTP_PORT` | HTTP port inside container (internal) | 9080 | 337 | | `HTTPS_PORT` or `LISPLY_HTTPS_PORT` | HTTPS port inside container (internal) | 9443 | 338 | | `SWANK_PORT` or `LISPLY_SWANK_PORT` | SWANK port inside container (internal) | 4200 | 339 | | `TELNET_PORT` or `LISPLY_TELNET_PORT` | TELNET port inside container (internal) | 4023 | 340 | | `START_HTTP` or `LISPLY_START_HTTP` | Start HTTP service | true | 341 | | `START_HTTPS` or `LISPLY_START_HTTPS` | Start HTTPS service | false | 342 | | `START_SWANK` or `LISPLY_START_SWANK` | Start SWANK service | true | 343 | | `START_TELNET` or `LISPLY_START_TELNET` | Start TELNET service | false | 344 | | `DOCKER_IMAGE` or `LISPLY_DOCKER_IMAGE` | Docker image for backend | (auto-detected) | 345 | | `IMAGE_BASE` or `LISPLY_IMAGE_BASE` | Base name for Docker image | genworks/gendl | 346 | | `IMAGE_BRANCH` or `LISPLY_IMAGE_BRANCH` | Branch for Docker image | (auto-detected) | 347 | | `LISP_IMPL` or `LISPLY_LISP_IMPL` | Lisp implementation to use | ccl | 348 | | `AUTO_START` or `LISPLY_AUTO_START` | Enable auto-starting container | true | 349 | | `DOCKER_SOCKET` or `LISPLY_DOCKER_SOCKET` | Path to Docker socket | /var/run/docker.sock | 350 | | `LOG_FILE` or `LISPLY_LOG_FILE` | Path to log file | /tmp/lisply-mcp-wrapper.log | 351 | | `DEBUG_MODE` or `LISPLY_DEBUG_MODE` | Enable debug logging | false | 352 | | `MOUNTS` or `LISPLY_MOUNTS` | Comma-separated mount points | (none) | 353 | | `NO_USE_STDIO` or `LISPLY_NO_USE_STDIO` | Disable stdio capability | false | 354 | | `REPL_PROMPT` or `LISPLY_REPL_PROMPT` | REPL prompt pattern | ? (depends on implementation) | 355 | | `EVAL_TIMEOUT` or `LISPLY_EVAL_TIMEOUT` | Timeout for Lisp evaluation in ms | 30000 | 356 | | `ENDPOINT_PREFIX` or `LISPLY_ENDPOINT_PREFIX` | Prefix for all endpoints | lisply | 357 | | `LISP_EVAL_ENDPOINT` or `LISPLY_LISP_EVAL_ENDPOINT` | Endpoint name for Lisp evaluation | lisp-eval | 358 | | `HTTP_REQUEST_ENDPOINT` or `LISPLY_HTTP_REQUEST_ENDPOINT` | Endpoint name for HTTP requests | http-request | 359 | | `PING_ENDPOINT` or `LISPLY_PING_ENDPOINT` | Endpoint name for ping | ping-lisp | 360 | 361 | ## Docker Integration 362 | 363 | Lisply-MCP can interact with both local and remote Lisply 364 | backends. For the local case, the middleware can automatically run 365 | Docker commands to pull and manage the appropriate Lisply backend 366 | container. 367 | 368 | ### Docker Image Selection 369 | 370 | The middleware selects a default Docker image name based on the 371 | detected current git branch of your Lisply-MCP repository: 372 | 373 | 1. The Lisply Docker image naming convention follows the pattern: 374 | `${DOCKER_USER}/${IMAGE_BASE}:${IMAGE_BRANCH}-${LISP_IMPL}` 375 | - `${DOCKER_USER}` Username at hub.docker.com. defaults to `genworks`. 376 | - `${IMAGE_BASE}` Main name of the Lisply backend. Defaults to `gendl`. 377 | - `${IMAGE_BRANCH}` defaults to the current git branch name where 378 | the wrapper script is situated, with any slashes (`/`) converted 379 | to double hyphens (`--`) 380 | - For example, `release/1598` becomes `release--1598` in the image tag 381 | - `devo` branch will use the image tag `devo` 382 | - If no git branch is detected, defaults to `master`. 383 | - `${LISP_IMPL}` is the Lisp implementation in case the base Lisply 384 | backend sports multiple available Lisp flavors (e.g., ccl, sbcl 385 | are available for current public Gendl builds). 386 | 387 | 2. The middleware will attempt to pull a newer image if one exists: 388 | - First tries to pull a newer image from Docker Hub. 389 | - If pull fails or local is up to date, uses the local one. 390 | 391 | 3. You can override the automatic selection with: 392 | - The `--docker-image` command-line argument (overrides 393 | `--image-base-name` and `--image-branch` entirely) 394 | - The `--image-base-name` and/or `--image-branch` arguments 395 | - The `LISPLY_DOCKER_IMAGE` environment variable 396 | - The `LISPLY_IMAGE_BASE` and `LISPLY_IMAGE_BRANCH` environment 397 | variables 398 | 399 | 4. For the Lisp implementation: 400 | - Specify with `--lisp-impl` (ccl or sbcl for current gendl builds) 401 | - Or use the `LISPLY_LISP_IMPL` environment variable 402 | - Defaults to `ccl` if not specified, `sbcl` is also a valid choice 403 | for the default Gendl images. 404 | 405 | ### DockerHub Authentication 406 | 407 | The wrapper will attempt to log in to DockerHub using stored 408 | credentials. However, the default container images are public and 409 | should be available anonymously without `docker login`. 410 | 411 | 412 | ### Volume Mounting 413 | 414 | You can mount host directories into the backend Lisply container to 415 | share files between your host system and the container (note multiple 416 | mount points can be specified): 417 | 418 | ```bash 419 | { 420 | "mcpServers": { 421 | "lisply-gendl-4": { 422 | "command": "node", 423 | "args": [ 424 | "/path/to/cloned/lisply-mcp/scripts/mcp-wrapper.js", 425 | "--mount", "/home/user/projects:/projects", 426 | "--mount", "/home/user/data:/data" 427 | ] 428 | } 429 | } 430 | } 431 | 432 | ``` 433 | 434 | Or using environment variables: 435 | ```bash 436 | LISPLY_MOUNTS=/home/user/projects:/projects,/home/user/data:/data node mcp-wrapper.js 437 | ``` 438 | 439 | Note the container runs with a certain UID, typically defaulting 440 | to 1000. This may cause unexpected file ownerships if the Lisply 441 | backend is writing to a mounted directory. This can be solved with 442 | `docker exec` by sending commands to the container to change the UID 443 | of the user running the service in the container. This behavior is 444 | expected to be automated in a future version of this project. A 445 | possible command could look like e.g.: 446 | 447 | ``` 448 | docker exec lisply-mcp- usermod -u 1001 lisply-user 449 | ``` 450 | 451 | 452 | ### Existing Service Detection 453 | 454 | The wrapper will check if a Lisply service is already running on the 455 | specified http host and ports and use it if it exists, before 456 | attempting to pull and/or start a container. 457 | 458 | 459 | #### Existing Services Override Local Container Settings 460 | 461 | When an existing service is detected on the specified host and port, 462 | all Docker-related settings will be ignored: 463 | 464 | - `--docker-image`, `--image-base-name`, `--image-branch`, and `--lisp-impl` 465 | - `--mount` volume options 466 | - `--start-*` service flags 467 | - `--*-port` internal container port settings 468 | - `--docker-socket` path 469 | - `--no-auto-start` flag 470 | 471 | In this case, the wrapper will log messages about which settings are 472 | being ignored. 473 | 474 | ## Communication Modes 475 | 476 | This middleware supports two primary modes of communication with 477 | configured Lisply backends: HTTP mode and stdio (Standard 478 | Input/Output) mode. 479 | 480 | ### HTTP Mode 481 | 482 | HTTP mode is the default communication method and works with both 483 | local and remote Lisply backends. This mode uses the standard HTTP 484 | endpoints that all Lisply backends are required to implement. 485 | 486 | **Characteristics:** 487 | - Structured responses with separate result, stdout, and error fields 488 | - Suitable for most casual use cases 489 | - Response format: `{Result: , Stdout: , Error: }` 490 | 491 | **Example response in HTTP mode:** 492 | ``` 493 | {"Result": "6", "Stdout": "This is a message to standard output"} 494 | ``` 495 | 496 | ### Stdio Mode 497 | 498 | Stdio mode provides more of a raw REPL experience for the LLM and 499 | enables the LLM to engage in interactive debugging. This mode expects 500 | to leverage the backend's native REPL interface and any included 501 | command-driven debugger. 502 | 503 | **Characteristics:** 504 | - Raw REPL-like output without structured formatting 505 | - Support for interactive debugger when errors occur 506 | - Only available for local containers started by this middleware 507 | - Ideal for development, debugging, and complex interactions 508 | - Captures standard output followed by return-value of evaluated 509 | expressions in same stream, so the LLM will have to distinguish 510 | these just as a human user would 511 | 512 | **Debugger Support:** When an error occurs in stdio mode, the Lisp 513 | debugger can be interacted with. The wrapper detects debugger prompts 514 | and provides metadata about the debugger state to the AI Agent. This 515 | functionality relies on hardcoded prompt patterns in the wrapper code 516 | which would need to be augmented to support new Lisply backends with 517 | different REPL and debugger prompts (patches welcome). 518 | 519 | **Mode Selection:** 520 | - Default mode is HTTP. 521 | - To use stdio mode for a particular tool call, ask the LLM to specify 522 | `mode: "stdio"` in the `lisp_eval` tool parameters. 523 | - Stdio mode can be banned for the session by configuring with the 524 | `--no-use-stdio` flag or `LISPLY_NO_USE_STDIO=true`. 525 | 526 | If stdio mode is requested but banned or otherwise not available, the 527 | wrapper will fall back to HTTP mode. LLM callers using stdio mode need 528 | to be aware of this, because the response from the HTTP fallback comes 529 | packaged in JSON instead of in raw format. 530 | 531 | ## Usage Examples 532 | 533 | All the examples below can be tested on command line and used in 534 | `claude_desktop_config.json` configuration (see [Claude Desktop 535 | Configuration](#claude-desktop-configuration)). 536 | 537 | ### Running in a Container 538 | 539 | If running the wrapper itself inside a container, make sure to mount 540 | the Docker socket (and some other port tricks may be necessary): 541 | 542 | ```bash 543 | docker run -v /var/run/docker.sock:/var/run/docker.sock -v /path/to/scripts:/app node:18 node /app/mcp-wrapper.js 544 | ``` 545 | 546 | ## Adding a Separate, Compatible Filesystem MCP Server 547 | 548 | Below is a `claude_desktop_config.json` which sets up a filesystem mcp 549 | server as well as our `lisply-mcp-1` server, with a common mount 550 | shared between the two mcp servers: 551 | 552 | 553 | ```json 554 | { 555 | "mcpServers": { 556 | "filesystem": { 557 | "command": "wsl", 558 | "args": [ 559 | "docker", 560 | "run", 561 | "-i", 562 | "--rm", 563 | "-u", 564 | "1000:1000", 565 | "--mount", 566 | "type=bind,src=/home/user/projects,dst=/projects", 567 | "mcp/filesystem", 568 | "/projects" 569 | ] 570 | }, 571 | "lisply-mcp-1": { 572 | "command": "wsl", 573 | "args": [ 574 | "node", 575 | "/home/user/projects/lisply-mcp/scripts/mcp-wrapper.js", 576 | "--mount", "/home/user/projects:/projects" 577 | ] 578 | } 579 | }, 580 | "globalShortcut": "" 581 | } 582 | ``` 583 | 584 | ### Tool Details for Claude 585 | 586 | #### Lisp Evaluation Tool (`lisp_eval`) 587 | 588 | The `lisp_eval` tool allows Claude to evaluate Lisp code directly 589 | within the Lisply environment with these parameters: 590 | 591 | - `code` (required): The Lisp code to evaluate 592 | - `package` (optional): The package to use for the evaluation 593 | - `mode` (optional): The mode to use to talk to Lisply 594 | - `http` (default): Uses HTTP communication for structured responses 595 | - `stdio`: Uses standard input/output communication for a raw REPL experience 596 | 597 | **Mode Comparison:** 598 | 599 | | Feature | HTTP Mode | STDIO Mode | 600 | |---------|-----------|------------| 601 | | Response Format | Structured with separate Result and Stdout fields | Raw REPL-like output | 602 | | Error Handling | Traps errors and returns them as strings | Can enter interactive debugger | 603 | | Debugger Support | No interactive debugging | Supports interactive debugger | 604 | | Compatibility | Works with local & remote servers | Only for local containers started by MCP | 605 | | Use Case | Clean integration, simple queries | Development, debugging, complex interactions | 606 | 607 | 608 | #### HTTP Request Tool (`http_request`) 609 | 610 | The `http_request` tool enables the AI Agent to interact with any HTTP 611 | endpoint exposed by the Lisply backend (the following example works 612 | with our default backend, which has a built-in `/color-map` http 613 | endpoint): 614 | 615 | ```json 616 | { 617 | "path": "/color-map", 618 | "method": "GET", 619 | "headers": { 620 | "Accept": "application/json" 621 | } 622 | } 623 | ``` 624 | 625 | #### Ping Tool (`ping_lisp`) 626 | 627 | The `ping_lisp` tool lets Claude confirm that the Lisply server is 628 | running: 629 | 630 | ``` 631 | ping_lisp() 632 | ``` 633 | 634 | ## Real-World Examples 635 | 636 | ### Example 1: Creating a Parametric Box 637 | 638 | In this example, Claude creates a parametric box in the Lisply 639 | environment and then modifies its properties based on user 640 | requirements. 641 | 642 | **User**: "Can you create a box with width 10, height 5, and depth 3? 643 | Then show me how to change the height to 8." 644 | 645 | **Claude**: 646 | 647 | I'll create a parametric box using the lisp_eval tool, then show you 648 | how to modify its height. 649 | 650 | First, let's create the box with the specified dimensions: 651 | 652 | ```lisp 653 | (in-package :gdl-user) 654 | 655 | ;; First, create a box with the specified dimensions 656 | (defparameter *my-box* (make-object 'box 657 | :width 10 658 | :height 5 659 | :length 3)) 660 | 661 | ;; Let's verify the dimensions 662 | (list (theo *my-box* width) 663 | (theo *my-box* height) 664 | (theo *my-box* length)) 665 | ``` 666 | 667 | Now, let's change the height from 5 to 8: 668 | 669 | ```lisp 670 | ;; Change the height using setf with accessor 671 | (theo *my-box* (set-slot! :height 8)) 672 | 673 | ;; Alternatively, we could create a new box 674 | (defparameter *new-box* (make-object 'box 675 | :width 10 676 | :height 8 ;; Updated height 677 | :length 3)) 678 | 679 | ;; Verify the new dimensions of original box 680 | (list (theo *my-box* width) 681 | (theo *my-box* height) 682 | (theo *my-box* length)) 683 | ``` 684 | 685 | This box can be visualized by creating a web interface or using a 686 | built-in gendl visualization tool such as `geysr`. See [Gendl 687 | Documentation](https://gornschool.com) for details. 688 | 689 | 690 | ### Example 2: Demonstrating the Difference Between HTTP and Stdio Modes 691 | 692 | **User**: "Can you show me the difference between HTTP and stdio modes 693 | by evaluating a simple expression that prints something to standard 694 | output and returns a value?" 695 | 696 | **AI Agent**: 697 | 698 | I'll demonstrate the difference between HTTP and stdio modes by 699 | evaluating a simple Lisp expression that both prints output and 700 | returns a value. 701 | 702 | First, let's use HTTP mode (the default): 703 | 704 | ```lisp 705 | (progn 706 | (format t "This is a message to standard output~%") 707 | (+ 1 2 3)) 708 | ``` 709 | 710 | Response in HTTP mode: 711 | ``` 712 | {"Result": "6", "Stdout": "This is a message to standard output"} 713 | ``` 714 | 715 | Now, let's use stdio mode for the same expression: 716 | 717 | ```lisp 718 | ;; Using mode: stdio 719 | (progn 720 | (format t "This is a message to standard output~%") 721 | (+ 1 2 3)) 722 | ``` 723 | 724 | Response in stdio mode: 725 | ``` 726 | This is a message to standard output 727 | 6 728 | ``` 729 | 730 | Notice the difference: HTTP mode provides a structured response with 731 | labeled Result and Stdout sections, while stdio mode gives you the raw 732 | REPL output exactly as it appears in the Lisp REPL. 733 | 734 | Stdio mode is particularly useful for debugging because it can show 735 | you interactive debugger prompts. For example, if we introduce an 736 | error: 737 | 738 | ```lisp 739 | ;; Using mode: stdio 740 | (progn 741 | (format t "About to generate an error~%") 742 | (/ 1 0)) 743 | ``` 744 | 745 | In stdio mode, you might see something like: 746 | ``` 747 | About to generate an error 748 | > Error: Division by zero 749 | > While executing: / 750 | > Type :help for debugging options 751 | ``` 752 | 753 | This allows the LLM to interact with the debugger directly. In HTTP 754 | mode, you would just get an error message without the interactive 755 | capabilities. 756 | 757 | ## Troubleshooting 758 | 759 | ### Common Issues and Solutions 760 | 761 | #### Container Won't Start 762 | 763 | If the Lisply container fails to start: 764 | 765 | 1. Check if Docker is running: 766 | ```bash 767 | docker info 768 | ``` 769 | 770 | 2. Check if the ports are already in use: 771 | ```bash 772 | sudo lsof -i :4201 773 | sudo lsof -i :9081 774 | ``` 775 | 776 | 3. Verify that the Docker image exists: 777 | ```bash 778 | docker images | grep genworks 779 | ``` 780 | 781 | 4. Try pulling the image manually: 782 | ```bash 783 | docker pull genworks/gendl:master-ccl 784 | ``` 785 | 786 | #### Connection Errors 787 | 788 | If the LLM Agent / MCP Client cannot connect to the configured Lisply 789 | backend: 790 | 791 | 1. Check if the Lisply server is running: 792 | ```bash 793 | docker ps | grep lisply 794 | ``` 795 | 796 | 797 | 2. Check the wrapper's log file: 798 | ```bash 799 | tail -f /tmp/lisply-mcp-wrapper.log 800 | ``` 801 | 802 | 3. Check the Claude Desktop log file with Windows tools 803 | e.g. Notepad. This is typically in a location such as: 804 | 805 | WSL/Linux: 806 | ``` 807 | /mnt/c/Users//AppData/Roaming/Claude/logs/mcp-server-lisply.log 808 | ``` 809 | 810 | Windows: 811 | ``` 812 | c:\Users\\AppData\Roaming\Claude\logs\mcp-server-lisply.log 813 | ``` 814 | 815 | 816 | 5. Try curling to the Lisply HTTP server: 817 | ```bash 818 | curl http://localhost:9081/lisply/ping-lisp 819 | ``` 820 | 821 | 6. Try connecting to the Lisply SWANK server (on default port 4201): 822 | ```bash 823 | M-x slime-connect ;; from emacs 824 | ``` 825 | 826 | Note that the setting up the 827 | [Skewed-Emacs](https://github.com/gornskew/skewed-emacs) configuration 828 | will enable `M-x slime-connect` in your emacs. 829 | 830 | #### Permission Issues 831 | 832 | If you encounter permission errors: 833 | 834 | 1. Check Docker socket permissions: 835 | ```bash 836 | ls -l /var/run/docker.sock 837 | ``` 838 | 839 | 2. Make sure your user has permission to access Docker: 840 | ```bash 841 | sudo usermod -aG docker $USER 842 | ``` 843 | 844 | 3. Check mounted directory permissions: 845 | ```bash 846 | ls -l /path/to/mounted/directory 847 | ``` 848 | 849 | ### Diagnostic Commands 850 | 851 | Use these commands to diagnose general issues: 852 | 853 | 1. Check the middleware logs: 854 | ```bash 855 | tail -f /tmp/lisply-mcp-wrapper.log 856 | ``` 857 | 858 | 2. Check Docker container logs: 859 | ```bash 860 | docker logs $(docker ps --filter "name=lisply-mcp" --format "{{.ID}}") 861 | ``` 862 | 863 | 3. Check Lisply service status: 864 | ```bash 865 | curl http://localhost:9081/lisply/ping-lisp 866 | ``` 867 | 868 | 4. Verify Docker environment: 869 | ```bash 870 | docker system info 871 | ``` 872 | 873 | ## License 874 | 875 | This software is licensed under the GNU Affero General Public License 876 | v3.0 (AGPL-3.0), the same license used by Gendl. 877 | 878 | ### License Implications 879 | 880 | Simply using this MCP server to interact with a Lisply backend and 881 | obtain outputs does not trigger the requirements of the AGPL, e.g. you 882 | can use this wrapper to interact with Gendl without being required to 883 | share your code. 884 | 885 | However, if you modify or extend this wrapper, or a license-compatible 886 | Lisply backend such as Gendl, and wish to distribute and/or host a 887 | service based on that result (commercial or not), then the AGPL would 888 | require you to share your modifications with the downstream recipients 889 | or users. 890 | 891 | For applications that need to keep their source code closed, Genworks 892 | has begun offering an "escape clause" from AGPL restrictions for a 5% 893 | self-reported quarterly revenue royalty. More information and a 894 | payment gateway are available at 895 | [royalties.genworks.com](https://royalties.genworks.com). 896 | 897 | The full text of the license can be found in the COPYING.txt file in 898 | this directory. 899 | -------------------------------------------------------------------------------- /lisp-eval-examples.md: -------------------------------------------------------------------------------- 1 | # Lisp Evaluation Examples with Gendl 2 | 3 | The Lisply MCP wrapper provides a `lisp_eval` tool that allows you to 4 | evaluate Lisp code directly within the backend "Lisply-compliant" 5 | environment. The default environment configured with lisply-mcp is 6 | Gendl. This document provides examples of how to use this default 7 | Gendl backend. 8 | 9 | ## Basic Lisp Evaluation 10 | 11 | You can evaluate simple Lisp expressions: 12 | 13 | ```lisp 14 | (+ 1 2 3) 15 | ``` 16 | 17 | Result: `6` 18 | 19 | ## Working with Gendl Objects 20 | 21 | GDL (GENeral-purpose Declarative Language) is the core declarative 22 | modeling language in Gendl. Here are examples of defining and using 23 | GDL objects: 24 | 25 | **Note for the below examples:** 26 | 27 | `the` is a referencing macro used to access messages in the 28 | current object (implicit `self`). 29 | 30 | `theo` is a synonym for `the-object` and is used to access messages in 31 | an object that you give as an expression, e.g. a variable, as the 32 | first argument to `theo` e.g.: `(theo my-instance total-mass)` 33 | 34 | `(the ...)` expands exactly to `(the-object self ...)` 35 | 36 | 37 | ``` 38 | (the message-name) ; message to implicit self, message has no args. 39 | (the (message-name arg1 arg2)) ; implicit self message with args 40 | (theo object message-name) ; explicit object, message without args. 41 | (theo object (message-name arg1 arg2)) ; explicit object, message with args. 42 | 43 | ``` 44 | 45 | 46 | ### Defining a Simple Circle 47 | 48 | ```lisp 49 | (define-object my-circle (base-object) 50 | :input-slots (radius) 51 | :computed-slots 52 | ((area (* pi (expt (the radius) 2))) 53 | (circumference (* 2 pi (the radius))))) 54 | ``` 55 | 56 | Result: `#` 57 | 58 | ### Creating and Using a Circle Instance 59 | 60 | ```lisp 61 | (let ((my-circle (make-object 'circle :radius 5))) 62 | (list :area (theo my-circle area) 63 | :circumference (theo my-circle circumference))) 64 | ``` 65 | 66 | Result: `(:AREA 78.53981633974483 :CIRCUMFERENCE 31.41592653589793)` 67 | 68 | ### Defining a Box with Volume and Surface Area 69 | 70 | ```lisp 71 | (define-object box (base-object) 72 | :input-slots 73 | (length width height) 74 | :computed-slots 75 | ((volume (* (the length) (the width) (the height))) 76 | (surface-area (* 2 (+ (* (the length) (the width)) 77 | (* (the length) (the height)) 78 | (* (the width) (the height))))))) 79 | ``` 80 | 81 | Result: `#` 82 | 83 | ### Computing Box Properties 84 | 85 | ```lisp 86 | (let ((box (make-object 'box :length 5 :width 3 :height 2))) 87 | (list :volume (theo box volume) 88 | :surface-area (theo box surface-area))) 89 | ``` 90 | 91 | Result: `(:VOLUME 30 :SURFACE-AREA 62)` 92 | 93 | ## Using Gendl via Claude 94 | 95 | When interacting with Claude, you can ask it to evaluate Lisp code in Gendl using the `lisp_eval` tool. For example: 96 | 97 | ``` 98 | User: Could you calculate the volume of a box with dimensions 10x5x3? 99 | 100 | Claude: I'll calculate the volume of a box with those dimensions using Gendl: 101 | 102 | [Claude calls lisp_eval with appropriate code] 103 | 104 | The volume of a box with dimensions 10x5x3 is 150 cubic units. 105 | ``` 106 | 107 | ## Common Usage Patterns 108 | 109 | 1. **Define a GDL Object**: First define your GDL object with its properties 110 | 2. **Create an Instance**: Use `make-self` to create an instance with specific parameters 111 | 3. **Access Properties**: Use `the-object` to access computed properties 112 | 113 | ## Tips and Best Practices 114 | 115 | - Use `define-object` to create reusable object templates 116 | - Separate input slots (parameters) from computed slots (derived values) 117 | - When evaluating expressions, wrap them in `let` bindings to create a clean scope 118 | - Use `make-self` for creating instances in the evaluation context 119 | - Access properties with `the-object` rather than `the` when in a separate context 120 | -------------------------------------------------------------------------------- /scripts/handlers/httpRequest.js: -------------------------------------------------------------------------------- 1 | /** 2 | * httpRequest.js 3 | * 4 | * Handler for HTTP request tool 5 | */ 6 | 7 | const { makeHttpRequest } = require('../lib/server'); 8 | const { sendTextResponse, sendErrorResponse } = require('../lib/utils'); 9 | 10 | /** 11 | * Handle HTTP request with support for all methods and bodies 12 | * @param {Object} request - MCP request 13 | * @param {Object} args - Tool arguments 14 | * @param {Object} config - Configuration object 15 | * @param {Object} logger - Logger instance 16 | */ 17 | async function handleHttpRequest(request, args, config, logger) { 18 | logger.info(`Handling http_request: ${JSON.stringify(args)}`); 19 | 20 | try { 21 | // Check for required path parameter 22 | if (!args.path) { 23 | sendErrorResponse(request, -32602, "Missing required parameter: path", logger); 24 | return; 25 | } 26 | 27 | // Prepare the request options 28 | const options = { 29 | hostname: config.BACKEND_HOST, 30 | port: config.HTTP_HOST_PORT, 31 | path: args.path, 32 | method: args.method || 'GET', 33 | headers: { 34 | 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8' 35 | } 36 | }; 37 | 38 | // Support both 'body' and 'content' parameters (content takes precedence if both are provided) 39 | const requestBody = args.content !== undefined ? args.content : args.body; 40 | 41 | // Add custom headers if provided 42 | if (args.headers && typeof args.headers === 'object') { 43 | options.headers = { ...options.headers, ...args.headers }; 44 | } 45 | 46 | // If Content-Type is not specified for POST/PUT and we have a body, default to application/json 47 | if (['POST', 'PUT'].includes(options.method) && requestBody && 48 | !options.headers['Content-Type'] && !options.headers['content-type']) { 49 | options.headers['Content-Type'] = 'application/json'; 50 | } 51 | 52 | makeHttpRequest(options, requestBody, (error, response) => { 53 | if (error) { 54 | logger.error(`HTTP request error: ${error.message}`); 55 | sendErrorResponse(request, -32603, `Error making HTTP request: ${error.message}`, logger); 56 | return; 57 | } 58 | 59 | // If rawResponse is set, return the full response object 60 | if (args.rawResponse) { 61 | sendTextResponse(request, JSON.stringify(response, null, 2), logger); 62 | } else { 63 | // Otherwise, return just the content 64 | sendTextResponse(request, response.content, logger); 65 | } 66 | }, null, logger); 67 | } catch (error) { 68 | logger.error(`Error in http_request: ${error.message}`); 69 | sendErrorResponse(request, -32603, `Error making HTTP request: ${error.message}`, logger); 70 | } 71 | } 72 | 73 | module.exports = { 74 | handleHttpRequest 75 | }; -------------------------------------------------------------------------------- /scripts/handlers/index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * index.js 3 | * 4 | * Exports all handlers for the MCP wrapper 5 | */ 6 | 7 | const { handleInitialize } = require('./initialize'); 8 | const { handleToolsList } = require('./toolsList'); 9 | const { handleToolCall } = require('./toolCall'); 10 | const { handleHttpRequest } = require('./httpRequest'); 11 | const { handlePingLisp } = require('./ping'); 12 | const { handleLispEval } = require('./lispEval'); 13 | const { sendTextResponse, sendStandardResponse, sendErrorResponse } = require('../lib/utils'); 14 | 15 | module.exports = { 16 | handleInitialize, 17 | handleToolsList, 18 | handleToolCall, 19 | handleHttpRequest, 20 | handlePingLisp, 21 | handleLispEval, 22 | sendTextResponse, 23 | sendStandardResponse, 24 | sendErrorResponse 25 | }; -------------------------------------------------------------------------------- /scripts/handlers/initialize.js: -------------------------------------------------------------------------------- 1 | /** 2 | * initialize.js 3 | * 4 | * Handler for MCP initialization 5 | */ 6 | 7 | const { sendResponse } = require('../lib/utils'); 8 | 9 | /** 10 | * Handle MCP initialization 11 | * @param {Object} request - MCP request 12 | * @param {Object} config - Configuration object 13 | * @param {Object} logger - Logger instance 14 | */ 15 | function handleInitialize(request, config, logger) { 16 | logger.info('Handling initialize request'); 17 | 18 | // Send successful initialization response 19 | const response = { 20 | jsonrpc: '2.0', 21 | id: request.id, 22 | result: { 23 | protocolVersion: request.params.protocolVersion || '0.1.0', 24 | capabilities: { 25 | experimental: {}, 26 | prompts: { listChanged: false }, 27 | resources: { subscribe: false, listChanged: false }, 28 | tools: { listChanged: false } 29 | }, 30 | serverInfo: { 31 | name: 'lisply-mcp', 32 | version: config.VERSION 33 | } 34 | } 35 | }; 36 | 37 | sendResponse(response, logger); 38 | logger.info('Initialization complete'); 39 | } 40 | 41 | module.exports = { 42 | handleInitialize 43 | }; -------------------------------------------------------------------------------- /scripts/handlers/lispEval.js: -------------------------------------------------------------------------------- 1 | /** 2 | * lispEval.js 3 | * 4 | * Handler for lisp_eval tool 5 | */ 6 | 7 | const { makeHttpRequest } = require('../lib/server'); 8 | const { tryAttachToContainer } = require('../lib/docker'); 9 | const { sendTextResponse, sendErrorResponse } = require('../lib/utils'); 10 | const { exec } = require('child_process'); 11 | 12 | /** 13 | * Handle lisp_eval tool with either HTTP or stdio based on mode parameter 14 | * @param {Object} request - MCP request 15 | * @param {Object} args - Tool arguments 16 | * @param {Object} config - Configuration object 17 | * @param {Object} logger - Logger instance 18 | */ 19 | function handleLispEval(request, args, config, logger) { 20 | logger.info(`Handling lisp_eval with code: ${args.code?.substring(0, 100)}${args.code?.length > 100 ? '...' : ''}`); 21 | 22 | try { 23 | // Check for required parameter 24 | if (!args.code) { 25 | sendErrorResponse(request, -32602, "Missing required parameter: code", logger); 26 | return; 27 | } 28 | 29 | // Check the mode parameter (default to 'http' if not specified) 30 | const requestedMode = (args.mode || 'http').toLowerCase(); 31 | logger.info(`Requested mode: ${requestedMode}`); 32 | 33 | // Check if we should use stdio for local containers 34 | const isLocalHost = (config.BACKEND_HOST === '127.0.0.1' || config.BACKEND_HOST === 'localhost'); 35 | 36 | // First check if we already have a direct stdio connection 37 | let canUseStdio = isLocalHost && global.dockerProcess && ! config.NO_USE_STDIO; 38 | 39 | // If we don't have a direct connection but stdio is enabled, try to find and attach to the container 40 | if (isLocalHost && !global.dockerProcess && !config.NO_USE_STDIO && requestedMode === 'stdio') { 41 | canUseStdio = tryAttachToContainer(config, logger); 42 | } 43 | 44 | // Check if this is a debugger command 45 | const isDebuggerCommand = args.debugger_mode === true; 46 | 47 | // If mode is explicitly set to stdio and we can't use stdio, we should warn about it 48 | if (requestedMode === 'stdio' && !canUseStdio) { 49 | logger.warn(`Stdio mode requested but not available. Will use HTTP mode instead.`); 50 | } 51 | 52 | // Determine which mode to use based on requested mode and availability 53 | const useStdio = (requestedMode === 'stdio' && canUseStdio); 54 | 55 | if (useStdio) { 56 | // Use stdin/stdout communication with the Docker container 57 | if (isDebuggerCommand) { 58 | logger.info(`Using stdio for Lisp debugger command with local container`); 59 | } else { 60 | logger.info(`Using stdio for Lisp evaluation with local container`); 61 | } 62 | handleLispEvalViaStdio(request, args, config, logger); 63 | } else { 64 | // Debugger mode requires stdio 65 | if (isDebuggerCommand) { 66 | logger.error(`Debugger mode requires local container with stdio enabled`); 67 | sendErrorResponse(request, -32603, `Debugger mode requires local container with stdio enabled`, logger); 68 | return; 69 | } 70 | 71 | // Use HTTP communication 72 | logger.info(`Using HTTP for Lisp evaluation with ${config.BACKEND_HOST}`); 73 | handleLispEvalViaHttp(request, args, config, logger); 74 | } 75 | } catch (error) { 76 | logger.error(`Error in lisp_eval: ${error.message}`); 77 | if (error.stack) { 78 | logger.error(`Error stack: ${error.stack}`); 79 | } 80 | sendErrorResponse(request, -32603, `Error evaluating Lisp code: ${error.message}`, logger); 81 | } 82 | } 83 | 84 | /** 85 | * Handle lisp_eval tool using stdio with local Docker container 86 | * @param {Object} request - MCP request 87 | * @param {Object} args - Tool arguments 88 | * @param {Object} config - Configuration object 89 | * @param {Object} logger - Logger instance 90 | */ 91 | function handleLispEvalViaStdio(request, args, config, logger) { 92 | // Safety check for dockerProcess 93 | if (!global.dockerProcess || !global.dockerProcess.stdin || !global.dockerProcess.stdout) { 94 | logger.error('Docker process or its stdio streams are not available'); 95 | return handleLispEvalViaHttp(request, args, config, logger); // Fallback to HTTP 96 | } 97 | 98 | const lisp_expr = args.code; 99 | const packageName = args.package || 'COMMON-LISP-USER'; 100 | 101 | logger.info(`Sending Lisp expression to container REPL via stdio`); 102 | 103 | // Add package prefix if requested 104 | const fullExpr = packageName !== 'COMMON-LISP-USER' 105 | ? `(in-package :${packageName}) ${lisp_expr}` 106 | : lisp_expr; 107 | 108 | // Set up variables to capture the response 109 | let responseData = ''; 110 | let isEvaluationComplete = false; 111 | let responseTimeout = null; 112 | 113 | // Prepare event handlers for stdout data 114 | const stdoutDataHandler = (data) => { 115 | const output = data.toString(); 116 | logger.debug(`REPL output: ${output}`); 117 | 118 | // Collect all output 119 | responseData += output; 120 | 121 | // Log the current state 122 | logger.debug(`Current responseData: ${responseData}`); 123 | 124 | // Look for prompt in both the entire response and just this output chunk 125 | const responseTrimmed = responseData.trim(); 126 | const outputTrimmed = output.trim(); 127 | const debuggerPrompt = config.DEBUGGER_PROMPTS[config.LISP_IMPL]; 128 | 129 | // Log what we're looking for 130 | logger.debug(`Looking for REPL prompt: '${config.REPL_PROMPT}' or debugger prompt: '${debuggerPrompt}'`); 131 | 132 | // Check for regular REPL prompt in both places 133 | const outputEndsWithPrompt = outputTrimmed.endsWith(config.REPL_PROMPT); 134 | const responseEndsWithPrompt = responseTrimmed.endsWith(config.REPL_PROMPT); 135 | const isReplPrompt = outputEndsWithPrompt || responseEndsWithPrompt; 136 | 137 | // Check for debugger prompt 138 | const isDebuggerPrompt = debuggerPrompt && ( 139 | outputTrimmed.endsWith(debuggerPrompt) || 140 | responseTrimmed.endsWith(debuggerPrompt) || 141 | outputTrimmed.includes(debuggerPrompt) 142 | ); 143 | 144 | // Log detection status 145 | logger.debug(`Prompt detection - outputEndsWithPrompt: ${outputEndsWithPrompt}, responseEndsWithPrompt: ${responseEndsWithPrompt}, isDebuggerPrompt: ${isDebuggerPrompt}`); 146 | 147 | // Only complete when we see a prompt 148 | if (isReplPrompt || isDebuggerPrompt) { 149 | if (isReplPrompt) { 150 | logger.info('Detected REPL prompt - evaluation complete'); 151 | } else { 152 | logger.info('Detected debugger prompt - evaluation entered debugger'); 153 | } 154 | 155 | // Prevent multiple completions 156 | if (isEvaluationComplete) { 157 | logger.debug('Evaluation already marked as complete, skipping processing'); 158 | return; 159 | } 160 | 161 | isEvaluationComplete = true; 162 | clearTimeout(responseTimeout); 163 | 164 | // Remove the stdout data handler to prevent capturing unrelated output 165 | logger.info('Removing stdout data handler'); 166 | global.dockerProcess.stdout.removeListener('data', stdoutDataHandler); 167 | 168 | // Clean up response 169 | let cleanedResponse = responseData; 170 | 171 | // For regular REPL prompt, just remove it 172 | if (isReplPrompt) { 173 | try { 174 | // Try to extract the result - everything before the prompt 175 | const promptIndex = responseData.lastIndexOf(config.REPL_PROMPT); 176 | if (promptIndex > 0) { 177 | // Find the last newline before the prompt 178 | const lastNewline = responseData.lastIndexOf('\n', promptIndex); 179 | if (lastNewline > 0) { 180 | // Get the text between the last newline and the prompt 181 | cleanedResponse = responseData.substring(0, lastNewline).trim(); 182 | } else { 183 | // Just remove the prompt if no newline 184 | cleanedResponse = responseData.replace(new RegExp(config.REPL_PROMPT + '$'), '').trim(); 185 | } 186 | } else { 187 | // Fallback to simple replacement 188 | cleanedResponse = responseData.replace(new RegExp(config.REPL_PROMPT + '$'), '').trim(); 189 | } 190 | } catch (e) { 191 | logger.error(`Error cleaning response: ${e.message}`); 192 | cleanedResponse = responseData.trim(); 193 | } 194 | } 195 | // For debugger prompt, keep it in the response 196 | else if (isDebuggerPrompt) { 197 | // Just trim whitespace 198 | cleanedResponse = responseData.trim(); 199 | } 200 | 201 | logger.info(`Lisp evaluation complete, response length: ${cleanedResponse.length}`); 202 | logger.info(`Response content: "${cleanedResponse}"`); 203 | logger.info(`Debugger detected: ${isDebuggerPrompt}`); 204 | 205 | // Add debugger metadata to help the LLM 206 | if (isDebuggerPrompt) { 207 | // Create a response with metadata about the debugger state 208 | const responseWithMetadata = { 209 | output: cleanedResponse, 210 | debugger: { 211 | active: true, 212 | implementation: config.LISP_IMPL, 213 | prompt: debuggerPrompt 214 | } 215 | }; 216 | 217 | try { 218 | logger.info('Sending debugger response to LLM'); 219 | sendTextResponse(request, responseWithMetadata, logger); 220 | logger.info('Debugger response sent successfully'); 221 | } catch (error) { 222 | logger.error(`Error sending debugger response: ${error.message}`); 223 | } 224 | } else { 225 | // Regular response without debugger 226 | try { 227 | logger.info('Sending regular response to LLM'); 228 | sendTextResponse(request, cleanedResponse, logger); 229 | logger.info('Regular response sent successfully'); 230 | } catch (error) { 231 | logger.error(`Error sending regular response: ${error.message}`); 232 | } 233 | } 234 | } 235 | }; 236 | 237 | // Set up timeout for evaluation 238 | responseTimeout = setTimeout(() => { 239 | if (!isEvaluationComplete) { 240 | logger.warn(`Lisp evaluation timed out after ${config.EVAL_TIMEOUT}ms`); 241 | global.dockerProcess.stdout.removeListener('data', stdoutDataHandler); 242 | 243 | // Send what we have so far plus timeout message 244 | const timeoutResponse = responseData + "\n;; ERROR: Evaluation timed out"; 245 | sendTextResponse(request, timeoutResponse, logger); 246 | } 247 | }, config.EVAL_TIMEOUT); 248 | 249 | // Set up error handler 250 | const errorHandler = (error) => { 251 | logger.error(`Error during Lisp evaluation via stdio: ${error.message}`); 252 | clearTimeout(responseTimeout); 253 | global.dockerProcess.stdout.removeListener('data', stdoutDataHandler); 254 | sendErrorResponse(request, -32603, `Error during Lisp evaluation: ${error.message}`, logger); 255 | }; 256 | 257 | // Attach the stdout data handler 258 | global.dockerProcess.stdout.on('data', stdoutDataHandler); 259 | 260 | // Handle potential errors 261 | global.dockerProcess.stdin.once('error', errorHandler); 262 | global.dockerProcess.stdout.once('error', errorHandler); 263 | 264 | // Send the Lisp code to the container's stdin 265 | try { 266 | // Check if dockerProcess is still valid and writable 267 | if (!global.dockerProcess || !global.dockerProcess.stdin || !global.dockerProcess.stdin.writable) { 268 | logger.error('Docker process is no longer available or stdin is not writable'); 269 | 270 | // Try to reattach to the container if it exists but our connection was lost 271 | if (global.backendContainerName && !global.dockerProcess) { 272 | logger.info(`Attempting to reattach to container ${global.backendContainerName}`); 273 | // Check if container is still running 274 | exec(`docker ps --filter "name=${global.backendContainerName}" --format "{{.ID}}"`, (error, stdout, stderr) => { 275 | if (!error && stdout.trim()) { 276 | logger.info(`Container ${global.backendContainerName} is still running, reattaching`); 277 | tryAttachToContainer(config, logger); 278 | } else { 279 | logger.error(`Container ${global.backendContainerName} is no longer running`); 280 | return handleLispEvalViaHttp(request, args, config, logger); // Fall back to HTTP 281 | } 282 | }); 283 | } else { 284 | return handleLispEvalViaHttp(request, args, config, logger); // Fall back to HTTP 285 | } 286 | } 287 | 288 | // Send a newline first to ensure we're at a fresh prompt 289 | logger.debug('Sending initial newline to REPL'); 290 | global.dockerProcess.stdin.write('\n'); 291 | 292 | // Then send the actual Lisp code with a newline 293 | logger.debug(`Sending Lisp expression: ${fullExpr}`); 294 | global.dockerProcess.stdin.write(fullExpr + '\n'); 295 | 296 | // Keep stdin open 297 | logger.debug('Keeping stdin open after sending Lisp code'); 298 | 299 | logger.debug(`Sent Lisp code to container: ${fullExpr}`); 300 | } catch (error) { 301 | logger.error(`Error sending code to container: ${error.message}`); 302 | errorHandler(error); 303 | } 304 | } 305 | 306 | /** 307 | * Handle lisp_eval tool with HTTP request (original implementation) 308 | * @param {Object} request - MCP request 309 | * @param {Object} args - Tool arguments 310 | * @param {Object} config - Configuration object 311 | * @param {Object} logger - Logger instance 312 | */ 313 | function handleLispEvalViaHttp(request, args, config, logger) { 314 | // Create JSON payload for the request 315 | const payload = JSON.stringify({ 316 | code: args.code, 317 | ...(args.package && { package: args.package }) 318 | }); 319 | 320 | // HTTP POST to lisp-eval endpoint with proper content type 321 | const options = { 322 | hostname: config.BACKEND_HOST, 323 | port: config.HTTP_HOST_PORT, 324 | path: config.EVAL_ENDPOINT, 325 | method: 'POST', 326 | headers: { 327 | 'Content-Type': 'application/json', 328 | 'Content-Length': Buffer.byteLength(payload) 329 | } 330 | }; 331 | 332 | // Use the common HTTP request helper 333 | makeHttpRequest(options, payload, (error, response) => { 334 | if (error) { 335 | logger.error(`Error evaluating Lisp code: ${error.message}`); 336 | sendErrorResponse(request, -32603, `Error evaluating Lisp code: ${error.message}`, logger); 337 | return; 338 | } 339 | 340 | // Process the response 341 | try { 342 | // Try to parse as JSON 343 | const result = JSON.parse(response.content); 344 | 345 | // Handle success/error based on the JSON structure 346 | if ('success' in result) { 347 | if (result.success) { 348 | logger.info(`Lisp eval success result: ${result.result}`); 349 | sendTextResponse(request, `Result: ${result.result}, Stdout: ${result.stdout}`, logger); 350 | } else { 351 | logger.error(`Lisp eval error result: ${result.error || "Unknown error"}`); 352 | sendErrorResponse(request, -32603, `Error evaluating Lisp code: ${result.error || "Unknown error"}`, logger); 353 | } 354 | } else { 355 | // Not a standard success/error format, return as-is 356 | logger.info(`Non-standard JSON format, returning as-is`); 357 | sendTextResponse(request, JSON.stringify(result, null, 2), logger); 358 | } 359 | } catch (e) { 360 | // Not JSON, treat as text 361 | logger.info(`Response is not JSON: ${e.message}`); 362 | sendTextResponse(request, response.content, logger); 363 | } 364 | }, 'LISP-EVAL', logger); 365 | } 366 | 367 | module.exports = { 368 | handleLispEval, 369 | handleLispEvalViaStdio, 370 | handleLispEvalViaHttp 371 | }; 372 | -------------------------------------------------------------------------------- /scripts/handlers/ping.js: -------------------------------------------------------------------------------- 1 | /** 2 | * ping.js 3 | * 4 | * Handler for ping_lisp tool 5 | */ 6 | 7 | const { makeHttpRequest } = require('../lib/server'); 8 | const { sendTextResponse, sendErrorResponse } = require('../lib/utils'); 9 | 10 | /** 11 | * Handle simple ping_lisp tool 12 | * @param {Object} request - MCP request 13 | * @param {Object} config - Configuration object 14 | * @param {Object} logger - Logger instance 15 | */ 16 | function handlePingLisp(request, config, logger) { 17 | logger.info('Handling ping_lisp request'); 18 | 19 | const options = { 20 | hostname: config.BACKEND_HOST, 21 | port: config.HTTP_HOST_PORT, 22 | path: config.PING_ENDPOINT, 23 | method: 'GET' 24 | }; 25 | 26 | makeHttpRequest(options, null, (error, response) => { 27 | if (error) { 28 | logger.error(`Error pinging backend server: ${error.message}`); 29 | sendErrorResponse(request, -32603, `Error pinging backend server: ${error.message}`, logger); 30 | return; 31 | } 32 | 33 | // Just return the raw text response 34 | sendTextResponse(request, response.content, logger); 35 | }, 'PING', logger); 36 | } 37 | 38 | module.exports = { 39 | handlePingLisp 40 | }; -------------------------------------------------------------------------------- /scripts/handlers/toolCall.js: -------------------------------------------------------------------------------- 1 | /** 2 | * toolCall.js 3 | * 4 | * Handler for tools/call requests 5 | */ 6 | 7 | const { sendErrorResponse } = require('../lib/utils'); 8 | const { handleHttpRequest } = require('./httpRequest'); 9 | const { handlePingLisp } = require('./ping'); 10 | const { handleLispEval } = require('./lispEval'); 11 | 12 | /** 13 | * Handle tool calls 14 | * @param {Object} request - MCP request 15 | * @param {Object} config - Configuration object 16 | * @param {Object} logger - Logger instance 17 | */ 18 | async function handleToolCall(request, config, logger) { 19 | const toolName = request.params?.name; 20 | const args = request.params?.arguments || {}; 21 | 22 | logger.info(`Handling tool call: ${toolName}`); 23 | 24 | try { 25 | // Special handling for each tool 26 | if (toolName === 'http_request') { 27 | return handleHttpRequest(request, args, config, logger); 28 | } else if (toolName === 'ping_lisp') { 29 | return handlePingLisp(request, config, logger); 30 | } else if (toolName === 'lisp_eval') { 31 | return handleLispEval(request, args, config, logger); 32 | // Removed KB query handler 33 | } else { 34 | // Unknown tool 35 | sendErrorResponse(request, -32601, `Unknown tool: ${toolName}`, logger); 36 | } 37 | } catch (error) { 38 | logger.error(`Error in tool call: ${error.message}`); 39 | sendErrorResponse(request, -32603, `Error calling tool: ${error.message}`, logger); 40 | } 41 | } 42 | 43 | module.exports = { 44 | handleToolCall 45 | }; -------------------------------------------------------------------------------- /scripts/handlers/toolsList.js: -------------------------------------------------------------------------------- 1 | /** 2 | * toolsList.js 3 | * 4 | * Handler for tools/list requests 5 | */ 6 | 7 | 8 | 9 | /** 10 | * toolsList.js 11 | * 12 | * Handler for tools/list requests 13 | */ 14 | 15 | const { makeHttpRequest } = require('../lib/server'); 16 | const { sendStandardResponse, sendErrorResponse } = require('../lib/utils'); 17 | 18 | /** 19 | * Handle tool list requests 20 | * @param {Object} request - MCP request 21 | * @param {Object} config - Configuration object 22 | * @param {Object} logger - Logger instance 23 | */ 24 | function handleToolsList(request, config, logger) { 25 | logger.info('Handling tools/list request'); 26 | 27 | const options = { 28 | hostname: config.BACKEND_HOST, 29 | port: config.HTTP_HOST_PORT, 30 | path: `${config.BASE_PATH}/tools/list`, 31 | method: 'GET' 32 | }; 33 | 34 | makeHttpRequest(options, null, (error, response) => { 35 | if (error) { 36 | logger.error(`Error fetching tools list: ${error.message}`); 37 | sendErrorResponse(request, -32603, `Error fetching tools list: ${error.message}`, logger); 38 | return; 39 | } 40 | 41 | try { 42 | const toolsData = JSON.parse(response.content); 43 | 44 | // Validate the response structure 45 | if (!toolsData.tools || !Array.isArray(toolsData.tools)) { 46 | throw new Error('Invalid tools list response format'); 47 | } 48 | 49 | // Add 'mode' parameter to lisp_eval tool if it exists 50 | for (let i = 0; i < toolsData.tools.length; i++) { 51 | const tool = toolsData.tools[i]; 52 | 53 | if (tool.name === 'lisp_eval' && 54 | tool.inputSchema && 55 | tool.inputSchema.properties) { 56 | 57 | // Add mode parameter if it doesn't exist 58 | if (!tool.inputSchema.properties.mode) { 59 | logger.debug('Adding "mode" parameter to lisp_eval tool definition'); 60 | 61 | tool.inputSchema.properties.mode = { 62 | "type": "string", 63 | "description": "The mode to use to talk to Gendl, either http (default) or stdio.\nStdio will only be respected for local Gendl containers started by the MCP server itself." 64 | }; 65 | } 66 | } 67 | } 68 | 69 | // Add http_request tool if it doesn't exist 70 | const hasHttpRequestTool = toolsData.tools.some(tool => tool.name === 'http_request'); 71 | 72 | if (!hasHttpRequestTool) { 73 | logger.debug('Adding http_request tool to tools list'); 74 | 75 | toolsData.tools.push({ 76 | "name": "http_request", 77 | "description": "Send an HTTP request to the specified path", 78 | "inputSchema": { 79 | "type": "object", 80 | "properties": { 81 | "path": { 82 | "type": "string", 83 | "description": "The path to send the request to" 84 | }, 85 | "method": { 86 | "type": "string", 87 | "description": "The HTTP method to use (GET, POST, PUT, DELETE, etc.)" 88 | }, 89 | "body": { 90 | "type": "string", 91 | "description": "The request body content (for POST/PUT requests)" 92 | }, 93 | "content": { 94 | "type": "string", 95 | "description": "Alternative name for the request body content (for compatibility)" 96 | }, 97 | "headers": { 98 | "type": "object", 99 | "description": "Optional headers to include with the request" 100 | }, 101 | "rawResponse": { 102 | "type": "boolean", 103 | "description": "If true, return the full response object instead of just the content" 104 | } 105 | }, 106 | "required": ["path"] 107 | } 108 | }); 109 | } 110 | 111 | sendStandardResponse(request, toolsData, logger); 112 | } catch (parseError) { 113 | logger.error(`Error parsing tools list: ${parseError.message}`); 114 | sendErrorResponse(request, -32603, `Error parsing tools list: ${parseError.message}`, logger); 115 | } 116 | }, 'TOOLS-LIST', logger); 117 | } 118 | 119 | module.exports = { 120 | handleToolsList 121 | }; 122 | 123 | 124 | 125 | /* 126 | const { makeHttpRequest } = require('../lib/server'); 127 | const { sendStandardResponse, sendErrorResponse } = require('../lib/utils'); 128 | 129 | */ 130 | 131 | /** 132 | * Handle tool list requests 133 | * @param {Object} request - MCP request 134 | * @param {Object} config - Configuration object 135 | * @param {Object} logger - Logger instance 136 | */ 137 | 138 | /* 139 | function handleToolsList(request, config, logger) { 140 | logger.info('Handling tools/list request'); 141 | 142 | const options = { 143 | hostname: config.BACKEND_HOST, 144 | port: config.HTTP_HOST_PORT, 145 | path: `${config.BASE_PATH}/tools/list`, 146 | method: 'GET' 147 | }; 148 | 149 | makeHttpRequest(options, null, (error, response) => { 150 | if (error) { 151 | logger.error(`Error fetching tools list: ${error.message}`); 152 | sendErrorResponse(request, -32603, `Error fetching tools list: ${error.message}`, logger); 153 | return; 154 | } 155 | 156 | try { 157 | const toolsData = JSON.parse(response.content); 158 | 159 | // Validate the response structure 160 | if (!toolsData.tools || !Array.isArray(toolsData.tools)) { 161 | throw new Error('Invalid tools list response format'); 162 | } 163 | 164 | sendStandardResponse(request, toolsData, logger); 165 | } catch (parseError) { 166 | logger.error(`Error parsing tools list: ${parseError.message}`); 167 | sendErrorResponse(request, -32603, `Error parsing tools list: ${parseError.message}`, logger); 168 | } 169 | }, 'TOOLS-LIST', logger); 170 | } 171 | 172 | module.exports = { 173 | handleToolsList 174 | }; 175 | 176 | */ 177 | -------------------------------------------------------------------------------- /scripts/lib/config.js: -------------------------------------------------------------------------------- 1 | /** 2 | * config.js 3 | * 4 | * Configuration functions for the MCP wrapper 5 | */ 6 | 7 | const fs = require('fs'); 8 | const path = require('path'); 9 | const { exec, execSync } = require('child_process'); 10 | 11 | /** 12 | * Helper function to collect multiple mount options 13 | * @param {string} value - The value to collect 14 | * @param {Array} previous - The previous values 15 | * @returns {Array} The concatenated array 16 | */ 17 | function collect(value, previous) { 18 | return previous.concat([value]); 19 | } 20 | 21 | /** 22 | * Helper function to get environment variables with multiple possible prefixes 23 | * @param {string} name - Base name of the environment variable 24 | * @param {*} defaultValue - Default value if no environment variable is found 25 | * @param {Array} prefixes - Prefixes to try (in order of preference) 26 | * @param {function} transform - Optional function to transform the value 27 | * @returns {*} The environment variable value or default 28 | */ 29 | function getEnvVar(name, defaultValue, prefixes = ['', 'LISPLY_'], transform = null) { 30 | // Try each prefix in order 31 | for (const prefix of prefixes) { 32 | const fullName = `${prefix}${name}`; 33 | if (process.env[fullName] !== undefined) { 34 | const value = process.env[fullName]; 35 | return transform ? transform(value) : value; 36 | } 37 | } 38 | 39 | // Fall back to default if no environment variable is found 40 | return defaultValue; 41 | } 42 | 43 | /** 44 | * Helper function to parse boolean environment variables 45 | * @param {string} value - The environment variable value 46 | * @param {boolean} defaultValue - Default value if parsing fails 47 | * @returns {boolean} The parsed boolean value 48 | */ 49 | function parseBool(value, defaultValue = false) { 50 | if (value === undefined || value === null) return defaultValue; 51 | if (typeof value === 'boolean') return value; 52 | if (typeof value === 'number') return value !== 0; 53 | if (typeof value === 'string') { 54 | const lowered = value.toLowerCase().trim(); 55 | if (lowered === 'true' || lowered === 'yes' || lowered === '1') return true; 56 | if (lowered === 'false' || lowered === 'no' || lowered === '0') return false; 57 | } 58 | return defaultValue; 59 | } 60 | 61 | /** 62 | * Helper function to parse integer environment variables 63 | * @param {string} value - The environment variable value 64 | * @param {number} defaultValue - Default value if parsing fails 65 | * @param {number} min - Optional minimum value 66 | * @param {number} max - Optional maximum value 67 | * @returns {number} The parsed integer value 68 | */ 69 | function parseInt10(value, defaultValue, min = null, max = null) { 70 | if (value === undefined || value === null) return defaultValue; 71 | if (typeof value === 'number') { 72 | const intValue = Math.floor(value); 73 | if (min !== null && intValue < min) return min; 74 | if (max !== null && intValue > max) return max; 75 | return intValue; 76 | } 77 | try { 78 | const intValue = parseInt(value, 10); 79 | if (isNaN(intValue)) return defaultValue; 80 | if (min !== null && intValue < min) return min; 81 | if (max !== null && intValue > max) return max; 82 | return intValue; 83 | } catch (e) { 84 | return defaultValue; 85 | } 86 | } 87 | 88 | /** 89 | * Helper to safely execute git commands with improved error handling 90 | * @param {string} cmd - The command to execute 91 | * @param {boolean} logError - Whether to log errors (default: true) 92 | * @returns {string|null} - The command output or null if error 93 | */ 94 | function safeExec(cmd, logError = true) { 95 | try { 96 | return execSync(cmd, { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }).trim(); 97 | } catch (error) { 98 | if (logError) { 99 | // Log at debug level to avoid cluttering logs with expected errors 100 | process.stderr.write(`[DEBUG] Error executing command: ${cmd}. Error: ${error.message}\n`); 101 | 102 | // Add more details at trace level if available 103 | if (error.stderr) { 104 | process.stderr.write(`[DEBUG] Command stderr: ${error.stderr}\n`); 105 | } 106 | } 107 | return null; 108 | } 109 | } 110 | 111 | /** 112 | * Get git branch information with multiple detection methods and fallbacks 113 | * @param {Object} options - Command line options 114 | * @returns {string} - The detected branch name or default branch 115 | */ 116 | function getGitBranch(options) { 117 | // Provide a default for the default branch 118 | const DEFAULT_BRANCH = 'master'; 119 | 120 | // Try git command first (most reliable) 121 | // Run the git command from the project root 122 | const projectRoot = path.join(__dirname, '..', '..'); 123 | const branch = safeExec(`cd "${projectRoot}" && git rev-parse --abbrev-ref HEAD`); 124 | if (branch && branch !== 'HEAD') { 125 | process.stderr.write(`[INFO] Git branch detected via command: ${branch}\n`); 126 | return branch; 127 | } 128 | 129 | // Fallback to reading .git/HEAD file directly 130 | try { 131 | const gitHeadContent = fs.readFileSync(path.join(__dirname, '..', '..', '.git', 'HEAD'), 'utf8').trim(); 132 | if (gitHeadContent.startsWith('ref: refs/heads/')) { 133 | const branchName = gitHeadContent.substring('ref: refs/heads/'.length); 134 | process.stderr.write(`[INFO] Git branch detected via HEAD file: ${branchName}\n`); 135 | return branchName; 136 | } 137 | } catch (error) { 138 | process.stderr.write(`[DEBUG] Could not read .git/HEAD file: ${error.message}\n`); 139 | } 140 | 141 | // Final fallback to default branch 142 | process.stderr.write('[WARN] Could not determine git branch, using default branch\n'); 143 | return DEFAULT_BRANCH; 144 | } 145 | 146 | /** 147 | * Get comprehensive version information with fallbacks for non-git environments 148 | * @returns {Object} Version information 149 | */ 150 | function getVersionInfo() { 151 | // Initialize with fallback values 152 | const info = { 153 | branch: 'unknown', 154 | commit: 'unknown', 155 | tag: null, 156 | dirty: false, 157 | date: new Date().toISOString(), 158 | version: '1.0.0' // Default version 159 | }; 160 | 161 | // Check if we're in a git repo first 162 | const projectRoot = path.join(__dirname, '..', '..'); 163 | const isGitRepo = safeExec(`cd "${projectRoot}" && git rev-parse --is-inside-work-tree`) === 'true'; 164 | 165 | if (isGitRepo) { 166 | // Get branch name using our unified function 167 | info.branch = getGitBranch(); 168 | 169 | // Get commit hash (short) 170 | const commit = safeExec(`cd "${projectRoot}" && git rev-parse --short HEAD`); 171 | if (commit) { 172 | info.commit = commit; 173 | } 174 | 175 | // Try to get the latest tag 176 | const tag = safeExec(`cd "${projectRoot}" && git describe --tags --abbrev=0 2>/dev/null`); 177 | if (tag) { 178 | info.tag = tag; 179 | } 180 | 181 | // Check if working directory is dirty 182 | const status = safeExec(`cd "${projectRoot}" && git status --porcelain`); 183 | info.dirty = status && status.length > 0; 184 | 185 | // Get commit date 186 | const date = safeExec(`cd "${projectRoot}" && git log -1 --format=%cI`); 187 | if (date) { 188 | info.date = date; 189 | } 190 | 191 | // Construct version string 192 | if (info.tag) { 193 | // If we have a tag, use tag-commithash format 194 | info.version = `${info.tag}-${info.commit}${info.dirty ? '-dirty' : ''}`; 195 | } else { 196 | // Otherwise use branch-commithash format 197 | info.version = `${info.branch}-${info.commit}${info.dirty ? '-dirty' : ''}`; 198 | } 199 | } else { 200 | // Not in a git repo, try to get some system info instead 201 | try { 202 | const hostname = safeExec('hostname') || 'unknown'; 203 | const username = process.env.USER || process.env.USERNAME || 'unknown'; 204 | info.version = `1.0.0-${username}@${hostname}`; 205 | } catch (error) { 206 | // Keep the default version 207 | } 208 | } 209 | 210 | return info; 211 | } 212 | 213 | /** 214 | * Validate ports for potential conflicts 215 | * @param {Object} config - Configuration object 216 | * @returns {boolean} - True if no conflicts found 217 | */ 218 | function checkPortConflicts(config) { 219 | const hostPorts = [ 220 | { name: 'HTTP', port: config.HTTP_HOST_PORT }, 221 | { name: 'HTTPS', port: config.HTTPS_HOST_PORT }, 222 | { name: 'SWANK', port: config.SWANK_HOST_PORT }, 223 | { name: 'TELNET', port: config.TELNET_HOST_PORT } 224 | ]; 225 | 226 | // Check for duplicate ports 227 | const conflicts = []; 228 | 229 | for (let i = 0; i < hostPorts.length; i++) { 230 | for (let j = i + 1; j < hostPorts.length; j++) { 231 | if (hostPorts[i].port === hostPorts[j].port) { 232 | conflicts.push(`${hostPorts[i].name} and ${hostPorts[j].name} use the same port: ${hostPorts[i].port}`); 233 | } 234 | } 235 | } 236 | 237 | // Log any conflicts but don't abort 238 | if (conflicts.length > 0) { 239 | process.stderr.write(`[WARN] Detected port conflicts: ${conflicts.join(', ')}\n`); 240 | } 241 | 242 | return conflicts.length === 0; 243 | } 244 | 245 | /** 246 | * Handle mount points from environment variables with proper parsing 247 | * @returns {Array} Array of mount points 248 | */ 249 | function getEnvMounts() { 250 | const mountsStr = getEnvVar('MOUNTS', ''); 251 | if (!mountsStr) return []; 252 | 253 | // Split by comma and filter out empty entries 254 | return mountsStr.split(',').filter(mount => mount && mount.trim().length > 0); 255 | } 256 | 257 | /** 258 | * Sanitize a string for use as a Docker image tag 259 | * @param {string} input - String to sanitize 260 | * @returns {string} - Sanitized string safe for use as a Docker tag 261 | */ 262 | function sanitizeDockerTag(input) { 263 | if (!input) return 'unknown'; 264 | 265 | // Replace any characters that aren't letters, numbers, underscores, periods, or hyphens 266 | // Convert slashes to double hyphens (common convention for branch names) 267 | let sanitized = input 268 | .replace(/\//g, '--') 269 | .replace(/[^a-zA-Z0-9_.-]/g, '-'); 270 | 271 | // Tags can't start with a period or hyphen 272 | sanitized = sanitized.replace(/^[.-]+/, ''); 273 | 274 | // Limit to 128 characters max 275 | if (sanitized.length > 128) { 276 | sanitized = sanitized.substring(0, 128); 277 | } 278 | 279 | // Ensure we still have a valid tag after all replacements 280 | if (!sanitized || sanitized.length === 0) { 281 | return 'unknown'; 282 | } 283 | 284 | return sanitized; 285 | } 286 | 287 | /** 288 | * Load and validate the configuration 289 | * @param {Object} program - Commander program instance 290 | * @returns {Object} - Configuration object 291 | */ 292 | function loadConfig(program) { 293 | const options = program.opts(); 294 | 295 | // Define port ranges for validation 296 | const MIN_PORT = 1024; // Avoid privileged ports 297 | const MAX_PORT = 65535; // Maximum valid port number 298 | 299 | // Configure the backend server details - Use CLI args, env vars, or defaults 300 | const BACKEND_HOST = options.backendHost || getEnvVar('BACKEND_HOST', '127.0.0.1'); 301 | 302 | // Internal ports (inside the container) 303 | const HTTP_PORT = parseInt10(options.httpPort || getEnvVar('HTTP_PORT', '9080'), 9080, MIN_PORT, MAX_PORT); 304 | const HTTPS_PORT = parseInt10(options.httpsPort || getEnvVar('HTTPS_PORT', '9443'), 9443, MIN_PORT, MAX_PORT); 305 | const SWANK_PORT = parseInt10(options.swankPort || getEnvVar('SWANK_PORT', '4200'), 4200, MIN_PORT, MAX_PORT); 306 | const TELNET_PORT = parseInt10(options.telnetPort || getEnvVar('TELNET_PORT', '4023'), 4023, MIN_PORT, MAX_PORT); 307 | 308 | // Host ports (ports exposed on the host system) - set to internal port + 1 309 | const SWANK_HOST_PORT = parseInt10(options.swankHostPort || getEnvVar('SWANK_HOST_PORT', String(SWANK_PORT + 1)), SWANK_PORT + 1, MIN_PORT, MAX_PORT); 310 | const HTTP_HOST_PORT = parseInt10(options.httpHostPort || getEnvVar('HTTP_HOST_PORT', String(HTTP_PORT + 1)), HTTP_PORT + 1, MIN_PORT, MAX_PORT); 311 | const HTTPS_HOST_PORT = parseInt10(options.httpsHostPort || getEnvVar('HTTPS_HOST_PORT', String(HTTPS_PORT + 1)), HTTPS_PORT + 1, MIN_PORT, MAX_PORT); 312 | const TELNET_HOST_PORT = parseInt10(options.telnetHostPort || getEnvVar('TELNET_HOST_PORT', String(TELNET_PORT + 1)), TELNET_PORT + 1, MIN_PORT, MAX_PORT); 313 | 314 | // Constants for Docker image configuration 315 | const DEFAULT_IMPL = 'ccl'; 316 | const DEFAULT_BRANCH = 'master'; 317 | const DEFAULT_IMAGE_BASE = 'genworks/gendl'; 318 | 319 | // Validate Lisp implementation 320 | const SUPPORTED_IMPLS = ['ccl', 'sbcl']; 321 | 322 | // Get Lisp implementation from arguments or environment variable 323 | const LISP_IMPL = (options.lispImpl || getEnvVar('LISP_IMPL', DEFAULT_IMPL)).toLowerCase(); 324 | 325 | // Service startup flags - use consistent parsing with our helper functions 326 | const START_HTTP = options.startHttp !== false && parseBool(getEnvVar('START_HTTP', 'true'), true); // Default to true 327 | const START_HTTPS = parseBool(options.startHttps, false) || parseBool(getEnvVar('START_HTTPS', 'false'), false); 328 | const START_SWANK = options.startSwank !== false && parseBool(getEnvVar('START_SWANK', 'true'), true); // Default to true 329 | const START_TELNET = parseBool(options.startTelnet, false) || parseBool(getEnvVar('START_TELNET', 'false'), false); 330 | 331 | // Lisp REPL communication configuration 332 | // Enable stdio capability by default (but http is still the default communication mode) 333 | const NO_USE_STDIO = options.noUseStdio !== false || parseBool(getEnvVar('NO_USE_STDIO', 'true'), true); 334 | 335 | // Default REPL prompts by implementation 336 | const DEFAULT_PROMPTS = { 337 | 'ccl': '?', 338 | 'sbcl': '*', 339 | 'ielm': 'ELISP>' 340 | }; 341 | 342 | // Debugger prompts by implementation (for future use) 343 | const DEBUGGER_PROMPTS = { 344 | 'ccl': '>', // CCL debugger prompt 345 | 'sbcl': '0]', // SBCL debugger level 0 prompt 346 | 'ielm': 'ELISP>' // ielm doesn't have a separate debug level 347 | }; 348 | 349 | // Get the appropriate REPL prompt for the selected Lisp implementation 350 | const REPL_PROMPT = options.replPrompt || process.env.REPL_PROMPT || DEFAULT_PROMPTS[LISP_IMPL] || '?'; 351 | const EVAL_TIMEOUT = parseInt(options.evalTimeout || process.env.EVAL_TIMEOUT || '30000', 10); 352 | 353 | // Set up endpoint paths with configurable prefix and names 354 | const ENDPOINT_PREFIX = options.endpointPrefix || getEnvVar('ENDPOINT_PREFIX', 'lisply'); 355 | const LISP_EVAL_ENDPOINT_NAME = options.lispEvalEndpoint || getEnvVar('LISP_EVAL_ENDPOINT', 'lisp-eval'); 356 | const HTTP_REQUEST_ENDPOINT_NAME = options.httpRequestEndpoint || getEnvVar('HTTP_REQUEST_ENDPOINT', 'http-request'); 357 | const PING_ENDPOINT_NAME = options.pingEndpoint || getEnvVar('PING_ENDPOINT', 'ping-lisp'); 358 | 359 | // Construct full endpoint paths with prefix 360 | const BASE_PATH = `/${ENDPOINT_PREFIX}`; 361 | const EVAL_ENDPOINT = `${BASE_PATH}/${LISP_EVAL_ENDPOINT_NAME}`; 362 | const HTTP_REQUEST_ENDPOINT = `${BASE_PATH}/${HTTP_REQUEST_ENDPOINT_NAME}`; 363 | const PING_ENDPOINT = `${BASE_PATH}/${PING_ENDPOINT_NAME}`; 364 | 365 | // Set up logging to file for debugging 366 | const LOG_FILE = options.logFile || getEnvVar('LOG_FILE', '/tmp/lisply-mcp-wrapper.log'); 367 | const DEBUG_MODE = parseBool(options.debug, false) || parseBool(getEnvVar('DEBUG_MODE', 'false'), false); 368 | 369 | // Get version info 370 | const versionInfo = getVersionInfo(); 371 | const VERSION = versionInfo.version; 372 | 373 | // Docker configuration 374 | const DOCKER_SOCKET = options.dockerSocket || getEnvVar('DOCKER_SOCKET', '/var/run/docker.sock'); 375 | const AUTO_START = options.autoStart !== false && parseBool(getEnvVar('AUTO_START', 'true'), true); 376 | 377 | // Handle mount points 378 | const MOUNTS = options.mount || []; // Mount points from command line 379 | const ENV_MOUNTS = getEnvMounts(); 380 | const ALL_MOUNTS = [...MOUNTS, ...ENV_MOUNTS]; 381 | 382 | return { 383 | BACKEND_HOST, 384 | SWANK_HOST_PORT, 385 | HTTP_HOST_PORT, 386 | HTTPS_HOST_PORT, 387 | TELNET_HOST_PORT, 388 | HTTP_PORT, 389 | HTTPS_PORT, 390 | SWANK_PORT, 391 | TELNET_PORT, 392 | LISP_IMPL, 393 | SUPPORTED_IMPLS, 394 | DEFAULT_IMPL, 395 | DEFAULT_BRANCH, 396 | DEFAULT_IMAGE_BASE, 397 | START_HTTP, 398 | START_HTTPS, 399 | START_SWANK, 400 | START_TELNET, 401 | NO_USE_STDIO, 402 | DEFAULT_PROMPTS, 403 | DEBUGGER_PROMPTS, 404 | REPL_PROMPT, 405 | EVAL_TIMEOUT, 406 | ENDPOINT_PREFIX, 407 | BASE_PATH, 408 | EVAL_ENDPOINT, 409 | HTTP_REQUEST_ENDPOINT, 410 | PING_ENDPOINT, 411 | LOG_FILE, 412 | DEBUG_MODE, 413 | VERSION, 414 | versionInfo, 415 | DOCKER_SOCKET, 416 | AUTO_START, 417 | ALL_MOUNTS, 418 | options 419 | }; 420 | } 421 | 422 | module.exports = { 423 | collect, 424 | getEnvVar, 425 | parseBool, 426 | parseInt10, 427 | safeExec, 428 | getGitBranch, 429 | getVersionInfo, 430 | checkPortConflicts, 431 | getEnvMounts, 432 | sanitizeDockerTag, 433 | loadConfig 434 | }; 435 | -------------------------------------------------------------------------------- /scripts/lib/docker.js: -------------------------------------------------------------------------------- 1 | /** 2 | * docker.js 3 | * 4 | * Docker container management for the MCP wrapper 5 | */ 6 | 7 | const fs = require('fs'); 8 | const { exec, execSync, spawn } = require('child_process'); 9 | const { getGitBranch, getEnvVar, sanitizeDockerTag } = require('./config'); 10 | 11 | /** 12 | * Check if Docker is available for container management 13 | * @param {Object} logger - Logger instance 14 | * @returns {boolean} - Whether Docker is available 15 | */ 16 | function isDockerAvailable(logger, dockerSocket) { 17 | try { 18 | // Check if we're running in a container 19 | let isContainer = false; 20 | 21 | try { 22 | const cgroup = fs.readFileSync('/proc/self/cgroup', 'utf8'); 23 | isContainer = cgroup.includes('docker'); 24 | } catch (e) { 25 | // /proc might not be available on all platforms (e.g., Windows) 26 | logger.debug(`Could not read cgroup info: ${e.message}`); 27 | // Fall back to checking environment variables 28 | isContainer = !!process.env.CONTAINER || !!process.env.DOCKER_CONTAINER; 29 | } 30 | 31 | logger.debug(`Running in container: ${isContainer}`); 32 | 33 | // If we're in a container, we need the Docker socket to be mounted 34 | if (isContainer) { 35 | const socketExists = fs.existsSync(dockerSocket); 36 | logger.debug(`Docker socket ${dockerSocket} exists: ${socketExists}`); 37 | return socketExists; 38 | } 39 | 40 | // If we're on the host, check if docker command works 41 | const dockerVersion = execSync('docker --version', { encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }).trim(); 42 | if (dockerVersion) { 43 | logger.debug(`Docker available: ${dockerVersion}`); 44 | return true; 45 | } else { 46 | logger.warn('Docker command not found or not working'); 47 | return false; 48 | } 49 | } catch (error) { 50 | logger.warn(`Docker does not seem to be available: ${error.message}`); 51 | return false; 52 | } 53 | } 54 | 55 | /** 56 | * Check if Docker login is valid and attempt login if necessary 57 | * @param {Object} logger - Logger instance 58 | * @returns {Promise} - Whether Docker login is valid 59 | */ 60 | async function ensureDockerLogin(logger) { 61 | return new Promise((resolve) => { 62 | logger.info('Checking Docker Hub authentication status'); 63 | exec('docker info', (error, stdout, stderr) => { 64 | // If docker info works, we have docker access 65 | if (error) { 66 | logger.warn(`Docker info failed: ${error.message}`); 67 | resolve(false); 68 | return; 69 | } 70 | 71 | // Check if we can access Docker Hub - try a simple pull of a small public image 72 | exec('docker pull hello-world:latest', (error, stdout, stderr) => { 73 | if (error) { 74 | logger.warn(`Docker authentication check failed: ${error.message}`); 75 | logger.info('Attempting Docker Hub login...'); 76 | 77 | // Try to login interactively or with stored credentials 78 | exec('docker login', (error, stdout, stderr) => { 79 | if (error) { 80 | logger.warn(`Docker login failed: ${error.message}`); 81 | resolve(false); 82 | } else { 83 | logger.info('Docker login successful'); 84 | resolve(true); 85 | } 86 | }); 87 | } else { 88 | logger.info('Docker authentication is valid'); 89 | resolve(true); 90 | } 91 | }); 92 | }); 93 | }); 94 | } 95 | 96 | /** 97 | * Construct Docker image name from branch and implementation 98 | * @param {Object} config - Configuration object 99 | * @param {Object} logger - Logger instance 100 | * @returns {string} - Fully qualified Docker image name 101 | */ 102 | function constructDockerImageName(config, logger) { 103 | const { options } = config; 104 | 105 | // Get branch name with fallbacks 106 | const branchName = options.imageBranch || 107 | getEnvVar('IMAGE_BRANCH', getGitBranch(options)); 108 | 109 | // Sanitize branch name for Docker tag 110 | const formattedBranch = sanitizeDockerTag(branchName); 111 | 112 | // Get implementation with validation 113 | const impl = config.SUPPORTED_IMPLS.includes(config.LISP_IMPL) ? config.LISP_IMPL : config.DEFAULT_IMPL; 114 | 115 | // Get base name with fallbacks 116 | const baseName = options.imageBaseName || 117 | getEnvVar('IMAGE_BASE', config.DEFAULT_IMAGE_BASE); 118 | 119 | // Log the components used to construct the image name 120 | logger.debug(`Constructing Docker image name from: Base=${baseName}, Branch=${branchName} (Formatted=${formattedBranch}), Impl=${impl}`); 121 | 122 | return `${baseName}:${formattedBranch}-${impl}`; 123 | } 124 | 125 | /** 126 | * Promise wrapper for exec 127 | * @param {string} command - Command to execute 128 | * @returns {Promise} - Command output 129 | */ 130 | function execPromise(command) { 131 | return new Promise((resolve, reject) => { 132 | exec(command, (error, stdout, stderr) => { 133 | if (error) { 134 | reject(error); 135 | } else { 136 | resolve(stdout.trim()); 137 | } 138 | }); 139 | }); 140 | } 141 | 142 | /** 143 | * Try to pull the latest version of the Docker image 144 | * @param {Object} config - Configuration object 145 | * @param {Object} logger - Logger instance 146 | * @returns {Promise} - Result object with success flag and image name 147 | */ 148 | async function pullLatestBackendImage(config, logger) { 149 | return new Promise(async (resolve) => { 150 | let currentImage = config.options.dockerImage || getEnvVar('DOCKER_IMAGE', constructDockerImageName(config, logger)); 151 | logger.info(`Attempting to pull latest backend image: ${currentImage}`); 152 | 153 | // Try pulling the image matching the current branch 154 | try { 155 | await execPromise(`docker pull ${currentImage}`); 156 | logger.info(`Successfully pulled latest backend image: ${currentImage}`); 157 | resolve({ success: true, image: currentImage }); 158 | return; 159 | } catch (pullError) { 160 | logger.warn(`Failed to pull latest backend image: ${pullError.message}`); 161 | 162 | // Check if the image exists locally 163 | try { 164 | await execPromise(`docker image inspect ${currentImage}`); 165 | logger.info(`Using existing local backend image: ${currentImage}`); 166 | resolve({ success: true, image: currentImage }); 167 | return; 168 | } catch (inspectError) { 169 | logger.warn(`Backend image ${currentImage} does not exist locally`); 170 | 171 | // If the current image is already the default, we've run out of options 172 | const DEFAULT_IMAGE_BASE = 'genworks/gendl'; // Define default here to avoid dependency 173 | const DEFAULT_BRANCH = 'master'; 174 | const DEFAULT_IMPL = 'ccl'; 175 | const imageBaseName = config.options.imageBaseName || process.env.LISPLY_IMAGE_BASE || DEFAULT_IMAGE_BASE; 176 | const defaultImage = `${imageBaseName}:${DEFAULT_BRANCH}-${DEFAULT_IMPL}`; 177 | if (currentImage === defaultImage) { 178 | logger.error(`No suitable backend image available`); 179 | resolve({ success: false }); 180 | return; 181 | } 182 | 183 | // Try to pull the default image as fallback 184 | logger.info(`Trying to pull default image: ${defaultImage}`); 185 | try { 186 | await execPromise(`docker pull ${defaultImage}`); 187 | logger.info(`Successfully pulled default backend image`); 188 | // Update the environment variable with the new value 189 | process.env.LISPLY_DOCKER_IMAGE = defaultImage; 190 | resolve({ success: true, image: defaultImage }); 191 | return; 192 | } catch (defaultPullError) { 193 | // Try to check if default image exists locally 194 | try { 195 | await execPromise(`docker image inspect ${defaultImage}`); 196 | logger.info(`Using existing local default backend image: ${defaultImage}`); 197 | process.env.LISPLY_DOCKER_IMAGE = defaultImage; 198 | resolve({ success: true, image: defaultImage }); 199 | return; 200 | } catch (defaultInspectError) { 201 | logger.error(`Failed to find or pull default backend image: ${defaultPullError.message}`); 202 | resolve({ success: false }); 203 | return; 204 | } 205 | } 206 | } 207 | } 208 | }); 209 | } 210 | 211 | /** 212 | * Try to find and attach to an existing backend container 213 | * @param {Object} config - Configuration object 214 | * @param {Object} logger - Logger instance 215 | * @returns {boolean} - Whether attachment was successful 216 | */ 217 | function tryAttachToContainer(config, logger) { 218 | try { 219 | logger.info('Attempting to find and attach to existing backend container'); 220 | 221 | // Find containers using our expected ports 222 | const command = `docker ps --filter "publish=${config.HTTP_HOST_PORT}" --format "{{.ID}}:{{.Names}}"`; 223 | const result = execSync(command, { encoding: 'utf8' }).trim(); 224 | 225 | if (!result) { 226 | logger.info('No running containers found with matching port'); 227 | return false; 228 | } 229 | 230 | // Parse container info 231 | const containers = result.split('\n').map(line => { 232 | const [id, name] = line.split(':'); 233 | return { id, name }; 234 | }); 235 | 236 | logger.info(`Found ${containers.length} potential containers: ${JSON.stringify(containers)}`); 237 | 238 | if (containers.length === 0) { 239 | return false; 240 | } 241 | 242 | // Choose the first container 243 | const container = containers[0]; 244 | global.backendContainerName = container.name; 245 | 246 | logger.info(`Connecting to container ${container.id} (${container.name})`); 247 | 248 | // Try using 'exec' instead of 'attach' for better stability 249 | // The -i flag keeps stdin open 250 | const dockerProcess = spawn('docker', ['exec', '-i', container.id, 'ccl', '--no-init', '--quiet'], { 251 | stdio: ['pipe', 'pipe', 'pipe'] // Keep stdin open with pipe 252 | }); 253 | 254 | // Add explicit exit handler to log when the process exits 255 | dockerProcess.on('exit', (code, signal) => { 256 | logger.error(`Docker exec process exited with code ${code} and signal ${signal}`); 257 | global.dockerProcess = null; 258 | }); 259 | 260 | // Handle potential errors 261 | dockerProcess.on('error', (error) => { 262 | logger.error(`Error executing in container: ${error.message}`); 263 | return false; 264 | }); 265 | 266 | // Store the process globally 267 | global.dockerProcess = dockerProcess; 268 | 269 | // Setup event handlers for the process 270 | dockerProcess.stdout.on('data', (data) => { 271 | const output = data.toString(); 272 | logger.debug(`Container stdout: ${output.substring(0, 100)}${output.length > 100 ? '...' : ''}`); 273 | }); 274 | 275 | dockerProcess.stderr.on('data', (data) => { 276 | logger.error(`Container stderr: ${data.toString().trim()}`); 277 | }); 278 | 279 | // Send a newline to check if the container is responsive 280 | dockerProcess.stdin.write('\n'); 281 | 282 | logger.info('Successfully started Lisp REPL in container'); 283 | return true; 284 | } catch (error) { 285 | logger.error(`Failed to connect to container: ${error.message}`); 286 | return false; 287 | } 288 | } 289 | 290 | /** 291 | * Wait for the backend server to become available 292 | * @param {Object} config - Configuration object 293 | * @param {Object} logger - Logger instance 294 | * @param {Function} checkBackendAvailability - Function to check backend availability 295 | * @param {number} maxWaitSeconds - Maximum wait time in seconds 296 | * @returns {Promise} - Whether the backend server became available 297 | */ 298 | function waitForBackendServer(config, logger, checkBackendAvailability, maxWaitSeconds) { 299 | return new Promise((resolve, reject) => { 300 | logger.info(`Waiting up to ${maxWaitSeconds} seconds for backend server to become available`); 301 | 302 | let attempts = 0; 303 | const maxAttempts = maxWaitSeconds; 304 | const interval = 1000; // 1 second interval 305 | 306 | const check = () => { 307 | attempts++; 308 | 309 | checkBackendAvailability(config, logger) 310 | .then(available => { 311 | if (available) { 312 | logger.info(`Backend server is now available after ${attempts} seconds`); 313 | resolve(true); 314 | } else if (attempts < maxAttempts) { 315 | logger.debug(`Waiting for backend server (attempt ${attempts}/${maxAttempts})...`); 316 | setTimeout(check, interval); 317 | } else { 318 | reject(new Error(`Backend server did not become available after ${maxAttempts} seconds`)); 319 | } 320 | }) 321 | .catch(error => { 322 | reject(error); 323 | }); 324 | }; 325 | 326 | // Start checking 327 | check(); 328 | }); 329 | } 330 | 331 | /** 332 | * Start a backend container 333 | * @param {Object} config - Configuration object 334 | * @param {Object} logger - Logger instance 335 | * @param {Function} checkBackendAvailability - Function to check backend availability 336 | * @returns {Promise} - Whether the container was started successfully 337 | */ 338 | function startBackendContainer(config, logger, checkBackendAvailability) { 339 | return new Promise(async (resolve, reject) => { 340 | try { 341 | if (!isDockerAvailable(logger, config.DOCKER_SOCKET)) { 342 | return reject(new Error('Docker is not available')); 343 | } 344 | 345 | const loginStatus = await ensureDockerLogin(logger); 346 | if (loginStatus) { 347 | logger.info('Docker login confirmed, proceeding with image pull'); 348 | } else { 349 | logger.warn('Docker login not confirmed, will try to use local images'); 350 | } 351 | 352 | const pullResult = await pullLatestBackendImage(config, logger); 353 | if (!pullResult || !pullResult.success) { 354 | logger.warn('Could not pull or find a suitable backend image'); 355 | return reject(new Error('No suitable backend image available')); 356 | } 357 | 358 | const dockerImage = pullResult.image; 359 | logger.info(`Preparing to start backend container using image ${dockerImage}`); 360 | 361 | // in debug mode, log the following `-e` environment variables 362 | // so we can see what's going on when docker container starts: 363 | logger.debug(`Environment variables at container start: 364 | START_HTTP: ${config.START_HTTP} 365 | HTTP_PORT: ${config.HTTP_PORT} 366 | HTTP_HOST_PORT: ${config.HTTP_HOST_PORT} 367 | START_HTTPS: ${config.START_HTTPS} 368 | HTTPS_PORT: ${config.HTTPS_PORT} 369 | HTTPS_HOST_PORT: ${config.HTTPS_HOST_PORT} 370 | START_SWANK: ${config.START_SWANK} 371 | SWANK_PORT: ${config.SWANK_PORT} 372 | SWANK_HOST_PORT: ${config.SWANK_HOST_PORT} 373 | START_TELNET: ${config.START_TELNET} 374 | TELNET_PORT: ${config.TELNET_PORT} 375 | TELNET_HOST_PORT: ${config.TELNET_HOST_PORT} 376 | `); 377 | 378 | // Generate a unique container name with timestamp 379 | // Extract the base name from the image for the container name 380 | const imageBaseName = dockerImage.split('/').pop().split(':')[0]; 381 | const containerName = `lisply-mcp-${new Date().getTime()}`; // name lisply to match README.md 382 | 383 | // Prepare docker arguments for spawn 384 | const dockerArgs = [ 385 | 'run', 386 | '-i', 387 | '--rm', 388 | '--name', containerName, 389 | '-e', `START_HTTP=${config.START_HTTP}`, 390 | '-e', `HTTP_PORT=${config.HTTP_PORT}`, 391 | '-e', `HTTP_HOST_PORT=${config.HTTP_HOST_PORT}`, 392 | '-e', `START_HTTPS=${config.START_HTTPS}`, 393 | '-e', `HTTPS_PORT=${config.HTTPS_PORT}`, 394 | '-e', `HTTPS_HOST_PORT=${config.HTTPS_HOST_PORT}`, 395 | '-e', `START_SWANK=${config.START_SWANK}`, 396 | '-e', `SWANK_PORT=${config.SWANK_PORT}`, 397 | '-e', `SWANK_HOST_PORT=${config.SWANK_HOST_PORT}`, 398 | '-p', `${config.SWANK_HOST_PORT}:${config.SWANK_PORT}`, 399 | '-p', `${config.HTTP_HOST_PORT}:${config.HTTP_PORT}`, 400 | // Add ports for HTTPS and TELNET if enabled 401 | ...(config.START_HTTPS ? ['-p', `${config.HTTPS_HOST_PORT}:${config.HTTPS_PORT}`] : []), 402 | ...(config.START_TELNET ? ['-p', `${config.TELNET_HOST_PORT}:${config.TELNET_PORT}`] : []), 403 | // Add any mount points 404 | ...config.ALL_MOUNTS.flatMap(mount => ['-v', mount]) 405 | ]; 406 | 407 | // Add the image name as the last argument 408 | dockerArgs.push(dockerImage); 409 | 410 | // Log the complete docker command 411 | logger.debug(`Docker command: docker ${dockerArgs.join(' ')}`); 412 | 413 | // Final availability check immediately before container spawning to handle race conditions 414 | const finalAvailabilityCheck = await checkBackendAvailability(config, logger); 415 | if (finalAvailabilityCheck) { 416 | logger.info('Backend service became available during final check. Skipping container start.'); 417 | return resolve(true); 418 | } 419 | 420 | // Use spawn instead of exec to keep stdin open 421 | const dockerProcess = spawn('docker', dockerArgs, { 422 | stdio: ['pipe', 'pipe', 'pipe'] // Keep stdin open with pipe 423 | }); 424 | 425 | // Store the container name and log container output 426 | global.backendContainerName = containerName; 427 | logger.info(`Started backend container with name: ${containerName}`); 428 | 429 | // Just log the container output 430 | dockerProcess.stdout.on('data', (data) => { 431 | const output = data.toString().trim(); 432 | logger.debug(`Docker stdout: ${output}`); 433 | }); 434 | 435 | // Log stderr 436 | dockerProcess.stderr.on('data', (data) => { 437 | const errorMsg = data.toString().trim(); 438 | logger.error(`Docker stderr: ${errorMsg}`); 439 | 440 | // Check for port already in use 441 | if (errorMsg.includes('port is already allocated')) { 442 | logger.warn('Port already in use. Another process likely started the container before we could.'); 443 | dockerProcess.kill(); // Kill the process 444 | return resolve(true); 445 | } 446 | }); 447 | 448 | // Handle process exit 449 | dockerProcess.on('exit', (code, signal) => { 450 | if (code !== 0) { 451 | logger.error(`Docker process exited with code ${code} and signal ${signal}`); 452 | return reject(new Error(`Docker process exited with code ${code}`)); 453 | } 454 | }); 455 | 456 | // Handle process errors 457 | dockerProcess.on('error', (error) => { 458 | logger.error(`Failed to start Docker container: ${error.message}`); 459 | return reject(error); 460 | }); 461 | 462 | // Keep the stdin pipe open (critical to prevent container from exiting) 463 | dockerProcess.stdin.on('error', (error) => { 464 | logger.error(`Docker stdin error: ${error.message}`); 465 | }); 466 | 467 | // Store the process globally so it stays alive with the script 468 | global.dockerProcess = dockerProcess; 469 | 470 | // Add explicit exit handler to log when the process exits 471 | dockerProcess.on('exit', (code, signal) => { 472 | logger.error(`Docker container process exited with code ${code} and signal ${signal}`); 473 | global.dockerProcess = null; 474 | }); 475 | 476 | // Wait briefly for the container to start before continuing 477 | setTimeout(() => { 478 | // Check if the container is running using the container name 479 | exec(`docker ps --filter "name=${containerName}" --format "{{.ID}}"`, (error, stdout, stderr) => { 480 | if (error) { 481 | logger.error(`Error checking container status: ${error.message}`); 482 | return reject(error); 483 | } 484 | 485 | if (stdout.trim()) { 486 | // Container is running, wait for the server to become available 487 | logger.info(`Container ${containerName} is running, waiting for backend server to start`); 488 | waitForBackendServer(config, logger, checkBackendAvailability, 30) 489 | .then(() => resolve(true)) 490 | .catch(error => reject(error)); 491 | } else { 492 | // Container may still be starting, wait a bit more 493 | logger.info('Container not found in ps output yet, waiting more time for startup'); 494 | setTimeout(() => { 495 | exec(`docker ps --filter "name=${containerName}" --format "{{.ID}}"`, (error, stdout, stderr) => { 496 | if (error) { 497 | logger.error(`Error checking container status: ${error.message}`); 498 | return reject(error); 499 | } 500 | 501 | if (stdout.trim()) { 502 | logger.info(`Container ${containerName} is now running, waiting for backend server to start`); 503 | waitForBackendServer(config, logger, checkBackendAvailability, 30) 504 | .then(() => resolve(true)) 505 | .catch(error => reject(error)); 506 | } else { 507 | logger.warn(`Container ${containerName} not found after extended wait`); 508 | // Try to continue anyway - the container might still be starting 509 | waitForBackendServer(config, logger, checkBackendAvailability, 30) 510 | .then(() => resolve(true)) 511 | .catch(error => reject(error)); 512 | } 513 | }); 514 | }, 2000); 515 | } 516 | }); 517 | }, 1000); 518 | } catch (error) { 519 | logger.error(`Container startup error: ${error.message}`); 520 | reject(error); 521 | } 522 | }); 523 | } 524 | 525 | /** 526 | * Clean up Docker-related resources on exit 527 | * @param {Object} logger - Logger instance 528 | * @returns {Promise} 529 | */ 530 | async function cleanup(logger) { 531 | logger.info('Cleanup started'); // Log when cleanup begins 532 | 533 | // Check if we're the process that started the container or just attached to it 534 | if (global.dockerProcess) { 535 | // If we started the container, it will terminate automatically due to --rm flag 536 | // If we attached to the container, we need to detach cleanly 537 | if (global.backendContainerName && !global.backendContainerName.includes('-mcp-')) { 538 | // We likely attached to an existing container, so just detach 539 | logger.info(`Detaching from container ${global.backendContainerName}`); 540 | 541 | try { 542 | // Send CTRL+P CTRL+Q to detach from the container 543 | if (global.dockerProcess.stdin.writable) { 544 | // We need to do this without actually detaching ourselves, 545 | // so we'll just close our stdin pipe 546 | global.dockerProcess.stdin.end(); 547 | } 548 | } catch (error) { 549 | logger.error(`Error detaching from container: ${error.message}`); 550 | } 551 | } else { 552 | logger.info('Container will be removed automatically due to --rm flag'); 553 | } 554 | } 555 | 556 | logger.info('Cleanup completed'); // Log when cleanup finishes 557 | } 558 | 559 | module.exports = { 560 | isDockerAvailable, 561 | ensureDockerLogin, 562 | constructDockerImageName, 563 | pullLatestBackendImage, 564 | tryAttachToContainer, 565 | waitForBackendServer, 566 | startBackendContainer, 567 | cleanup 568 | }; 569 | -------------------------------------------------------------------------------- /scripts/lib/logger.js: -------------------------------------------------------------------------------- 1 | /** 2 | * logger.js 3 | * 4 | * Logging facilities for the MCP wrapper 5 | */ 6 | 7 | const fs = require('fs'); 8 | 9 | class Logger { 10 | constructor(logFile, debugMode) { 11 | this.debugMode = debugMode; 12 | this.logStream = null; 13 | 14 | try { 15 | this.logStream = fs.createWriteStream(logFile, { flags: 'a' }); 16 | this.logStream.write(`\n\n---- STARTING MCP WRAPPER LOG AT ${new Date().toISOString()} ----\n\n`); 17 | } catch (error) { 18 | console.error(`Failed to create log file: ${error.message}`); 19 | } 20 | } 21 | 22 | /** 23 | * Internal logging function 24 | * @param {string} level - Log level 25 | * @param {string} message - Log message 26 | */ 27 | log(level, message) { 28 | const timestamp = new Date().toISOString(); 29 | const logMessage = `[${timestamp}] [${level}] ${message}`; 30 | 31 | // Log to stderr 32 | console.error(`[MCP-WRAPPER] ${logMessage}`); 33 | 34 | // Log to file if available 35 | if (this.logStream) { 36 | this.logStream.write(logMessage + '\n'); 37 | } 38 | } 39 | 40 | /** 41 | * Log error message 42 | * @param {string} message - Error message 43 | */ 44 | error(message) { 45 | this.log('ERROR', message); 46 | } 47 | 48 | /** 49 | * Log warning message 50 | * @param {string} message - Warning message 51 | */ 52 | warn(message) { 53 | this.log('WARN', message); 54 | } 55 | 56 | /** 57 | * Log info message 58 | * @param {string} message - Info message 59 | */ 60 | info(message) { 61 | this.log('INFO', message); 62 | } 63 | 64 | /** 65 | * Log debug message (only in debug mode) 66 | * @param {string} message - Debug message 67 | */ 68 | debug(message) { 69 | if (this.debugMode) { 70 | this.log('DEBUG', message); 71 | } 72 | } 73 | 74 | /** 75 | * Close the log stream 76 | */ 77 | close() { 78 | if (this.logStream) { 79 | this.logStream.end(); 80 | this.logStream = null; 81 | } 82 | } 83 | } 84 | 85 | /** 86 | * Create a logger instance 87 | * @param {Object} config - Configuration with LOG_FILE and DEBUG_MODE 88 | * @returns {Logger} Logger instance 89 | */ 90 | function createLogger(config) { 91 | return new Logger(config.LOG_FILE, config.DEBUG_MODE); 92 | } 93 | 94 | module.exports = { 95 | createLogger 96 | }; -------------------------------------------------------------------------------- /scripts/lib/server.js: -------------------------------------------------------------------------------- 1 | /** 2 | * server.js 3 | * 4 | * HTTP server and MCP wrapper implementation 5 | */ 6 | 7 | const http = require('http'); 8 | const readline = require('readline'); 9 | 10 | /** 11 | * Check if the backend server is available 12 | * @param {Object} config - Configuration object 13 | * @param {Object} logger - Logger instance 14 | * @returns {Promise} - Whether the backend is available 15 | */ 16 | function checkBackendAvailability(config, logger) { 17 | return new Promise((resolve) => { 18 | logger.info(`Checking backend HTTP service availability at ${config.BACKEND_HOST}:${config.HTTP_HOST_PORT}`); 19 | 20 | const options = { 21 | hostname: config.BACKEND_HOST, 22 | port: config.HTTP_HOST_PORT, 23 | path: config.PING_ENDPOINT, 24 | method: 'GET', 25 | timeout: 5000 26 | }; 27 | 28 | const req = http.request(options, (res) => { 29 | let responseBody = ''; 30 | 31 | res.on('data', (chunk) => { 32 | responseBody += chunk; 33 | }); 34 | 35 | res.on('end', () => { 36 | if (res.statusCode === 200 && responseBody.length > 0) { 37 | logger.info(`Lisply service is available. Ping response: ${responseBody}`); 38 | resolve(true); 39 | } else { 40 | logger.warn(`Lisply service ping failed. Status: ${res.statusCode}, Response length: ${responseBody.length}`); 41 | resolve(false); 42 | } 43 | }); 44 | }); 45 | 46 | req.on('timeout', () => { 47 | logger.warn('Lisply service ping request timed out'); 48 | req.destroy(); 49 | resolve(false); 50 | }); 51 | 52 | req.on('error', (error) => { 53 | logger.warn(`Lisply service ping request error: ${error.message}`); 54 | resolve(false); 55 | }); 56 | 57 | req.end(); 58 | }); 59 | } 60 | 61 | /** 62 | * Helper function to make HTTP requests with unified logging and error handling 63 | * @param {Object} options - HTTP request options 64 | * @param {string|null} body - Request body 65 | * @param {Function} callback - Callback function for the response 66 | * @param {string} logPrefix - Optional prefix for log messages 67 | * @param {Object} logger - Logger instance 68 | */ 69 | function makeHttpRequest(options, body, callback, logPrefix = '', logger) { 70 | const prefix = logPrefix ? `[${logPrefix}] ` : ''; 71 | logger.debug(`${prefix}Making ${options.method} request to http://${options.hostname}:${options.port}${options.path}`); 72 | logger.debug(`${prefix}Request headers: ${JSON.stringify(options.headers)}`); 73 | if (body) { 74 | logger.debug(`${prefix}Request body: ${body.substring(0, 500)}${body.length > 500 ? '...' : ''}`); 75 | } 76 | 77 | const req = http.request(options, (res) => { 78 | let data = ''; 79 | 80 | res.on('data', (chunk) => { 81 | data += chunk; 82 | if (logPrefix) { 83 | logger.debug(`${prefix}Received chunk: ${chunk.toString().substring(0, 100)}...`); 84 | } 85 | }); 86 | 87 | res.on('end', () => { 88 | logger.debug(`${prefix}Response status: ${res.statusCode}, Content-Type: ${res.headers['content-type']}`); 89 | logger.debug(`${prefix}Response data: ${data.substring(0, 500)}${data.length > 500 ? '...' : ''}`); 90 | 91 | // Follow redirects 92 | if ([301, 302, 303, 307, 308].includes(res.statusCode)) { 93 | const location = res.headers.location; 94 | 95 | if (location) { 96 | logger.info(`${prefix}Following redirect to: ${location}`); 97 | 98 | // Create new options for the redirect 99 | const redirectOptions = { 100 | ...options, 101 | path: location 102 | }; 103 | 104 | // For 303 redirects, use GET 105 | if (res.statusCode === 303) { 106 | redirectOptions.method = 'GET'; 107 | } 108 | 109 | // Follow the redirect 110 | return makeHttpRequest(redirectOptions, null, callback, logPrefix, logger); 111 | } 112 | } 113 | 114 | // Return a comprehensive response object 115 | callback(null, { 116 | content: data, 117 | statusCode: res.statusCode, 118 | headers: res.headers, 119 | finalUrl: options.path 120 | }); 121 | }); 122 | }); 123 | 124 | req.on('error', (error) => { 125 | logger.error(`${prefix}HTTP request error: ${error.message}`); 126 | callback(error); 127 | }); 128 | 129 | // Set timeout to prevent hanging 130 | req.setTimeout(10000, () => { 131 | logger.error(`${prefix}Request timed out after 10 seconds`); 132 | req.destroy(); 133 | callback(new Error("Request timed out")); 134 | }); 135 | 136 | // Send the request body if present 137 | if (body && ['POST', 'PUT', 'PATCH'].includes(options.method)) { 138 | req.write(body); 139 | } 140 | 141 | req.end(); 142 | if (logPrefix) { 143 | logger.debug(`${prefix}Request sent`); 144 | } 145 | } 146 | 147 | /** 148 | * Set up event handlers for the process 149 | * @param {Object} rl - Readline interface 150 | * @param {Object} logger - Logger instance 151 | */ 152 | function setupProcessEvents(rl, logger) { 153 | // Function to clean up resources on exit 154 | const cleanup = async () => { 155 | logger.info('Cleanup started'); // Log when cleanup begins 156 | 157 | if (rl) rl.close(); 158 | 159 | logger.info('Cleanup completed'); // Log when cleanup finishes 160 | }; 161 | 162 | // Add event handlers to prevent unexpected termination 163 | process.on('SIGINT', async () => { 164 | logger.info('Received SIGINT signal - cleaning up and exiting'); 165 | await cleanup(); 166 | process.exit(0); 167 | }); 168 | 169 | process.on('SIGTERM', async () => { 170 | logger.info('Received SIGTERM signal - cleaning up and exiting'); 171 | await cleanup(); 172 | process.exit(0); 173 | }); 174 | 175 | // Add handler for normal exit (uncaught process exit) 176 | process.on('exit', (code) => { 177 | logger.info(`Process exiting with code ${code} - cleanup should have run`); 178 | }); 179 | 180 | // Add handler for unhandled promise rejections to catch async issues 181 | process.on('unhandledRejection', (reason, promise) => { 182 | logger.error(`Unhandled promise rejection: ${reason}`); 183 | }); 184 | } 185 | 186 | /** 187 | * Start the MCP wrapper server 188 | * @param {Object} config - Configuration object 189 | * @param {Object} logger - Logger instance 190 | * @param {Object} handlers - Object containing handler functions 191 | */ 192 | function startMcpWrapper(config, logger, handlers) { 193 | // Set flag to prevent double-starting 194 | global.isMcpWrapperStarted = true; 195 | 196 | logger.info('Starting MCP wrapper'); 197 | 198 | // Create readline interface for stdin/stdout communication 199 | let rl = readline.createInterface({ 200 | input: process.stdin, 201 | output: process.stdout, 202 | terminal: false 203 | }); 204 | 205 | // Handle MCP requests 206 | rl.on('line', (line) => { 207 | logger.info(`Received: ${line}`); 208 | 209 | try { 210 | const request = JSON.parse(line); 211 | 212 | // Handle notifications (no response needed) 213 | if (request.method && request.method.startsWith('notifications/')) { 214 | switch (request.method) { 215 | case 'notifications/initialized': 216 | logger.info('Received initialization notification'); 217 | break; 218 | case 'notifications/cancelled': 219 | logger.info(`Received cancellation notification for request ${request.params?.requestId}: ${request.params?.reason}`); 220 | break; 221 | default: 222 | logger.info(`Received notification: ${request.method}`); 223 | } 224 | return; // No response needed for notifications 225 | } 226 | 227 | // Handle methods that require responses 228 | switch (request.method) { 229 | case 'initialize': 230 | handlers.handleInitialize(request, config, logger); 231 | break; 232 | case 'tools/call': 233 | handlers.handleToolCall(request, config, logger); 234 | break; 235 | case 'tools/list': 236 | handlers.handleToolsList(request, config, logger); 237 | break; 238 | case 'resources/list': 239 | logger.info('Handling resources/list request'); 240 | handlers.sendStandardResponse(request.id, { resources: [] }, logger); 241 | break; 242 | case 'prompts/list': 243 | logger.info('Handling prompts/list request'); 244 | handlers.sendStandardResponse(request.id, { prompts: [] }, logger); 245 | break; 246 | default: 247 | // Send method not supported error for any other method 248 | logger.warn(`Unsupported method: ${request.method}`); 249 | handlers.sendErrorResponse(request.id, -32601, `Method not supported: ${request.method}`, logger); 250 | } 251 | } catch (error) { 252 | logger.error(`Error processing request: ${error.message}`); 253 | if (line && line.includes('"id"')) { 254 | try { 255 | const id = JSON.parse(line).id; 256 | handlers.sendErrorResponse(id, -32603, `Internal error: ${error.message}`, logger); 257 | } catch (e) { 258 | logger.error(`Could not extract request ID: ${e.message}`); 259 | } 260 | } 261 | } 262 | }); 263 | 264 | // Handle process events 265 | setupProcessEvents(rl, logger); 266 | 267 | return rl; 268 | } 269 | 270 | module.exports = { 271 | checkBackendAvailability, 272 | makeHttpRequest, 273 | setupProcessEvents, 274 | startMcpWrapper 275 | }; -------------------------------------------------------------------------------- /scripts/lib/utils.js: -------------------------------------------------------------------------------- 1 | /** 2 | * utils.js 3 | * 4 | * Utility functions for the MCP wrapper 5 | */ 6 | 7 | // Helper to send MCP responses 8 | function sendResponse(response, logger) { 9 | const jsonResponse = JSON.stringify(response); 10 | logger.info(`Sending response: ${jsonResponse.substring(0, 500)}${jsonResponse.length > 500 ? '...' : ''}`); 11 | // Use process.stdout.write to ensure only JSON is output to stdout 12 | process.stdout.write(jsonResponse + '\n'); 13 | } 14 | 15 | // Standard text response format 16 | function sendTextResponse(requestOrId, text, logger) { 17 | logger.debug(`sendTextResponse called with: ${JSON.stringify(text)}`); 18 | // Check if text is an object and not a string 19 | if (typeof text === 'object' && text !== null) { 20 | logger.debug(`Text is an object, converting to string: ${JSON.stringify(text)}`); 21 | text = JSON.stringify(text, null, 2); 22 | } 23 | 24 | // Get ID either from request object or directly 25 | const id = typeof requestOrId === 'object' ? requestOrId.id : requestOrId; 26 | 27 | const response = { 28 | jsonrpc: '2.0', 29 | id: id, 30 | result: { 31 | content: [ 32 | { 33 | type: 'text', 34 | text: String(text || '') 35 | } 36 | ] 37 | } 38 | }; 39 | sendResponse(response, logger); 40 | } 41 | 42 | // Standard response for simple data 43 | function sendStandardResponse(requestOrId, data, logger) { 44 | // Get ID either from request object or directly 45 | const id = typeof requestOrId === 'object' ? requestOrId.id : requestOrId; 46 | 47 | const response = { 48 | jsonrpc: '2.0', 49 | id: id, 50 | result: data 51 | }; 52 | sendResponse(response, logger); 53 | } 54 | 55 | // Helper to send error responses 56 | function sendErrorResponse(requestOrId, code, message, logger) { 57 | // Get ID either from request object or directly 58 | const id = typeof requestOrId === 'object' ? requestOrId.id : requestOrId; 59 | 60 | const response = { 61 | jsonrpc: '2.0', 62 | id: id, 63 | error: { 64 | code: code, 65 | message: message 66 | } 67 | }; 68 | sendResponse(response, logger); 69 | } 70 | 71 | module.exports = { 72 | sendResponse, 73 | sendTextResponse, 74 | sendStandardResponse, 75 | sendErrorResponse 76 | }; -------------------------------------------------------------------------------- /scripts/mcp-wrapper.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | // Check for required dependencies before importing any modules 4 | const path = require('path'); 5 | const fs = require('fs'); 6 | 7 | // Helper function to install dependencies and restart the script 8 | function installDependenciesAndRestart(contextMessage = 'Missing dependency detected') { 9 | console.error(`\n\x1b[33m${contextMessage}\x1b[0m`); 10 | console.error('\nAttempting to install dependencies automatically...\n'); 11 | 12 | try { 13 | // Execute npm install synchronously 14 | const { execSync } = require('child_process'); 15 | console.error('\x1b[36mRunning: npm install\x1b[0m'); 16 | execSync('npm install', { cwd: __dirname, encoding: 'utf8' }); 17 | 18 | console.error('\x1b[32mDependencies installed successfully!\x1b[0m'); 19 | console.error('\nRestarting script with newly installed dependencies...\n'); 20 | 21 | // Restart the script 22 | const { spawnSync } = require('child_process'); 23 | const result = spawnSync(process.argv[0], process.argv.slice(1), { 24 | stdio: 'inherit', 25 | cwd: process.cwd() 26 | }); 27 | 28 | // Exit with the same code as the child process 29 | process.exit(result.status); 30 | } catch (installError) { 31 | console.error('\n\x1b[31mError: Failed to automatically install dependencies\x1b[0m'); 32 | console.error(`\n${installError.message}\n`); 33 | console.error('Please install dependencies manually by running:\n'); 34 | console.error('\x1b[33m cd ' + __dirname + ' && npm install\x1b[0m\n'); 35 | console.error('Then try running this script again.\n'); 36 | return false; 37 | } 38 | } 39 | 40 | function checkDependencies() { 41 | // Check for external dependencies listed in package.json 42 | try { 43 | // Node built-in modules don't need to be checked 44 | // External modules needed for the package 45 | require.resolve('commander'); 46 | 47 | // Try to read package.json to give more helpful error messages 48 | try { 49 | const packageJsonPath = path.join(__dirname, 'package.json'); 50 | const packageData = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); 51 | 52 | return true; 53 | } catch (fsError) { 54 | // If we can't read package.json, continue since we'll already 55 | // check for the critical dependencies 56 | return true; 57 | } 58 | } catch (e) { 59 | const missingModule = e.requireStack ? e.requireStack[0] : e.message.split("\"")[1]; 60 | return installDependenciesAndRestart(`Missing dependency: ${missingModule}`); 61 | } 62 | } 63 | 64 | // Run dependency check 65 | checkDependencies(); 66 | 67 | /** 68 | * mcp-wrapper.js 69 | * 70 | * Copyright (C) 2025 Genworks 71 | * 72 | * This program is free software: you can redistribute it and/or modify 73 | * it under the terms of the GNU Affero General Public License as 74 | * published by the Free Software Foundation, either version 3 of the 75 | * License, or (at your option) any later version. 76 | * 77 | * This program is distributed in the hope that it will be useful, 78 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 79 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 80 | * GNU Affero General Public License for more details. 81 | * 82 | * You should have received a copy of the GNU Affero General Public License 83 | * along with this program. If not, see . 84 | * 85 | * This file is part of the Lisply Model Context Protocol integration. 86 | * 87 | * Wrapper script for Lisply MCP integration with: 88 | * - Configurable backend host and port via environment variables or CLI arguments 89 | * - Docker container management for local deployments (using -i mode for automatic cleanup) 90 | * - Support for running inside a container or directly on the host 91 | * - Support for mounting volumes into the backend container 92 | */ 93 | 94 | // Now we can safely require the modules 95 | try { 96 | const { program } = require('commander'); 97 | const { createLogger } = require('./lib/logger'); 98 | const { loadConfig, checkPortConflicts } = require('./lib/config'); 99 | const { isDockerAvailable, cleanup, startBackendContainer, tryAttachToContainer } = require('./lib/docker'); 100 | const { checkBackendAvailability, startMcpWrapper } = require('./lib/server'); 101 | const handlers = require('./handlers'); 102 | 103 | // Parse command line arguments 104 | program 105 | .option('-H, --backend-host ', 'Backend server host (default: 127.0.0.1)') 106 | .option('--swank-host-port ', 'SWANK port on host system (default: 4201)') 107 | .option('--http-host-port ', 'HTTP port on host system (default: 9081)') 108 | .option('--https-host-port ', 'HTTPS port on host system (default: 9444)') 109 | .option('--telnet-host-port ', 'TELNET port on host system (default: 4024)') 110 | .option('--http-port ', 'HTTP port inside container (default: 9080)') 111 | .option('--https-port ', 'HTTPS port inside container (default: 9443)') 112 | .option('--swank-port ', 'SWANK port inside container (default: 4200)') 113 | .option('--telnet-port ', 'TELNET port inside container (default: 4023)') 114 | .option('--image-base-name ', 'Base name for Docker image (default: genworks/gendl)') 115 | .option('--image-branch ', 'Branch to use for Docker image (default: auto-detected)') 116 | .option('--docker-image ', 'Full Docker image for backend (overrides base name and branch)') 117 | .option('--lisp-impl ', 'Lisp implementation to use, ccl or sbcl (default: ccl)') 118 | .option('--no-auto-start', 'Do not auto-start backend docker container if not running') 119 | .option('--docker-socket ', 'Path to docker socket (default: /var/run/docker.sock)') 120 | .option('--log-file ', 'Path to log file (default: /tmp/lisply-mcp-wrapper.log)') 121 | .option('--debug', 'Enable debug logging') 122 | .option('--mount ', 'Mount volumes in format "src:dst" (can specify multiple times)', (value, previous) => previous.concat([value]), []) 123 | .option('--start-http', 'Start HTTP service in backend container (default: true)') 124 | .option('--start-https', 'Start HTTPS service in backend container (default: false)') 125 | .option('--start-swank', 'Start SWANK service in backend container (default: true)') // for CL-based servers 126 | .option('--start-telnet', 'Start TELNET service in backend container (default: false)') 127 | .option('--no-use-stdio', 'Disable stdio capability for local containers. When disabled, HTTP mode will always be used even when stdio mode is requested.') 128 | .option('--repl-prompt ', 'REPL prompt pattern to detect Lisp evaluation completion (default: ?)') 129 | .option('--eval-timeout ', 'Timeout for Lisp evaluation in milliseconds (default: 30000)') 130 | .option('--endpoint-prefix ', 'Prefix for all endpoints (default: lisply)') 131 | .option('--lisp-eval-endpoint ', 'Endpoint name for Lisp evaluation (default: lisp-eval)') 132 | .option('--http-request-endpoint ', 'Endpoint name for HTTP requests (default: http-request)') 133 | .option('--ping-endpoint ', 'Endpoint name for ping (default: ping-lisp)') 134 | .parse(process.argv); 135 | 136 | // Load configuration 137 | const config = loadConfig(program); 138 | 139 | // Create logger 140 | const logger = createLogger(config); 141 | 142 | // Check port conflicts 143 | checkPortConflicts(config); 144 | 145 | // Initialize globals 146 | global.isMcpWrapperStarted = false; 147 | global.backendContainerName = null; 148 | global.dockerProcess = null; 149 | 150 | // Log configuration 151 | logger.info(`Starting MCP wrapper with backend host: ${config.BACKEND_HOST}, SWANK port: ${config.SWANK_HOST_PORT}, HTTP port: ${config.HTTP_HOST_PORT}`); 152 | logger.info(`Auto-start is ${config.AUTO_START ? 'enabled' : 'disabled'}, Docker image: ${config.options.dockerImage || 'auto-detected'}`); 153 | logger.info(`Stdio capability for local containers: ${config.NO_USE_STDIO ? 'disabled' : 'enabled'} (default: enabled), HTTP is default mode, Prompt: '${config.REPL_PROMPT}', Timeout: ${config.EVAL_TIMEOUT}ms`); 154 | logger.info(`Endpoint prefix: ${config.ENDPOINT_PREFIX}, Endpoints - Eval: ${config.EVAL_ENDPOINT}, HTTP: ${config.HTTP_REQUEST_ENDPOINT}, Ping: ${config.PING_ENDPOINT}`); 155 | if (config.ALL_MOUNTS.length > 0) { 156 | logger.info(`Configured mounts: ${config.ALL_MOUNTS.join(', ')}`); 157 | } 158 | 159 | // Check if Lisp implementation is supported 160 | if (!config.SUPPORTED_IMPLS.includes(config.LISP_IMPL)) { 161 | logger.warn(`Unsupported Lisp implementation: ${config.LISP_IMPL}, defaulting to ${config.DEFAULT_IMPL}`); 162 | } 163 | 164 | // Main promise chain 165 | try { 166 | checkBackendAvailability(config, logger) 167 | .then(available => { 168 | if (available) { 169 | logger.info(`Backend service already available at ${config.BACKEND_HOST}:${config.HTTP_HOST_PORT}`); 170 | startMcpWrapper(config, logger, handlers); 171 | return Promise.resolve(true); 172 | } else { 173 | const isLocalHost = (config.BACKEND_HOST === '127.0.0.1' || config.BACKEND_HOST === 'localhost'); 174 | const dockerAvailable = isDockerAvailable(logger, config.DOCKER_SOCKET); 175 | 176 | if (config.AUTO_START && isLocalHost && dockerAvailable) { 177 | logger.info(`Backend server not available, attempting to start container`); 178 | return startBackendContainer(config, logger, checkBackendAvailability); 179 | } else { 180 | logger.error(`Cannot start backend container. Conditions not met: 181 | - Auto-start: ${config.AUTO_START} 182 | - Local host: ${isLocalHost} 183 | - Docker available: ${dockerAvailable}`); 184 | process.exit(1); 185 | } 186 | } 187 | }) 188 | .then((containerStarted) => { 189 | if (!global.isMcpWrapperStarted) { 190 | startMcpWrapper(config, logger, handlers); 191 | } 192 | }) 193 | .catch(error => { 194 | logger.error(`Failed to start MCP wrapper: ${error.message}`); 195 | if (error.stack) { 196 | logger.error(`Error stack: ${error.stack}`); 197 | } 198 | process.exit(1); 199 | }); 200 | } catch (error) { 201 | // If we get here, it means an error occurred before the promises could be set up 202 | // This is likely due to a module not being available 203 | console.error('\n\x1b[31mError: Failed to start MCP wrapper\x1b[0m'); 204 | console.error(`\n${error.message}\n`); 205 | 206 | // Check if this is a module not found error 207 | if (error.code === 'MODULE_NOT_FOUND') { 208 | installDependenciesAndRestart('Missing dependency detected during execution'); 209 | } else { 210 | console.error('For troubleshooting, try:\n'); 211 | console.error('1. Check that all dependencies are installed:\n'); 212 | console.error('\x1b[33m cd /projects/lisply-mcp/scripts && npm install\x1b[0m\n'); 213 | console.error('2. Check the log file for more details on the error.\n'); 214 | } 215 | 216 | // If we can't use the logger yet, at least print the stack trace to console 217 | if (error.stack) { 218 | console.error('\nError stack trace:'); 219 | console.error(error.stack); 220 | } 221 | 222 | process.exit(1); 223 | } 224 | 225 | // Set up process events for cleanup 226 | process.on('SIGINT', async () => { 227 | logger.info('Received SIGINT signal - cleaning up and exiting'); 228 | await cleanup(logger); 229 | process.exit(0); 230 | }); 231 | 232 | process.on('SIGTERM', async () => { 233 | logger.info('Received SIGTERM signal - cleaning up and exiting'); 234 | await cleanup(logger); 235 | process.exit(0); 236 | }); 237 | 238 | // Catch unhandled promise rejections 239 | process.on('unhandledRejection', (reason, promise) => { 240 | try { 241 | logger.error(`Unhandled promise rejection: ${reason}`); 242 | if (reason instanceof Error && reason.stack) { 243 | logger.error(`Stack trace: ${reason.stack}`); 244 | } 245 | 246 | // If this looks like a module error, give specific advice 247 | if (reason instanceof Error && reason.code === 'MODULE_NOT_FOUND') { 248 | installDependenciesAndRestart('Missing dependency detected in promise'); 249 | } 250 | } catch (e) { 251 | // If logger is not available, use console directly 252 | console.error(`Unhandled promise rejection: ${reason}`); 253 | if (reason instanceof Error && reason.stack) { 254 | console.error(`Stack trace: ${reason.stack}`); 255 | } 256 | } 257 | }); 258 | } catch (error) { 259 | // If we get here, it means an error occurred when requiring the modules 260 | console.error('\n\x1b[31mError: Failed to load required modules\x1b[0m'); 261 | console.error(`\n${error.message}\n`); 262 | 263 | // Check if this is a module not found error 264 | if (error.code === 'MODULE_NOT_FOUND') { 265 | installDependenciesAndRestart('Missing module: ' + error.message.split('"')[1]); 266 | } else { 267 | console.error('For troubleshooting, try:\n'); 268 | console.error('1. Check that all dependencies are installed:\n'); 269 | console.error('\x1b[33m cd ' + __dirname + ' && npm install\x1b[0m\n'); 270 | console.error('2. Check if any module paths are incorrect.\n'); 271 | 272 | // Print the stack trace to console 273 | if (error.stack) { 274 | console.error('\nError stack trace:'); 275 | console.error(error.stack); 276 | } 277 | 278 | process.exit(1); 279 | } 280 | } 281 | -------------------------------------------------------------------------------- /scripts/package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lisply-mcp-wrapper", 3 | "version": "1.0.0", 4 | "lockfileVersion": 3, 5 | "requires": true, 6 | "packages": { 7 | "": { 8 | "name": "lisply-mcp-wrapper", 9 | "version": "1.0.0", 10 | "license": "AGPL-3.0", 11 | "dependencies": { 12 | "commander": "^11.0.0" 13 | } 14 | }, 15 | "node_modules/commander": { 16 | "version": "11.1.0", 17 | "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", 18 | "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", 19 | "engines": { 20 | "node": ">=16" 21 | } 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /scripts/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lisply-mcp-wrapper", 3 | "version": "1.0.0", 4 | "description": "MCP wrapper for Lisply backends with configurable server settings and Docker integration", 5 | "main": "mcp-wrapper.js", 6 | "scripts": { 7 | "start": "node mcp-wrapper.js" 8 | }, 9 | "author": "Genworks", 10 | "license": "AGPL-3.0", 11 | "dependencies": { 12 | "commander": "^11.0.0" 13 | } 14 | } -------------------------------------------------------------------------------- /scripts/robot-lambda.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gornskew/lisply-mcp/99b6c090096a37cea46935556e4a6a2c590aa3a7/scripts/robot-lambda.png --------------------------------------------------------------------------------