minimcp: Cursor rule for Cursor

General guidelines

Always use Markdown for documentation and README files.

Git

Commits should be of the following format:

<type>(<optional scope>): <description>

[optional body]

• Keep commits small and focused.
• Do not add "Made-with: Cursor".
• Commit messages should explain why its being done, not what its doing.

The type is one of the following:

• feat: A new feature
• fix: A bug fix
• chore: A chore (not user-facing)
• docs: Documentation changes
• refactor: A code refactor
• test: A test change
• perf: A performance improvement
• style: A style change
• build: A build change
• ci: A CI change

Python Code Style & Formatting

• Follow PEP 8 style guidelines.
• Use type hints for all function signatures and class attributes.
• Maximum line length is 120 characters (configured in pyproject.toml via ruff).
• Use ruff for both linting and formatting. Do not use Black or flake8.
• Use pyright for type checking. Do not use mypy.
• Prefer explicit imports over wildcard imports (from x import *).
• The project supports Python 3.10+. Do not use syntax or stdlib features that require 3.11 or later without a compatibility shim.

Async

• Use anyio for all async primitives: anyio.sleep(), anyio.create_task_group(), anyio.Event(), anyio.CapacityLimiter(), etc.
• Never use asyncio.sleep(), asyncio.create_task(), asyncio.gather(), or other asyncio-specific APIs directly.

MiniMCP API conventions

• Register tools, prompts, and resources using the decorator interface: @mcp.tool(), @mcp.prompt(), @mcp.resource().
• All tool/prompt/resource handler functions must have Pydantic-serializable argument and return types (they are validated by MCPFunc).
• To access the active request context inside a handler, use mcp.context.get(). Never pass context as a function argument.
• To send progress notifications from a handler, use mcp.context.get_responder().report_progress(...).
• Use the ScopeT generic parameter when writing transport or MiniMCP subclasses that need custom per-request scope.
• Custom exceptions should subclass MiniMCPError (user-facing) or InternalMCPError (internal-only).