@tealstreet/exchange-mcp 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,24 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Tealstreet Ltd
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
23
+ Third-party components in this repository keep their own licences; see
24
+ THIRD_PARTY_NOTICES.md.
package/README.md CHANGED
@@ -1,3 +1,34 @@
1
- # Temporary Holding Version
1
+ # @tealstreet/exchange-mcp
2
2
 
3
- 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.
3
+ A stdio MCP server that trades on one exchange through safe-cex. Every exchange gets the same tool names and arguments; tools an adapter leaves unimplemented are not listed.
4
+
5
+ ```sh
6
+ EXCHANGE=bybit EXCHANGE_API_KEY=... EXCHANGE_API_SECRET=... npx @tealstreet/exchange-mcp
7
+ ```
8
+
9
+ ## Environment
10
+
11
+ | Variable | Value |
12
+ |---|---|
13
+ | `EXCHANGE` | safe-cex exchange name, such as `bybit` or `bybitdemo`. Required |
14
+ | `EXCHANGE_TESTNET` | `true` for the exchange's testnet |
15
+ | `EXCHANGE_API_KEY` | API key |
16
+ | `EXCHANGE_API_SECRET` | API secret, to sign in this process |
17
+ | `EXCHANGE_API_PASSPHRASE` | passphrase, on exchanges that use one |
18
+ | `EXCHANGE_SIGNER_HEADER` | header that carries the bytes to sign, base64, for a signing proxy that holds the secret |
19
+ | `EXCHANGE_SIGNER_SIGNATURE` | value the server sends as the signature, for the proxy to replace |
20
+
21
+ Set `EXCHANGE_API_SECRET` or the two signer variables. Signer mode needs an adapter that supports `payloadSigner` and covers HMAC-SHA256 exchanges.
22
+
23
+ ## Tools
24
+
25
+ `get_markets`, `get_tickers`, `get_candles`, `get_balance`, `get_positions`, `get_open_orders`, `get_order_history`, `get_fills`, `get_closed_pnl`, `get_income`, `place_order`, `amend_order`, `cancel_orders`, `cancel_all_orders`, `set_leverage`, `set_position_mode`, `set_margin_type`.
26
+
27
+ The server starts the exchange as soon as it connects, and fetches everything else when asked. It opens no public websockets and turns periodic polling off. Starting still fetches one snapshot of positions, orders and balance, and with a local `EXCHANGE_API_SECRET` most adapters also open their private websocket; signer mode does not, because the websocket login needs the secret.
28
+
29
+ ## Develop
30
+
31
+ ```sh
32
+ yarn test
33
+ yarn build # dist/index.js, one file with no runtime dependencies
34
+ ```