@caseywebb/elm-package-mcp-server 0.2.0-nightly.20251010.3ed2712

package/LICENSE

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

package/README.md

@@ -0,0 +1,263 @@
+# Elm Package MCP Server
+
+> [!CAUTION]
+> This is vibe-coded. I barely know Rust. I've read the code, but use at your own risk.
+
+[![CI](https://github.com/caseyWebb/elm-package-mcp-server/workflows/CI/badge.svg)](https://github.com/caseyWebb/elm-package-mcp-server/actions/workflows/ci.yml)
+[![Nightly Build](https://github.com/caseyWebb/elm-package-mcp-server/workflows/Nightly%20Build/badge.svg)](https://github.com/caseyWebb/elm-package-mcp-server/actions/workflows/nightly.yml)
+[![GitHub release](https://img.shields.io/github/v/release/caseyWebb/elm-package-mcp-server)](https://github.com/caseyWebb/elm-package-mcp-server/releases/latest)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+An MCP (Model Context Protocol) server that provides tools for looking up Elm package documentation. This server allows AI assistants to read elm.json files and fetch package documentation from the official Elm package repository.
+
+## Features
+
+- **List Elm Packages**: List all direct and indirect Elm language dependencies from elm.json
+- **Fetch Elm Package README**: Get the README content for any Elm package by specifying author, name, and version
+- **Get Elm Package Exports**: Get all exports from Elm package modules with their type signatures but WITHOUT comments (more efficient for exploring available functions)
+- **Get Elm Package Export Docs**: Get the documentation comment for a specific export (function, type, or alias) in an Elm package module
+
+## Installation
+
+### Using npx (Recommended)
+
+The easiest way to use this MCP server is via npx (macOS only):
+
+```bash
+npx @caseywebb/elm-package-mcp-server --mcp
+```
+
+To configure with Claude Desktop:
+
+```json
+{
+  "mcpServers": {
+    "elm-package": {
+      "command": "npx",
+      "args": ["@caseywebb/elm-package-mcp-server", "--mcp"]
+    }
+  }
+}
+```
+
+To configure with Zed:
+
+```json
+{
+  "elm-package": {
+    "command": "npx",
+    "args": ["@caseywebb/elm-package-mcp-server", "--mcp"],
+    "env": {}
+  }
+}
+```
+
+### From GitHub Releases
+
+The easiest way to install is to download a pre-built binary from the [latest release](https://github.com/caseyWebb/elm-package-mcp-server/releases/latest).
+
+1. Download the appropriate binary for your platform:
+   - Linux x86_64: `elm-package-mcp-server-linux-x86_64.tar.gz`
+   - macOS x86_64 (Intel): `elm-package-mcp-server-macos-x86_64.tar.gz`
+   - macOS aarch64 (Apple Silicon): `elm-package-mcp-server-macos-aarch64.tar.gz`
+
+2. Extract the binary:
+   ```bash
+   tar xzf elm-package-mcp-server-*.tar.gz
+   ```
+
+3. Move the binary to a location in your PATH:
+   ```bash
+   # System-wide installation
+   sudo mv elm-package-mcp-server /usr/local/bin/
+   
+   # User installation
+   mv elm-package-mcp-server ~/.local/bin/
+   ```
+
+4. Make sure the binary is executable:
+   ```bash
+   chmod +x /path/to/elm-package-mcp-server
+   ```
+
+### Building from Source
+
+1. Make sure you have Rust installed (https://rustup.rs/)
+2. Clone this repository
+3. Build the binary:
+
+```bash
+cargo build --release
+```
+
+The binary will be available at `target/release/elm-package-mcp-server`
+
+## Configuration
+
+### Claude Desktop
+
+To use this MCP server with Claude Desktop, add the following to your Claude Desktop configuration:
+
+1. Open Claude Desktop settings
+2. Go to Developer → Edit Config
+3. Add the following to the `mcpServers` section:
+
+```json
+{
+  "mcpServers": {
+    "elm-package": {
+      "command": "/path/to/elm-package-mcp-server",
+      "args": ["--mcp"]
+    }
+  }
+}
+```
+
+Replace `/path/to/elm-package-mcp-server` with the actual path to your built binary.
+
+### Zed
+
+- Open the Assistant Panel (<kbd>Cmd</kbd>+<kbd>?</kbd>)
+- Click "Add Custom Server..."
+- Enter the following in the window that appears:
+
+```json
+{
+  "elm-package": {
+    "command": "/path/to/elm-package-mcp-server",
+    "args": ["--mcp"],
+    "env": {}
+  }
+}
+```
+
+Replace `/path/to/elm-package-mcp-server` with the actual path to your built binary.
+
+## Usage
+
+The server must be run from a directory containing an elm.json file or any subdirectory of an Elm project. It will automatically find the elm.json file by searching up the directory tree.
+
+### Available Tools
+
+The server provides four tools for working with Elm packages. All tools are prefixed with `elm` to help with discoverability when working with Elm language projects.
+
+#### list_elm_packages
+Lists all Elm packages from elm.json file. This tool discovers available Elm language dependencies in your project.
+
+Parameters:
+- `include_indirect` (optional, boolean): Include indirect dependencies (default: false)
+
+Example response:
+```json
+{
+  "packages": [
+    {
+      "author": "elm",
+      "name": "core",
+      "version": "1.0.5",
+      "type": "direct"
+    }
+  ],
+  "total": 1,
+  "direct_count": 1,
+  "indirect_count": 0
+}
+```
+
+#### get_elm_package_readme
+Fetches the README documentation for a specific Elm language package from package.elm-lang.org.
+
+Parameters:
+- `author` (required, string): Package author (e.g., "elm")
+- `name` (required, string): Package name (e.g., "core")
+- `version` (required, string): Package version (e.g., "1.0.5")
+
+#### get_elm_package_exports
+Get all exports from Elm package modules with their type signatures but WITHOUT comments. This is more efficient than get_elm_package_docs when you just need to explore available functions.
+
+Parameters:
+- `author` (required, string): Package author (e.g., "elm")
+- `name` (required, string): Package name (e.g., "core")
+- `version` (required, string): Package version (e.g., "1.0.5")
+- `module` (optional, string): Filter to a specific module
+
+Example response includes all exports organized by type (unions, aliases, values, binops) with their type signatures but without documentation comments.
+
+#### get_elm_package_export_docs
+Get the documentation comment for a specific export (function, type, or alias) in an Elm package module.
+
+Parameters:
+- `author` (required, string): Package author (e.g., "elm")
+- `name` (required, string): Package name (e.g., "core")
+- `version` (required, string): Package version (e.g., "1.0.5")
+- `module` (required, string): Module name (e.g., "List")
+- `export_name` (required, string): Name of the export to get comment for (e.g., "map", "Maybe")
+
+Example response:
+```json
+{
+  "author": "elm",
+  "name": "core",
+  "version": "1.0.5",
+  "module": "List",
+  "export_name": "map",
+  "export_type": "value",
+  "type_annotation": "map : (a -> b) -> List a -> List b",
+  "comment": "Apply a function to every element of a list..."
+}
+```
+
+### Workflow Example
+
+1. First, use `list_elm_packages` to discover available packages:
+   - This returns all packages with their authors, names, and versions
+2. Then, use the returned information to fetch documentation:
+   - Call `get_elm_package_readme` with author, name, and version for overview
+   - Call `get_elm_package_exports` to see all available functions and types without comments
+   - Call `get_elm_package_export_docs` to get detailed documentation for specific items
+
+### Available Resources
+
+#### elm://elm.json
+The project's elm.json file, accessible as a resource.
+
+## CLI Options
+
+- `--mcp`: Run as an MCP server for Elm package documentation
+- `--tools`: Display available Elm package tools
+- `--resources`: Display available resources
+- `--prompts`: Display available prompts
+- `--json`: Output information in JSON format
+
+## Development
+
+This server is built using:
+- [rpc-router](https://github.com/jeremychone/rust-rpc-router/) for JSON-RPC routing
+- [reqwest](https://github.com/seanmonstar/reqwest) for HTTP requests
+- [clap](https://github.com/clap-rs/clap) for CLI argument parsing
+
+### Building for npm
+
+To build and publish the npm package (macOS only):
+
+```bash
+# Prepare binaries for current architecture
+just npm-prepare-binaries
+
+# Create npm package tarball
+just npm-pack
+
+# Test locally
+just npm-test-local
+
+# Publish to npm (requires npm login)
+just npm-publish
+```
+
+## Future Plans
+
+This MCP server is designed to be shipped with a Zed extension, which will be developed in the same repository.
+
+## License
+
+Apache-2.0

package/bin/cli.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const os = require('os');
+
+function getBinaryPath() {
+  const platform = os.platform();
+  const arch = os.arch();
+
+  if (platform !== 'darwin') {
+    console.error('Error: Only macOS is currently supported');
+    process.exit(1);
+  }
+
+  let binaryName;
+  if (arch === 'arm64') {
+    binaryName = 'elm-package-mcp-server-macos-aarch64';
+  } else if (arch === 'x64') {
+    binaryName = 'elm-package-mcp-server-macos-x86_64';
+  } else {
+    console.error(`Error: Unsupported architecture: ${arch}`);
+    process.exit(1);
+  }
+
+  return path.join(__dirname, '..', 'binaries', binaryName);
+}
+
+const binaryPath = getBinaryPath();
+const args = process.argv.slice(2);
+
+const child = spawn(binaryPath, args, {
+  stdio: 'inherit'
+});
+
+child.on('error', (err) => {
+  console.error('Error executing binary:', err);
+  process.exit(1);
+});
+
+child.on('exit', (code) => {
+  process.exit(code || 0);
+});

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@caseywebb/elm-package-mcp-server",
+  "private": false,
+  "version": "0.2.0-nightly.20251010.3ed2712",
+  "description": "Model Context Protocol (MCP) server for Elm language package documentation. Provides tools to list Elm packages from elm.json and fetch README/API docs from package.elm-lang.org",
+  "bin": {
+    "elm-package-mcp-server": "./bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "binaries/"
+  ],
+  "scripts": {
+    "prepublishOnly": "test -f binaries/elm-package-mcp-server-macos-x86_64 && test -f binaries/elm-package-mcp-server-macos-aarch64 || (echo 'Error: Binaries not found. Run just npm-prepare-binaries first.' && exit 1)"
+  },
+  "keywords": [
+    "elm",
+    "elm-lang",
+    "mcp",
+    "documentation",
+    "package-manager",
+    "model-context-protocol"
+  ],
+  "author": "Casey Webb <casey@dirtbag.social>",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/caseyWebb/elm-package-mcp-server.git"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin"
+  ]
+}