coinex-mcp-server 0.1.0a6__tar.gz

coinex_mcp_server-0.1.0a6/.env.example

@@ -0,0 +1,9 @@
+# CoinEx API Credentials
+# Get your API credentials from: https://www.coinex.com/
+COINEX_ACCESS_ID=your_access_id_here
+COINEX_SECRET_KEY=your_secret_key_here
+
+# Optional: HTTP Authentication Settings
+# HTTP_AUTH_ENABLED=true
+# API_TOKEN=your_bearer_token_here
+# API_SCOPES=read,write

coinex_mcp_server-0.1.0a6/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 [yyyy] [name of copyright owner]
+
+   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.

coinex_mcp_server-0.1.0a6/MANIFEST.in

@@ -0,0 +1,22 @@
+# Include documentation files
+include README.md
+include README_cn.md
+include LICENSE
+
+# Include configuration examples
+include .env.example
+
+# Exclude development and build files
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.dylib
+
+# Exclude test and development directories
+prune tests
+prune .git
+prune .idea
+prune .pytest_cache
+prune .venv
+prune deploy

coinex_mcp_server-0.1.0a6/PKG-INFO

@@ -0,0 +1,346 @@
+Metadata-Version: 2.4
+Name: coinex-mcp-server
+Version: 0.1.0a6
+Summary: A CoinEx MCP (Model Context Protocol) server that enables AI agents to interact with the CoinEx cryptocurrency exchange
+Author: CoinEx MCP Contributors
+Maintainer: CoinEx MCP Contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/coinexcom/coinex_mcp_server
+Project-URL: Repository, https://github.com/coinexcom/coinex_mcp_server
+Project-URL: Documentation, https://github.com/coinexcom/coinex_mcp_server#readme
+Project-URL: Bug Tracker, https://github.com/coinexcom/coinex_mcp_server/issues
+Keywords: coinex,mcp,model-context-protocol,cryptocurrency,exchange,trading,api,fastmcp,ai-agent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Framework :: AsyncIO
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: fastmcp==2.12.4
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: pydantic>=2.7.0
+Dynamic: license-file
+
+# CoinEx MCP Server
+
+[中文版本](README_cn.md) | English
+
+A CoinEx MCP (Model Context Protocol) server that enables AI agents to interact with the CoinEx cryptocurrency exchange.
+
+## Features
+
+- 🔍 Retrieve market data (spot/futures with unified parameters)
+- 💰 Query account balances (authentication required)
+- 📊 Get K-line data (spot/futures)
+- 📈 View order book depth (spot/futures)
+- 💹 Place orders (authentication required)
+- 📋 Query order history (authentication required)
+- 📜 Futures-specific: funding rates, premium/basis history, margin tiers, liquidation history, etc.
+
+## Installation & Configuration
+
+### 1. Install Dependencies
+
+```bash
+uv sync
+```
+
+### 2. Configure API Credentials
+
+In the default stdio mode, API credentials are obtained through environment variables, but typically MCP servers are not launched directly from the command line. You can configure credentials in two ways:
+
+#### 2.1 MCP Client Configuration
+Through MCP clients like Claude Desktop, CherryStudio, or mcp inspector.
+
+#### 2.2 Local File Configuration
+1. Copy the environment variable template file:
+```bash
+cp .env.example .env
+```
+
+2. Edit the `.env` file and fill in your CoinEx API credentials:
+```env
+COINEX_ACCESS_ID=your_access_id_here
+COINEX_SECRET_KEY=your_secret_key_here
+```
+_Note: In SSE or Streamable HTTP mode, environment variable credentials will be ignored._
+
+### 3. Obtain CoinEx API Credentials
+
+1. Log in to [CoinEx Official Website](https://www.coinex.com/)
+2. Go to **User Center** -> **API Management**
+3. Create a new API Key
+4. Copy the Access ID and Secret Key to your `.env` file
+
+⚠️ **Security Notice**:
+- Keep your API credentials safe and do not share them with others
+- Set appropriate permissions for your API Key, only enabling necessary functions
+- Do not commit the `.env` file to version control systems
+
+## MCP Client Configuration
+
+As published to PyPI, you can configure MCP clients to use this server without pre-installing the package.
+
+### Using uvx (Recommended)
+
+[uvx](https://docs.astral.sh/uv/guides/tools/) automatically manages package installation and environment isolation, similar to npx for Node.js.
+
+#### Claude Desktop Configuration
+
+Edit your Claude Desktop configuration file:
+- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+- Linux: `~/.config/Claude/claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "coinex": {
+      "command": "uvx",
+      "args": ["coinex-mcp-server"],
+      "env": {
+        "COINEX_ACCESS_ID": "your_access_id_here",
+        "COINEX_SECRET_KEY": "your_secret_key_here"
+      }
+    }
+  }
+}
+```
+
+#### CherryStudio Configuration
+
+In CherryStudio's MCP settings, add:
+
+```json
+{
+  "mcpServers": {
+    "coinex": {
+      "command": "uvx",
+      "args": ["coinex-mcp-server"],
+      "env": {
+        "COINEX_ACCESS_ID": "your_access_id_here",
+        "COINEX_SECRET_KEY": "your_secret_key_here"
+      }
+    }
+  }
+}
+```
+
+#### HTTP Mode with uvx
+
+To run the server in HTTP mode:
+
+```json
+{
+  "mcpServers": {
+    "coinex-http": {
+      "command": "uvx",
+      "args": [
+        "coinex-mcp-server",
+        "--transport",
+        "http",
+        "--host",
+        "127.0.0.1",
+        "--port",
+        "8000",
+        "--path",
+        "/mcp"
+      ]
+    }
+  }
+}
+```
+
+### Using Pre-installed Package
+
+If you prefer to install the package first:
+
+```bash
+# Install the package
+pip install coinex-mcp-server
+
+# Or with uv
+uv pip install coinex-mcp-server
+```
+
+Then configure your MCP client:
+
+```json
+{
+  "mcpServers": {
+    "coinex": {
+      "command": "python",
+      "args": [
+        "-m",
+        "coinex_mcp_server.main"
+      ],
+      "env": {
+        "COINEX_ACCESS_ID": "your_access_id_here",
+        "COINEX_SECRET_KEY": "your_secret_key_here"
+      }
+    }
+  }
+}
+```
+
+## From Source Usage
+
+### clone the project
+`git clone https://github.com/coinexcom/coinex_mcp_server`
+
+### Start the Server
+
+```bash
+python -m coinex_mcp_server.main
+```
+
+### Command Line Arguments & Examples
+
+The server supports command line arguments for switching transport protocols and network configuration:
+
+- `--transport`: Transport protocol, options: `stdio` (default) | `http` (equivalent to `streamable-http`) | `streamable-http` | `sse`
+- `--host`: HTTP service bind address (only valid for http/streamable-http mode)
+- `--port`: HTTP service port (only valid for http/streamable-http mode)
+- `--path`: Endpoint path
+  - http/streamable-http mode: MCP endpoint path (default `/mcp`)
+  - sse mode: SSE mount path
+- `--enable-http-auth`: Enable HTTP-based authentication and sensitive tools (disabled by default, only exposes query tools)
+- `--workers`: Number of worker processes for HTTP/SSE mode (managed by underlying uvicorn)
+
+#### View Help:
+```bash
+python -m coinex_mcp_server.main --help
+```
+
+#### Default stdio Service Start
+(Usually no manual start needed, configure startup file and parameters in agent)
+```bash
+python -m coinex_mcp_server.main
+```
+
+#### Start HTTP Service
+```bash
+python -m coinex_mcp_server.main --transport http --host 0.0.0.0 --port 8000 --path /mcp --workers 2
+```
+
+Note: If using HTTP GET method to directly access the `/mcp` endpoint, it may return `406 Not Acceptable`, which is normal—Streamable HTTP endpoints require protocol-compliant interaction flows; this return code also proves the HTTP service has started and is responding.
+
+### Pass CoinEx Credentials via HTTP Headers (HTTP Mode)
+The server does not store third-party exchange credentials. For tools requiring authentication (balance/place order/cancel order/order history), include the following headers in HTTP requests (case-insensitive):
+- `X-CoinEx-Access-Id: <your CoinEx Access ID>`
+- `X-CoinEx-Secret-Key: <your CoinEx Secret Key>`
+
+**Important Notes**
+- **Never** enable credential pass-through functionality in publicly exposed services; ensure the entire server backend is controlled within an internal network! (Even with HTTPS transport, reverse proxies and other server nodes may offload request headers and log them)
+- Deploy via HTTPS to prevent man-in-the-middle eavesdropping (use reverse proxy/Nginx/Caddy to add TLS to MCP endpoints).
+- These headers are only needed when "HTTP authentication is enabled" and you're calling tools that require user credentials (auth tag).
+  - Enable with: `--enable-http-auth` or set environment variable `HTTP_AUTH_ENABLED=true`
+  - By default, HTTP authentication is disabled, exposing only query tools (public), which don't need or read the above headers.
+- Only valid for HTTP/Streamable HTTP mode; STDIO mode reads credentials from environment variables (or .env config file).
+
+### Logging & Security
+- Ensure reverse proxies/APM/logging systems don't record sensitive headers like `Authorization` or `X-CoinEx-*`.
+
+## Tools Overview
+
+Note: In HTTP mode, only `public` type tools are exposed by default; `auth` type tools require enabling `--enable-http-auth` or setting `HTTP_AUTH_ENABLED=true` to be available.
+
+### Standard Parameter Conventions:
+- `market_type`: Default `"spot"`, use `"futures"` for contracts.
+- `symbol`: Supports `BTCUSDT` / `BTC/USDT` / `btc` / `BTC` (defaults to `USDT` if no quote currency).
+- `interval` (depth aggregation levels): Default `"0"`.
+- `period`: Default `"1hour"`, validated against spot/futures whitelists.
+- `start_time`/`end_time`: Millisecond timestamps.
+
+### Market Data (public)
+* `list_markets(market_type="spot"|"futures", symbols: str|list[str]|None)`
+  - Get market status; `symbols` can be comma-separated or array, returns all if not provided.
+* `get_tickers(market_type="spot"|"futures", symbol: str|list[str]|None, top_n=5)`
+  - Get ticker snapshots; returns top `top_n` when `symbol` not provided.
+* `get_orderbook(symbol, limit=20, market_type="spot"|"futures", interval="0")`
+  - Get order book (depth); supports futures.
+* `get_kline(symbol, period="1hour", limit=100, market_type="spot"|"futures")`
+  - Get K-line data; periods validated against respective spot/futures whitelists.
+* `get_recent_trades(symbol, market_type="spot"|"futures", limit=100)`
+  - Get recent trades (deals).
+* `get_index_price(market_type="spot"|"futures", symbol: str|list[str]|None, top_n=5)`
+  - Get market index (spot/futures).
+
+### Futures-Specific (public)
+* `get_funding_rate(symbol)`
+  - Get current funding rate.
+* `get_funding_rate_history(symbol, start_time?, end_time?, page=1, limit=100)`
+  - Get funding rate history.
+* `get_premium_index_history(symbol, start_time?, end_time?, page=1, limit=100)`
+  - Get premium index history.
+* `get_basis_history(symbol, start_time?, end_time?, page=1, limit=100)`
+  - Get basis rate history.
+* `get_position_tiers(symbol)`
+  - Get position tiers/margin tier information.
+* `get_liquidation_history(symbol?, side?, start_time?, end_time?, page=1, limit=100)`
+  - Get liquidation history.
+
+### Account & Trading (auth)
+* `get_account_balance()`
+  - Get account balance information.
+* `place_order(symbol, side, type, amount, price?)`
+  - Place trading order.
+* `cancel_order(symbol, order_id)`
+  - Cancel order.
+* `get_order_history(symbol?, limit=100)`
+  - Get order history (open orders + completed orders).
+
+## Environment Variables
+
+| Variable | Description | Required |
+|----------|-------------|----------|
+| `COINEX_ACCESS_ID` | CoinEx API Access ID | No (optional with HTTP pass-through) |
+| `COINEX_SECRET_KEY` | CoinEx API Secret Key | No (optional with HTTP pass-through) |
+| `API_TOKEN` | Bearer token to protect MCP endpoint | No |
+| `API_SCOPES` | Required scopes for endpoint | No |
+| `HTTP_AUTH_ENABLED` | Enable HTTP authentication (default false) | No |
+
+## Development
+
+### Project Structure
+
+```
+coinex_mcp_server/
+├── main.py              # MCP server main file
+├── coinex_client.py     # CoinEx API client (unified spot/futures wrapper)
+├── doc/
+│   ├── coinex_api/      
+│   │   └── coinex_api.md # CoinEx API documentation
+├── pyproject.toml       # Project configuration
+└── README.md           # Project documentation
+```
+
+### Dependencies
+
+- `fastmcp` - FastMCP framework (2.x)
+- `httpx` - HTTP client
+- `python-dotenv` - Environment variable loading
+
+## Troubleshooting
+- If calls return `code != 0`, record the `message` and check parameters (`period`, `limit`, `symbol` normalization).
+- In corporate network environments or with firewall restrictions, external APIs may be blocked; please verify network policies.
+
+## License
+
+This project is open source under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
+
+## Contributing
+Issues and Pull Requests are welcome!
+
+## Disclaimer
+This tool is for educational and research purposes only. When using this tool for actual trading, please fully understand the risks and operate carefully. The developers are not responsible for any losses resulting from the use of this tool.