Materials Project MCP

🚀 Materials Project MCP

Materials Project MCP 是一款基于 fastmcp 的工具，用于针对 Materials Project 数据库中的数据编写提示信息。

🚀 快速开始

本工具提供了便捷的安装和使用方式，你可以按照以下步骤快速上手。

📦 安装指南

你可以从源代码安装该软件包：

pip install -e .

或者使用 uv 进行安装：

uv pip install -e .

💻 使用示例

基础用法

你可以使用命令行界面（CLI）：

mp-mcp

或者在你的 Python 代码中导入使用：

from materials_project_mcp.main import create_mcp

mcp = create_mcp()
mcp.run()

高级用法

以下是一个简单的示例，展示了如何直接使用 MCP 工具：

import os
import json
from materials_project_mcp.tools import (
    get_materials_with_elements,
    get_material_details,
    find_materials_by_formula
)

# Set your API key
os.environ["MP_API_KEY"] = "your_api_key_here"
# Or load it from a file
# with open("~/materials_project_api.key", "r") as f:
#     os.environ["MP_API_KEY"] = f.read().strip()

# Function to print JSON data in a readable format
def print_json(data):
    print(json.dumps(data, indent=2))

# Find materials containing Fe and O
print("\n=== Finding materials containing Fe and O ===")
materials = get_materials_with_elements(
    elements=["Fe", "O"],
    max_records=3
)
print_json(materials)

# Get details for a specific material
if materials:
    material_id = materials[0]["material_id"]
    print(f"\n=== Getting details for material {material_id} ===")
    details = get_material_details(material_id)
    print_json(details)

# Find materials with a specific formula
print("\n=== Finding materials with formula Fe2O3 ===")
formula_materials = find_materials_by_formula(
    formula="Fe2O3",
    max_records=3
)
print_json(formula_materials)

📚 详细文档

API 密钥设置

Materials Project API 需要一个 API 密钥。你可以通过以下几种方式设置你的 API 密钥：

1. 直接将其传递给 MPRester：

from mp_api.client import MPRester
with MPRester("your_api_key_here") as mpr:
    # do stuff with mpr

2. 将其设置为环境变量：

export MP_API_KEY="your_api_key_here"

🔧 技术细节

本地开发设置

# 克隆仓库
git clone https://github.com/justaddcoffee/materials-project-mcp.git
cd materials-project-mcp

# 安装开发依赖
uv pip install -e ".[dev]"

运行测试

pytest