Metadata-Version: 2.4
Name: optimade-mcp-server
Version: 0.1.2
Summary: A MCP-compatible OPTIMADE server with configurable filters and endpoints.
Author-email: lsb <763568748@qq.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.28.1
Requires-Dist: mcp[cli]>=1.9.4
Requires-Dist: optimade[http-client]>=1.2.4
Requires-Dist: python-dotenv>=1.0.1
Requires-Dist: rich<14.dev0,>=13.0
Dynamic: license-file

# OPTIMADE MCP SERVER
A Model Context Protocol (MCP) tool for querying Optimade-compatible material databases, fully configurable custom filter presets and provider endpoints.
# 🎯 Overview
This tool enables structured data queries across multiple OPTIMADE databases (e.g., Materials Project, Materials Cloud, COD), via MCP protocol. Key capabilities include:

1.Custom or preset OPTIMADE filter queries

2.Configurable list of OPTIMADE providers via config/optimade_config.json

3.Proxy support via .env file

4.Easily deployable via uvx, cline
# ⚙️ Installation & Usage
## ✅ Recommended via uv
1.Install the tool:
~~~~~~
uv pip install optimade-mcp-server
~~~~~~
2.In cline or any MCP-compatible launcher, configure the tool as follows:
~~~~~~
{
  "mcpServers": {
    "optimade": {
      "command": "uv",
      "args": ["--directory", "optimade-mcp-server", "run", "optimade"]
    }
  }
}
~~~~~~
# 🌐 Proxy Support (Optional)
If you need to use a VPN or proxy, create a .env file in the project root:
~~~~~~
HTTP_PROXY=http://127.0.0.1:<your-port>
HTTPS_PROXY=http://127.0.0.1:<your-port>
~~~~~~
If you don't need a proxy, you can comment out or remove the proxy setup in the source code.
# 🪪 License
This project is licensed under the MIT License. See LICENSE for details.
