smartapi-mcp 0.1.0__tar.gz

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.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,23 @@
1
+ # Include package metadata and documentation files
2
+ include README.md
3
+ include LICENSE
4
+ include requirements.txt
5
+ include requirements-dev.txt
6
+ include pyproject.toml
7
+
8
+ # Include package data
9
+ recursive-include smartapi_mcp *.py
10
+ recursive-include smartapi_mcp py.typed
11
+
12
+ # Exclude development and build files
13
+ global-exclude *.pyc
14
+ global-exclude __pycache__
15
+ global-exclude *.so
16
+ global-exclude .DS_Store
17
+ exclude .gitignore
18
+ exclude .github
19
+ recursive-exclude tests *
20
+ recursive-exclude .github *
21
+ recursive-exclude build *
22
+ recursive-exclude dist *
23
+ recursive-exclude *.egg-info *
@@ -0,0 +1,441 @@
1
+ Metadata-Version: 2.4
2
+ Name: smartapi-mcp
3
+ Version: 0.1.0
4
+ Summary: Create MCP servers for one or multiple APIs registered in SmartAPI registry
5
+ Author-email: BioThings Team <help@biothings.io>
6
+ Maintainer-email: BioThings Team <help@biothings.io>
7
+ License: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/biothings/smartapi-mcp
9
+ Project-URL: Repository, https://github.com/biothings/smartapi-mcp
10
+ Project-URL: Issues, https://github.com/biothings/smartapi-mcp/issues
11
+ Project-URL: Documentation, https://github.com/biothings/smartapi-mcp#readme
12
+ Keywords: mcp,smartapi,api,server,bioinformatics
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
24
+ Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
25
+ Requires-Python: >=3.10
26
+ Description-Content-Type: text/markdown
27
+ License-File: LICENSE
28
+ Requires-Dist: awslabs_openapi_mcp_server>=0.2.4
29
+ Provides-Extra: dev
30
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
31
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
32
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
33
+ Requires-Dist: ruff>=0.1.0; extra == "dev"
34
+ Requires-Dist: build>=0.8.0; extra == "dev"
35
+ Requires-Dist: twine>=4.0.0; extra == "dev"
36
+ Provides-Extra: test
37
+ Requires-Dist: pytest>=7.0.0; extra == "test"
38
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
39
+ Requires-Dist: pytest-cov>=4.0.0; extra == "test"
40
+ Provides-Extra: docs
41
+ Requires-Dist: sphinx>=5.0.0; extra == "docs"
42
+ Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
43
+ Dynamic: license-file
44
+
45
+ # SmartAPI MCP Server
46
+
47
+ Create MCP (Model Context Protocol) servers for one or multiple APIs registered in the SmartAPI registry.
48
+
49
+ [![Test](https://github.com/biothings/smartapi-mcp/actions/workflows/test.yml/badge.svg)](https://github.com/biothings/smartapi-mcp/actions/workflows/test.yml)
50
+ [![PyPI version](https://badge.fury.io/py/smartapi-mcp.svg)](https://badge.fury.io/py/smartapi-mcp)
51
+ [![Python versions](https://img.shields.io/pypi/pyversions/smartapi-mcp.svg)](https://pypi.org/project/smartapi-mcp/)
52
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
53
+
54
+ ## Overview
55
+
56
+ The SmartAPI MCP Server enables integration between MCP-compatible clients and APIs registered in the SmartAPI registry. This allows for seamless discovery and interaction with bioinformatics and life sciences APIs through standardized MCP protocols.
57
+
58
+ Built on top of the [AWS Labs OpenAPI MCP Server](https://github.com/awslabs/openapi-mcp-server), this project extends MCP support to the extensive collection of APIs available in the SmartAPI registry, with special focus on bioinformatics and life sciences APIs.
59
+
60
+ ## Requirements
61
+
62
+ - Python 3.10 or higher
63
+ - Network access to SmartAPI registry (https://smart-api.info)
64
+ - Dependencies: `awslabs_openapi_mcp_server>=0.2.4`
65
+
66
+ ## Features
67
+
68
+ - 🔍 **SmartAPI Integration**: Direct integration with the SmartAPI registry for API discovery
69
+ - 🏗️ **MCP Protocol Support**: Full MCP (Model Context Protocol) server implementation
70
+ - 🔄 **Async Architecture**: Built with modern Python async/await patterns for high performance
71
+ - 📖 **OpenAPI Validation**: Automatic OpenAPI specification parsing and validation
72
+ - 🛠️ **CLI Interface**: Easy-to-use command-line interface with multiple configuration options
73
+ - 🧬 **Bioinformatics Focus**: Pre-configured API sets for bioinformatics and life sciences
74
+ - 🎯 **Flexible Configuration**: Support for environment variables, arguments, and configuration files
75
+ - 🚀 **Multiple Transport Modes**: Support for both stdio and HTTP transport protocols
76
+ - 🧪 **Comprehensive Testing**: Full test suite with 99% code coverage
77
+
78
+ ## Installation
79
+
80
+ ### From PyPI (recommended)
81
+
82
+ ```bash
83
+ pip install smartapi-mcp
84
+ ```
85
+
86
+ ### From Source
87
+
88
+ ```bash
89
+ git clone https://github.com/biothings/smartapi-mcp.git
90
+ cd smartapi-mcp
91
+ pip install -e .
92
+ ```
93
+
94
+ ### Development Installation
95
+
96
+ ```bash
97
+ git clone https://github.com/biothings/smartapi-mcp.git
98
+ cd smartapi-mcp
99
+ pip install -e ".[dev]"
100
+ ```
101
+
102
+ ## Quick Start
103
+
104
+ ### Command Line Usage
105
+
106
+ #### Start with a predefined API set (recommended)
107
+
108
+ ```bash
109
+ # Use BioThings core APIs (MyGene, MyVariant, MyChem, MyDisease)
110
+ smartapi-mcp --api_set biothings_core
111
+
112
+ # Use all BioThings APIs (with some exclusions)
113
+ smartapi-mcp --api_set biothings_all
114
+ ```
115
+
116
+ #### Start with specific SmartAPI IDs
117
+
118
+ ```bash
119
+ # Single API
120
+ smartapi-mcp --smartapi_id 59dce17363dce279d389100834e43648
121
+
122
+ # Multiple APIs
123
+ smartapi-mcp --smartapi_ids "59dce17363dce279d389100834e43648,09c8782d9f4027712e65b95424adba79"
124
+ ```
125
+
126
+ #### Start with HTTP transport (instead of stdio)
127
+
128
+ ```bash
129
+ # HTTP mode on localhost:8000 (default)
130
+ smartapi-mcp --api_set biothings_core --transport http
131
+
132
+ # Custom host and port
133
+ smartapi-mcp --api_set biothings_core --transport http --host 0.0.0.0 --port 9000
134
+ ```
135
+
136
+ #### Advanced options
137
+
138
+ ```bash
139
+ # Custom logging level
140
+ smartapi-mcp --api_set biothings_core --log-level DEBUG
141
+
142
+ # Custom server name
143
+ smartapi-mcp --api_set biothings_core --server_name "My Custom MCP Server"
144
+
145
+ # Query-based API discovery
146
+ smartapi-mcp --smartapi_q "tags.name=biothings"
147
+
148
+ # Exclude specific APIs
149
+ smartapi-mcp --api_set biothings_all --smartapi_exclude_ids "api_id_1,api_id_2"
150
+ ```
151
+
152
+ ### Python API Usage
153
+
154
+ ```python
155
+ import asyncio
156
+ from smartapi_mcp import (
157
+ get_smartapi_ids,
158
+ load_api_spec,
159
+ get_mcp_server,
160
+ get_merged_mcp_server,
161
+ PREDEFINED_API_SETS
162
+ )
163
+
164
+ async def main():
165
+ # Get SmartAPI IDs using a query
166
+ smartapi_ids = await get_smartapi_ids("tags.name=biothings")
167
+ print(f"Found {len(smartapi_ids)} APIs matching the query")
168
+
169
+ # Load API specification for a specific SmartAPI
170
+ api_spec = load_api_spec("59dce17363dce279d389100834e43648") # MyGene.info
171
+ print(f"Loaded API: {api_spec.get('info', {}).get('title', 'Unknown')}")
172
+
173
+ # Create MCP server for a single API
174
+ server = await get_mcp_server(
175
+ smartapi_id="59dce17363dce279d389100834e43648",
176
+ server_name="MyGene MCP Server"
177
+ )
178
+
179
+ # Create merged MCP server for multiple APIs (recommended approach)
180
+ merged_server = await get_merged_mcp_server(
181
+ api_set="biothings_core", # Use predefined set
182
+ server_name="BioThings Core MCP Server"
183
+ )
184
+
185
+ # Or with specific SmartAPI IDs
186
+ merged_server = await get_merged_mcp_server(
187
+ smartapi_ids=[
188
+ "59dce17363dce279d389100834e43648", # MyGene.info
189
+ "09c8782d9f4027712e65b95424adba79", # MyVariant.info
190
+ ],
191
+ server_name="Custom MCP Server"
192
+ )
193
+
194
+ # Show available predefined API sets
195
+ print(f"Available API sets: {PREDEFINED_API_SETS}")
196
+
197
+ # Run server with stdio transport (default for MCP)
198
+ merged_server.run()
199
+
200
+ # Or run with HTTP transport
201
+ # merged_server.run(transport="http", host="localhost", port=8000)
202
+
203
+ if __name__ == "__main__":
204
+ asyncio.run(main())
205
+ ```
206
+
207
+ ## API Examples
208
+
209
+ ### BioThings Core APIs
210
+
211
+ When you use `--api_set biothings_core`, you get access to these powerful bioinformatics APIs:
212
+
213
+ 1. **MyGene.info** (`59dce17363dce279d389100834e43648`): Gene annotation and information
214
+ 2. **MyVariant.info** (`09c8782d9f4027712e65b95424adba79`): Variant annotation and information
215
+ 3. **MyChem.info** (`8f08d1446e0bb9c2b323713ce83e2bd3`): Chemical and drug information
216
+ 4. **MyDisease.info** (`671b45c0301c8624abbd26ae78449ca2`): Disease information and associations
217
+
218
+ ### Usage with MCP Clients
219
+
220
+ Once the server is running, MCP-compatible clients can discover and use the available tools. Each API endpoint becomes an available MCP tool with:
221
+
222
+ - **Tool discovery**: Clients can list all available API endpoints
223
+ - **Parameter validation**: Automatic parameter validation based on OpenAPI specs
224
+ - **Rich descriptions**: Each tool includes detailed descriptions from the API documentation
225
+ - **Error handling**: Proper error responses for invalid requests
226
+
227
+ ## Configuration
228
+
229
+ The server supports multiple configuration methods:
230
+
231
+ ### Environment Variables
232
+
233
+ ```bash
234
+ # SmartAPI configuration
235
+ export SMARTAPI_ID="59dce17363dce279d389100834e43648"
236
+ export SMARTAPI_IDS="id1,id2,id3"
237
+ export SMARTAPI_Q="tags.name=biothings"
238
+ export SMARTAPI_API_SET="biothings_core"
239
+ export SMARTAPI_EXCLUDE_IDS="exclude_id1,exclude_id2"
240
+
241
+ # Server configuration
242
+ export SERVER_NAME="My SmartAPI MCP Server"
243
+ export TRANSPORT="http"
244
+ export HOST="localhost"
245
+ export PORT="8000"
246
+
247
+ # Then run without arguments
248
+ smartapi-mcp
249
+ ```
250
+
251
+ ### Command Line Arguments
252
+
253
+ All configuration can be provided via command line arguments (see Quick Start section above).
254
+
255
+ ### Predefined API Sets
256
+
257
+ The following predefined API sets are available:
258
+
259
+ - **`biothings_core`**: Core BioThings APIs (MyGene, MyVariant, MyChem, MyDisease)
260
+ - **`biothings_test`**: Core APIs plus SemmedDB (useful for testing)
261
+ - **`biothings_all`**: All BioThings APIs (with some exclusions for stability)
262
+
263
+ ### Configuration Priority
264
+
265
+ 1. Command line arguments (highest priority)
266
+ 2. Environment variables
267
+ 3. Default values (lowest priority)
268
+
269
+ ## Development
270
+
271
+ ### Setting up Development Environment
272
+
273
+ ```bash
274
+ # Clone the repository
275
+ git clone https://github.com/biothings/smartapi-mcp.git
276
+ cd smartapi-mcp
277
+
278
+ # Install development dependencies
279
+ pip install -e ".[dev]"
280
+ ```
281
+
282
+ ### Running Tests
283
+
284
+ ```bash
285
+ # Run all tests
286
+ pytest
287
+
288
+ # Run with coverage
289
+ pytest --cov=smartapi_mcp --cov-report=html
290
+
291
+ # Run specific test file
292
+ pytest tests/test_basic.py
293
+ ```
294
+
295
+ ### Code Quality
296
+
297
+ ```bash
298
+ # Check and fix linting issues
299
+ ruff check .
300
+ ruff check . --fix
301
+
302
+ # Format code
303
+ ruff format .
304
+ ```
305
+
306
+ ### Building the Package
307
+
308
+ ```bash
309
+ # Build source and wheel distributions
310
+ python -m build
311
+
312
+ # Check the built package
313
+ twine check dist/*
314
+ ```
315
+
316
+ ## Publishing to PyPI
317
+
318
+ ### Manual Publishing
319
+
320
+ ```bash
321
+ # Build the package
322
+ python -m build
323
+
324
+ # Upload to Test PyPI (optional)
325
+ twine upload --repository testpypi dist/*
326
+
327
+ # Upload to PyPI
328
+ twine upload dist/*
329
+ ```
330
+
331
+ ### Automated Publishing
332
+
333
+ This repository includes GitHub Actions workflows for automated testing and publishing:
334
+
335
+ - **Test Workflow** (`.github/workflows/test.yml`): Runs on every push and pull request
336
+ - **Publish Workflow** (`.github/workflows/publish.yml`): Publishes to PyPI on release
337
+
338
+ To publish a new version:
339
+
340
+ 1. Update the version in `pyproject.toml` and `smartapi_mcp/__init__.py`
341
+ 2. Commit the version changes
342
+ 3. Create and push a git tag: `git tag v0.1.0 && git push origin v0.1.0`
343
+ 4. Create a new release on GitHub
344
+ 5. The publish workflow will automatically build and upload to PyPI
345
+
346
+ ### Manual Workflow Trigger
347
+
348
+ You can also manually trigger the publish workflow to upload to Test PyPI:
349
+
350
+ 1. Go to the Actions tab in your GitHub repository
351
+ 2. Select "Publish Python Package"
352
+ 3. Click "Run workflow"
353
+ 4. Choose "Publish to Test PyPI" option
354
+
355
+ ## Contributing
356
+
357
+ We welcome contributions! Please see our contributing guidelines for details.
358
+
359
+ 1. Fork the repository
360
+ 2. Create a feature branch (`git checkout -b feature/amazing-feature`)
361
+ 3. Make your changes
362
+ 4. Add tests for your changes
363
+ 5. Ensure tests pass (`pytest`)
364
+ 6. Commit your changes (`git commit -m 'Add amazing feature'`)
365
+ 7. Push to the branch (`git push origin feature/amazing-feature`)
366
+ 8. Open a Pull Request
367
+
368
+ ## Troubleshooting
369
+
370
+ ### Common Issues
371
+
372
+ #### No tools or resources registered
373
+
374
+ ```
375
+ WARNING: No tools or resources were registered. This might indicate an issue with the API specification or authentication.
376
+ ```
377
+
378
+ **Solution**: This usually happens when:
379
+ - The SmartAPI ID is invalid or the API is down
380
+ - The OpenAPI specification has validation errors
381
+ - Network connectivity issues
382
+
383
+ Try with a known working API set: `smartapi-mcp --api_set biothings_core`
384
+
385
+ #### Server fails to start
386
+
387
+ **Check your Python version**: Requires Python 3.10+
388
+ ```bash
389
+ python --version
390
+ ```
391
+
392
+ **Verify installation**:
393
+ ```bash
394
+ pip show smartapi-mcp
395
+ ```
396
+
397
+ #### HTTP mode connection issues
398
+
399
+ If using HTTP transport mode and clients can't connect:
400
+ - Check if the port is available: `netstat -an | grep :8000`
401
+ - Try binding to all interfaces: `--host 0.0.0.0`
402
+ - Check firewall settings
403
+
404
+ ### Getting Help
405
+
406
+ 1. Enable debug logging: `--log-level DEBUG`
407
+ 2. Check the [GitHub Issues](https://github.com/biothings/smartapi-mcp/issues)
408
+ 3. Contact us at help@biothings.io
409
+
410
+ ## License
411
+
412
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
413
+
414
+ ## Related Projects
415
+
416
+ - **[SmartAPI Registry](https://smart-api.info/)** - Registry of biomedical and life sciences APIs
417
+ - **[Model Context Protocol (MCP)](https://modelcontextprotocol.io/)** - Standard protocol for AI model-tool integration
418
+ - **[BioThings APIs](https://biothings.io/)** - High-performance bioinformatics APIs
419
+ - **[AWS Labs OpenAPI MCP Server](https://github.com/awslabs/openapi-mcp-server)** - Base MCP server framework
420
+
421
+ ## Citation
422
+
423
+ If you use SmartAPI MCP Server in your research or applications, please cite:
424
+
425
+ ```
426
+ SmartAPI MCP Server: Bridging Bioinformatics APIs with Model Context Protocol
427
+ BioThings Team. (2024). https://github.com/biothings/smartapi-mcp
428
+ ```
429
+
430
+ ## Support
431
+
432
+ For questions and support:
433
+
434
+ - 📖 **Documentation**: [README](https://github.com/biothings/smartapi-mcp#readme)
435
+ - 🐛 **Bug Reports**: [GitHub Issues](https://github.com/biothings/smartapi-mcp/issues)
436
+ - 💬 **Questions**: [GitHub Discussions](https://github.com/biothings/smartapi-mcp/discussions)
437
+ - 📧 **Email**: help@biothings.io
438
+
439
+ ---
440
+
441
+ **SmartAPI MCP Server** is developed and maintained by the [BioThings Team](https://biothings.io) at The Scripps Research Institute.