goodcryptox-connector 0.0.0-stage → 3.1.1

package/LICENSE

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

package/README.md

@@ -1,3 +1,21 @@
-# Temporary Holding Version
+# goodcryptoX connector
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Connects an AI app (Claude Code, Codex, Cursor or any app that speaks MCP over standard input and output) to **your own goodcryptoX installation**, as far as the access key you give it allows: reading your accounts, orders, bots and history; proposing orders and bots for you to launch; or, with a Trade key, trading within the limits you set on the key.
+
+You do not install this package yourself. In goodcryptoX, open **Settings › MCP & API**, pick a key, and copy the line for your app: it runs this package at the exact version of your goodcryptoX, with your installation's address and your key filled in. The guide: [Connect an AI agent](https://docs.goodcrypto.app/goodcryptox-3.0/connect-an-ai-agent).
+
+## Where it connects
+
+The copied line names your installation in two ways: its address on the computer that runs it, and our relay. The connector first asks that address, once and without your key, which installation answers there; it connects directly only when that is your installation, and otherwise through our relay, which cannot read your access key, requests or replies. The first connection through the relay pairs this computer once, with a one-use code that the copied line carries and that expires after a day if it is not used.
+
+## What it does not do
+
+It reads nothing else on your computer, keeps no access key (your app holds it), opens no port unless you run its `connect` mode for a program of your own, and talks only to your installation and our relay.
+
+## Requirements
+
+Node.js 18 or newer on the computer that runs your AI app.
+
+## Security
+
+See [SECURITY.md](SECURITY.md).

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+Report a vulnerability in the goodcryptoX connector to **support@goodcrypto.app** with "Security" in the subject. Please do not open a public issue for it.
+
+Never send your access key, a copied setup line or a screenshot of one: each can carry a secret. Revoke a key you think was exposed in goodcryptoX under **Settings › MCP & API**.