32 lines
880 B
Markdown
32 lines
880 B
Markdown
# AGENTS.md
|
|
|
|
Repository guidance for contributors and coding agents.
|
|
|
|
## Purpose
|
|
|
|
This repository ships `pyro-mcp`, a minimal MCP-compatible Python package with a static tool for demonstration and testing.
|
|
|
|
## Development Workflow
|
|
|
|
- Use `uv` for all Python environment and command execution.
|
|
- Run `make setup` after cloning.
|
|
- Run `make check` before opening a PR.
|
|
- Use `make demo` to verify the static tool behavior manually.
|
|
- Use `make ollama-demo` to validate model-triggered tool usage with Ollama.
|
|
|
|
## Quality Gates
|
|
|
|
- Linting: `ruff`
|
|
- Type checking: `mypy` (strict mode)
|
|
- Tests: `pytest` with coverage threshold
|
|
|
|
These checks run in pre-commit hooks and should all pass locally.
|
|
|
|
## Key API Contract
|
|
|
|
- Public factory: `pyro_mcp.create_server()`
|
|
- Tool name: `hello_static`
|
|
- Tool output:
|
|
- `message`: `hello from pyro_mcp`
|
|
- `status`: `ok`
|
|
- `version`: `0.0.1`
|