使用说明
项目标题
使用Habitica API的项目简介。
设置
-
初始化并添加依赖项
uv:uv init habitica-mcp-server cd habitica-mcp-server uv add "mcp[cli]" httpx aiohttp python-dotenv -
API配置:
您需要获得您的Habitica用户ID和API密钥。您可以在API下的Habitica帐户设置中找到这些。
创建文件(例如。,
.env或config.py)安全地存储您的凭据。不要将凭据直接提交到代码中。# Example config.py HABITICA_API_KEY = "YOUR_API_KEY" HABITICA_USER_ID = "YOUR_USER_ID" HABITICA_API_URL = "https://habitica.com/api/v3"
用法
下面是一个如何使用 HabiticaClient:
from mcp.server.fastmcp import FastMCP
from habitica_client import HabiticaClient
import os
from dotenv import load_dotenv
# Load environment variables from .env file
load_dotenv()
# Create an MCP server
mcp = FastMCP("Habitica Integration")
# Initialize Habitica client
habitica_client = HabiticaClient(
api_key=os.getenv("HABITICA_API_KEY"),
user_id=os.getenv("HABITICA_USER_ID"),
api_url=os.getenv("HABITICA_API_URL")
@mcp.tool()
async def get_user_tasks(task_type: str = "") -> list:
"""Get all tasks for the authenticated user
Args:
task_type: Optional filter for task type (habits, dailys, todos, rewards, completedTodos)
"""
return await habitica_client.get_user_tasks(task_type)
if __name__ == "__main__":
mcp.run()
使用以下工具进行本地测试 mcp,运行:
mcp dev main.py
替换 "YOUR_API_KEY" 和 "YOUR_USER_ID" 使用您的实际Habitica API证书。
