Fips Agents CLI
CLI for FIPS Agents actions
Ask AI about Fips Agents CLI
Powered by Claude Β· Grounded in docs
I know everything about Fips Agents CLI. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
FIPS Agents CLI
A command-line tool for creating and managing FIPS-compliant AI agent projects. Scaffolds MCP (Model Context Protocol) servers, AI agent projects, and ModelCar containers from production-ready templates.
Features
- π Quick project scaffolding from templates
- π¦ MCP server, AI agent, Go gateway, chat UI, sandbox, and ModelCar project generation
- π§ Automatic project customization (pyproject.toml, module names, entry points)
- β‘ Component generation (tools, resources, prompts, middleware) with Jinja2 templates
- π¨ Beautiful CLI output with Rich
- β Git repository initialization and GitHub integration
- π§ͺ Comprehensive test coverage with auto-run on generated components
- π Template patching to pull upstream improvements into existing projects
Installation
Recommended: Install with pipx for isolated command-line tools:
pipx install fips-agents-cli
pipx installs the CLI in an isolated environment while making it globally available. This prevents dependency conflicts with other Python packages.
Alternative: Using pip
If you prefer pip or don't have pipx installed:
pip install fips-agents-cli
Note: Consider using a virtual environment to avoid dependency conflicts.
Alternative: Install from source (for development)
For contributing or local development:
# Clone the repository
git clone https://github.com/fips-agents/fips-agents-cli.git
cd fips-agents-cli
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in editable mode with dev dependencies
pip install -e .[dev]
Quick Start
Create projects
# MCP server
fips-agents create mcp-server my-mcp-server
# AI agent
fips-agents create agent my-research-agent
# Go HTTP gateway (proxies to an agent backend)
fips-agents create gateway my-gateway
# Chat UI (connects to a gateway or agent)
fips-agents create ui my-chat-ui
# Code execution sandbox (sidecar for agents)
fips-agents create sandbox my-sandbox
# ModelCar (HuggingFace model as container)
fips-agents create model-car ibm-granite/granite-3.1-2b-instruct \
quay.io/user/models:granite-3.1-2b-instruct
Generate components in an existing MCP server project
cd my-mcp-server
fips-agents generate tool search_documents --description "Search through documents"
fips-agents generate resource config_data --description "Application configuration"
fips-agents generate prompt code_review --description "Review code for best practices"
fips-agents generate middleware auth_middleware --description "Authentication middleware"
Check for template updates
cd my-mcp-server
fips-agents patch check
fips-agents patch all --dry-run
Command Reference
Help
fips-agents --version
fips-agents --help
fips-agents add --help
fips-agents create --help
fips-agents generate --help
fips-agents patch --help
fips-agents vendor --help
Create Commands
The create command group scaffolds new projects from templates.
Shared Options (mcp-server, agent, gateway, ui)
All create subcommands (except model-car) accept the same options:
| Option | Description |
|---|---|
--target-dir, -t PATH | Target directory for the project (default: current directory) |
--no-git | Skip git repository initialization |
--github | Create GitHub repository and push code |
--local | Create local project only (skip GitHub) |
--yes, -y | Non-interactive mode (use defaults, skip prompts) |
--private | Make GitHub repository private (default: public) |
--org TEXT | GitHub organization to create repository in |
--description, -d TEXT | GitHub repository description |
--remote-only | Create GitHub repo only, don't clone locally |
When gh CLI is installed and authenticated, the tool prompts interactively about GitHub repo creation. Use --local to suppress this, --github to require it, or --yes for fully non-interactive operation.
create mcp-server
fips-agents create mcp-server <project-name> [OPTIONS]
Creates an MCP server project from the mcp-server-template repository. The template includes FastMCP server bootstrap, component auto-discovery, Jinja2 generator templates, Makefile, Containerfile, and tests.
Arguments:
project-nameβ Name for your MCP server project
Examples:
# Create in current directory
fips-agents create mcp-server my-mcp-server
# Create in specific directory without git
fips-agents create mcp-server my-server -t ~/projects --no-git
# Create with private GitHub repo in an organization
fips-agents create mcp-server my-server --github --private --org my-org
# Non-interactive, local only
fips-agents create mcp-server my-server --yes --local
# Create GitHub repo without cloning locally
fips-agents create mcp-server my-server --remote-only --org my-org
create agent
fips-agents create agent <project-name> [OPTIONS]
Creates an AI agent project from the agent-template monorepo (templates/agent-loop/ subdirectory). The template includes an agent loop skeleton, Helm chart, Makefile, Containerfile, and AGENTS.md.
Arguments:
project-nameβ Name for your agent project
Options: Same as create mcp-server (see shared options table above).
Additional option:
| Option | Description |
|---|---|
--vendored | Copy fipsagents source into the project instead of using PyPI dependency |
Examples:
# Create agent project
fips-agents create agent my-research-agent
# Create with GitHub repo in an organization
fips-agents create agent my-agent --github --org fips-agents
# Non-interactive mode
fips-agents create agent my-agent --yes --local
# Create with vendored fipsagents source
fips-agents create agent my-agent --vendored --local
create gateway
fips-agents create gateway <project-name> [OPTIONS]
Creates a Go HTTP gateway project from the gateway-template repository. The gateway proxies OpenAI-compatible /v1/chat/completions requests to an agent backend, with SSE streaming support, heartbeat keepalives, health/readiness probes, and an A2A agent discovery card.
Arguments:
project-nameβ Name for your gateway project
Options: Same shared options as above.
Examples:
# Create gateway project
fips-agents create gateway my-gateway
# Create with GitHub repo
fips-agents create gateway my-gateway --github --org my-org
create ui
fips-agents create ui <project-name> [OPTIONS]
Creates a chat UI project from the ui-template repository. A Go server with embedded HTML/CSS/JS that provides a browser-based chat interface. Includes a built-in reverse proxy to the backend API, SSE streaming, and markdown rendering.
Arguments:
project-nameβ Name for your UI project
Options: Same shared options as above.
Examples:
# Create UI project
fips-agents create ui my-chat-ui
# Create with GitHub repo
fips-agents create ui my-chat-ui --github --private
create sandbox
fips-agents create sandbox <project-name> [OPTIONS]
Creates a code execution sandbox project from the code-sandbox repository. The sandbox provides a FastAPI-based sidecar for secure code execution inside agent pods, with multiple language profiles (base, data-science).
Arguments:
project-name-- Name for your sandbox project
Options: Same shared options as above.
Examples:
# Create sandbox project
fips-agents create sandbox my-sandbox
# Create with GitHub repo
fips-agents create sandbox my-sandbox --github --private
# Non-interactive mode
fips-agents create sandbox my-sandbox --yes --local
create model-car
fips-agents create model-car <hf-repo> <quay-uri> [OPTIONS]
Creates a ModelCar project for packaging a HuggingFace model as a container image. Generates download scripts, Containerfile, build-and-push scripts, and project metadata.
Arguments:
hf-repoβ HuggingFace repo URL or ID (e.g.,ibm-granite/granite-3.1-2b-instructor the fullhttps://huggingface.co/...URL)quay-uriβ Container registry URI with tag (e.g.,quay.io/user/models:granite-3.1-2b-instruct)
Options:
| Option | Description |
|---|---|
--target-dir, -t PATH | Target directory for the project (default: current directory) |
Examples:
# Using repo ID
fips-agents create model-car ibm-granite/granite-3.1-2b-instruct \
quay.io/wjackson/models:granite-3.1-2b-instruct
# Using full URL with custom target directory
fips-agents create model-car https://huggingface.co/ibm-granite/granite-3.1-2b-instruct \
quay.io/wjackson/models:granite-3.1-2b-instruct -t ~/models
Generate Commands
The generate command group creates individual components (tools, resources, prompts, middleware) in existing projects.
Run these commands from within your MCP server project directory. The CLI locates the project root by looking for pyproject.toml with a fastmcp dependency.
Each generator:
- Validates the component name and checks for conflicts
- Loads Jinja2 templates from
.fips-agents-cli/generators/in your project - Renders both the component file and a corresponding test file
- Validates Python syntax on the generated code
- Runs the generated tests automatically
Component names must be valid Python identifiers in snake_case. Subdirectory paths (e.g., country-profiles/japan) are supported for resources.
generate tool
fips-agents generate tool <name> [OPTIONS]
Generates a tool component with FastMCP @mcp.tool() decorator.
Options:
| Option | Description |
|---|---|
--async/--sync | Generate async or sync function (default: async) |
--with-context | Include FastMCP Context parameter |
--with-auth | Include authentication decorator |
--scopes TEXT | Required OAuth scopes, comma-separated (e.g., "read:data,write:data") |
--with-elicitation | Include elicitation example code |
--description, -d TEXT | Tool description |
--params PATH | JSON file with parameter definitions |
--read-only | Mark as read-only operation (default: true) |
--idempotent | Mark as idempotent (default: true) |
--open-world | Mark as open-world operation |
--return-type TEXT | Return type annotation (default: str) |
--dry-run | Show what would be generated without creating files |
Examples:
# Basic tool
fips-agents generate tool search_documents --description "Search through documents"
# Tool with context and authentication
fips-agents generate tool fetch_user_data --with-context --with-auth --scopes "read:users"
# Tool with parameters from JSON file
fips-agents generate tool advanced_search --params params.json
# Sync tool with custom return type
fips-agents generate tool process_data --sync --return-type "dict[str, Any]"
# Preview without creating files
fips-agents generate tool test_tool --description "Test" --dry-run
generate resource
fips-agents generate resource <name> [OPTIONS]
Generates a resource component with FastMCP @mcp.resource() decorator. Supports subdirectory paths (e.g., country-profiles/japan creates src/resources/country_profiles/japan.py). URI template parameters (e.g., {id}) are automatically extracted as function arguments.
Options:
| Option | Description |
|---|---|
--async/--sync | Generate async or sync function (default: async) |
--with-context | Include FastMCP Context parameter |
--description, -d TEXT | Resource description |
--uri TEXT | Resource URI (default: resource://<name>) |
--mime-type TEXT | MIME type (default: text/plain) |
--dry-run | Show what would be generated without creating files |
Examples:
# Basic resource
fips-agents generate resource config_data --description "Application configuration"
# Resource with URI template (parameters auto-extracted as function args)
fips-agents generate resource user_profile --uri "resource://users/{id}"
# Resource in a subdirectory
fips-agents generate resource country-profiles/japan --description "Japan country profile"
# Resource with specific MIME type
fips-agents generate resource json_config --mime-type "application/json"
generate prompt
fips-agents generate prompt <name> [OPTIONS]
Generates a prompt component with FastMCP @mcp.prompt() decorator. Note: prompts default to sync (unlike tools and resources which default to async).
Options:
| Option | Description |
|---|---|
--async/--sync | Generate async or sync function (default: sync) |
--with-context | Include FastMCP Context parameter |
--description, -d TEXT | Prompt description |
--params PATH | JSON file with parameter definitions |
--return-type [str|Message|list[Message]] | Return type (default: str) |
--with-schema | Include JSON schema example in prompt body |
--prompt-name TEXT | Override decorator name (default: function name) |
--title TEXT | Human-readable title for the prompt |
--tags TEXT | Comma-separated tags for categorization |
--disabled | Generate prompt in disabled state |
--meta TEXT | JSON string of metadata (e.g., '{"version": "1.0"}') |
--dry-run | Show what would be generated without creating files |
Examples:
# Basic prompt
fips-agents generate prompt code_review --description "Review code for best practices"
# Prompt with parameters and schema
fips-agents generate prompt summarize_text --params params.json --with-schema
# Async prompt returning a Message
fips-agents generate prompt fetch_data --async --with-context --return-type Message
# Prompt with metadata and tags
fips-agents generate prompt generate_report \
--prompt-name "report_generator" \
--title "Report Generator" \
--tags "reporting,analysis" \
--meta '{"version": "2.0", "author": "data-team"}'
generate middleware
fips-agents generate middleware <name> [OPTIONS]
Generates a middleware component using FastMCP's @mcp.middleware() decorator (v3.x class-based pattern). Middleware wraps tool execution and receives a Context and next_handler.
Options:
| Option | Description |
|---|---|
--async/--sync | Generate async or sync function (default: async) |
--hook-type [before_tool|after_tool|on_error] | Scaffold a specific hook pattern (default: general wrapper) |
--description, -d TEXT | Middleware description |
--dry-run | Show what would be generated without creating files |
Examples:
# General-purpose wrapper
fips-agents generate middleware auth_middleware --description "Authentication middleware"
# Before-tool hook
fips-agents generate middleware rate_limiter --hook-type before_tool
# Error handler (sync)
fips-agents generate middleware error_reporter --hook-type on_error --sync
Parameters JSON Schema
When using --params with generate tool or generate prompt, provide a JSON file defining parameter names, types, and constraints:
[
{
"name": "query",
"type": "str",
"description": "Search query",
"required": true,
"min_length": 1,
"max_length": 100
},
{
"name": "limit",
"type": "int",
"description": "Maximum results to return",
"required": false,
"default": 10,
"ge": 1,
"le": 100
}
]
Supported Types:
str,int,float,boollist[str],list[int],list[float]Optional[str],Optional[int],Optional[float],Optional[bool]
Pydantic Field Constraints:
min_length,max_length(for strings)ge,le,gt,lt(for numbers)pattern(for regex validation on strings)default(default value when optional)
Patch Commands
The patch command group updates files in existing projects from the upstream template repository without overwriting your custom code. It shows interactive diffs for files that may contain customizations.
Supported project types: MCP server, agent, workflow, gateway, UI. The available category subcommands depend on the project type β patch reads template.type from .template-info and surfaces a clear error if you run a category that doesn't apply (e.g. patch generators inside an agent project).
Templates can declare their own patch categories by shipping a .fips-template.yaml manifest at the repo root (or, for monorepo templates, at the comparison subdir root). The CLI prefers the manifest when present and falls back to a built-in category set otherwise. Gateway and UI projects are patchable only because their templates ship a manifest.
Run these commands from within your project directory.
patch check
fips-agents patch check
Check for available template updates. Shows what files have changed in the template since your project was created, organized by category. Works for any supported project type.
patch all
fips-agents patch all [--dry-run] [--skip-confirmation]
Update every category that applies to the current project type. Prompts for confirmation before starting unless --skip-confirmation is passed.
MCP server categories
| Subcommand | Patches |
|---|---|
patch generators | Jinja2 templates in .fips-agents-cli/generators/ |
patch core | Core infrastructure (src/main.py, src/core/server.py, package inits) |
patch docs | CLAUDE.md, AGENTS.md, ARCHITECTURE.md, TESTING.md, docs/** |
patch build | Makefile, Containerfile, .dockerignore, .gitignore |
patch claude | Claude Code slash commands (.claude/commands/**) |
Agent / workflow categories
| Subcommand | Patches |
|---|---|
patch chart | Helm chart templates (chart/templates/**, chart/Chart.yaml) |
patch docs | CLAUDE.md, AGENTS.md, docs/** |
patch build | Makefile, Containerfile, deploy.sh, redeploy.sh |
patch claude | Claude Code slash commands and rules (.claude/commands/**, .claude/rules/**) |
patch evals | Eval harness (evals/discovery.py, evals/assertions.py, evals/run_evals.py) |
Gateway / UI categories
| Subcommand | Patches |
|---|---|
patch chart | Helm chart templates (chart/templates/**, chart/Chart.yaml) |
patch docs | CLAUDE.md, llms.txt, docs/** |
patch build | Makefile, Containerfile, .containerignore, .gitignore |
User-customized files are never patched: for MCP this means src/tools/, src/resources/, src/prompts/, src/middleware/, pyproject.toml, etc. For agent/workflow it means src/agent.py, agent.yaml, chart/values.yaml, src/fipsagents/** (managed by fips-agents vendor), tools/**, examples/**, prompts/**, rules/**, skills/**, evals/evals.yaml, evals/fixtures/**, and pyproject.toml. For gateway/UI it means cmd/**, internal/**, go.mod, go.sum, chart/values.yaml, static/** (UI only), bin/**, and LICENSE.
All patch subcommands (except check) accept --dry-run to preview changes without modifying files.
Add Commands
The add command group wires optional capabilities into existing agent projects created with fips-agents create agent.
Run these commands from within your agent project directory. The CLI locates the project root by looking for .template-info (or agent.yaml for legacy projects).
add files
fips-agents add files
Enables file upload + attachment support. Flips server.files.enabled in agent.yaml and files.enabled in chart/values.yaml. The agent template already ships the rest of the files surface (storage backends, optional S3 bytes backend, ClamAV virus-scanner sidecar, Docling PDF/text extraction, pgvector chunking) β this command only wires up the toggles.
What it does:
- Sets
server.files.enabled: trueinagent.yaml - Sets
files.enabled: trueinchart/values.yaml - Prints next steps for installing the
[files]extra, choosing a backend (sqlite/postgres), enabling ClamAV, and enabling persistence
Example:
cd my-research-agent
fips-agents add files
pip install -e '.[files]'
export FILES_BACKEND=sqlite
add code-executor
fips-agents add code-executor
Adds the code_executor tool to your agent's tools/ directory and enables the sandbox sidecar in chart/values.yaml. The tool sends Python code to a sandbox container for isolated execution.
What it does:
- Writes
tools/code_executor.pywith the sandbox client tool - Sets
sandbox.enabled: trueinchart/values.yaml(if the section exists) - Prints deployment guidance for sidecar and remote service modes
Deployment modes:
- Sidecar (default): The sandbox runs as a container in the same pod. The tool connects to
http://localhost:8000. - Remote service: The sandbox runs as a separate deployment. Set
SANDBOX_URLto point to it.
Example:
cd my-research-agent
fips-agents add code-executor
add vision
fips-agents add vision
Wires multimodal (image input) example client code into your project. Drops examples/vision_client.py showing the three image_url URL forms the agent runtime accepts: inline data: URIs, remote https:// URLs, and the internal file_id:<id> scheme that the agent rewrites to a data: URI server-side.
Image input flows through the agent's existing model.endpoint β there is no separate vision endpoint split. Set MODEL_ENDPOINT and MODEL_NAME to a vision-capable model (e.g. Granite Vision 3.2-2B, LLaVA, Phi-4-Multimodal) before running the agent.
Prerequisite: fips-agents add files must have been run first. The file_id:<id> URL scheme resolves bytes via the agent's BytesStore, which only exists when files is enabled. The command refuses to apply if server.files.enabled is not true in agent.yaml.
Requires: fipsagents>=0.20.0 in the project's dependencies (content-block support landed in 0.20.0).
What it does:
- Verifies
server.files.enabled: trueinagent.yaml(precondition) - Writes
examples/vision_client.pywith runnable snippets for all three URL forms
Example:
cd my-research-agent
fips-agents add files # prerequisite
fips-agents add vision
export MODEL_ENDPOINT=https://granite-vision-3-2-2b-...:443/v1
export MODEL_NAME=ibm-granite/granite-vision-3.2-2b
make run-local
python examples/vision_client.py path/to/image.png
Vendor Commands
The vendor command copies the fipsagents source into your agent project, replacing the PyPI dependency. This gives you full control over the fipsagents code.
vendor
fips-agents vendor [OPTIONS]
Copies fipsagents source into src/fipsagents/ and rewrites pyproject.toml to use individual dependencies instead of the fipsagents package.
Options:
| Option | Description |
|---|---|
--update | Update an already-vendored project with the latest upstream source |
--version TEXT | Vendor a specific version tag (e.g., fipsagents-v0.7.0). Default: latest main |
Examples:
# Vendor into current project
fips-agents vendor
# Vendor a specific version
fips-agents vendor --version fipsagents-v0.7.0
# Update vendored source from upstream
fips-agents vendor --update
When to use vendored vs. PyPI:
- PyPI dependency (default): Best for teams running multiple agents that share the same fipsagents version. Centralized updates.
- Vendored source: Best for agents that need custom BaseAgent modifications, environments with no PyPI access, or when you want to read and debug the fipsagents source locally.
Project Name Requirements
Project names must follow these rules:
- Start with a lowercase letter
- Contain only lowercase letters, numbers, hyphens (
-), and underscores (_) - Not be empty
Valid examples: my-server, test_mcp, server123, my-awesome-mcp-server
Invalid examples: MyServer (uppercase), 123server (starts with number), my@server (special characters)
After Creating a Project
MCP Server
cd my-mcp-server
python -m venv venv
source venv/bin/activate
pip install -e .[dev]
pytest
# Start developing in src/my_mcp_server/
AI Agent
cd my-research-agent
make install # Create venv, install dependencies
make run-local # Start HTTP server on port 8080
make test # Run tests
# See AGENTS.md for the /plan-agent slash command workflow
Gateway
cd my-gateway
make build # Build the Go binary
make run # Run locally (set BACKEND_URL to your agent)
make build-openshift PROJECT=my-gateway # Build on OpenShift
make deploy PROJECT=my-gateway # Deploy via Helm
Chat UI
cd my-chat-ui
make build # Build the Go binary
make run # Run locally (set API_URL to your gateway/agent)
make build-openshift PROJECT=my-chat-ui # Build on OpenShift
make deploy PROJECT=my-chat-ui # Deploy via Helm
Sandbox
cd my-sandbox
make install # Install dependencies
make test # Run tests
make build # Build container
make build PROFILE=data-science # Build with profile
ModelCar
cd granite-3.1-2b-instruct
./download.sh # Download model weights
./build-and-push.sh # Build container and push to registry
Development
Setup Development Environment
# Clone the repository
git clone https://github.com/fips-agents/fips-agents-cli.git
cd fips-agents-cli
# Create virtual environment
python -m venv venv
source venv/bin/activate
# Install with dev dependencies
pip install -e .[dev]
Running Tests
# Run all tests
pytest
# Run with coverage
pytest --cov=fips_agents_cli --cov-report=html
# Run specific test file
pytest tests/test_create.py
# Run specific test
pytest tests/test_create.py::TestCreateMcpServer::test_successful_creation
Code Quality
# Format code with Black
black src tests
# Lint with Ruff
ruff check src tests
# Type checking (if using mypy)
mypy src
Project Structure
fips-agents-cli/
βββ pyproject.toml # Project configuration
βββ README.md # This file
βββ CLAUDE.md # Claude Code developer instructions
βββ RELEASE_CHECKLIST.md # Release procedures
βββ docs/ # User-facing documentation
βββ planning/ # Design and implementation plans
βββ research/ # Technology evaluations
βββ retrospectives/ # Post-effort retrospectives
βββ scripts/ # Automation scripts
βββ src/
β βββ fips_agents_cli/
β βββ __init__.py
β βββ __main__.py # Entry point for python -m
β βββ cli.py # Main CLI application
β βββ version.py # Version information
β βββ commands/ # CLI command implementations
β β βββ add.py # add files / code-executor (wire capabilities)
β β βββ create.py # create mcp-server, agent, gateway, ui
β β βββ generate.py # generate tool/resource/prompt/middleware
β β βββ model_car.py # create model-car
β β βββ patch.py # patch command
β β βββ vendor.py # vendor fipsagents source
β βββ tools/ # Utility modules
β βββ filesystem.py
β βββ git.py
β βββ github.py
β βββ project.py
β βββ validation.py
βββ tests/
βββ conftest.py # Pytest fixtures
βββ test_create.py # Create command tests
βββ test_project.py # Project utilities tests
βββ ...
Documentation
- docs/ β User-facing reference: publishing guides, release procedures
- planning/ β Design documents and implementation plans for upcoming features
- research/ β Technology evaluations and architectural analysis
- retrospectives/ β Post-effort retrospectives
See docs/README.md for a full index.
Requirements
- Python 3.10 or higher
- Git (for cloning templates and initializing repositories)
Dependencies
- click (>=8.1.0): Command-line interface creation
- rich (>=13.0.0): Terminal output formatting
- gitpython (>=3.1.0): Git operations
- tomlkit (>=0.12.0): TOML file manipulation
- jinja2 (>=3.1.2): Template rendering for component generation
Contributing
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests (
pytest) - Format code (
black src tests) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Troubleshooting
Git not found
If you see "Git is not installed" error:
- macOS:
brew install git - Linux:
sudo apt-get install gitorsudo yum install git - Windows: Download from https://git-scm.com/downloads
Directory already exists
If you see "Directory already exists" error:
- Choose a different project name
- Remove the existing directory:
rm -rf project-name - Use a different target directory with
--target-dir
Template clone fails
If template cloning fails:
- Check your internet connection
- Verify the template repository is accessible: https://github.com/fips-agents/mcp-server-template
- Try again later if GitHub is experiencing issues
Agent template clone fails
If cloning the agent template fails:
- The agent template is in a monorepo at https://github.com/fips-agents/agent-template
- Verify the repository is accessible and the
templates/agent-loop/subdirectory exists - Check that you have access to the organization's repositories
ModelCar validation errors
- Invalid HuggingFace repo: Use either a full URL (
https://huggingface.co/org/model) or a short ID (org/model) - Invalid Quay URI: Must include a tag (e.g.,
quay.io/user/repo:tag), not justquay.io/user/repo - Registry login: The CLI checks for
podman loginstatus; runpodman login quay.ioif prompted
"Not in an MCP server project directory"
When using generate or patch commands:
- Ensure you're running the command from within an MCP server project
- Check that
pyproject.tomlexists withfastmcpdependency - If the project wasn't created with
fips-agents create mcp-server, generator templates may be missing
"Component already exists"
If you see this error:
- Choose a different component name
- Manually remove the existing component file from
src/<component-type>/ - Check the component type directory for existing files
Invalid component name
Component names must:
- Be valid Python identifiers (snake_case)
- Not be Python keywords (
for,class, etc.) - Start with a letter or underscore
- Contain only letters, numbers, and underscores
License
MIT License - see LICENSE file for details
Links
- Repository: https://github.com/fips-agents/fips-agents-cli
- Issues: https://github.com/fips-agents/fips-agents-cli/issues
- MCP Protocol: https://modelcontextprotocol.io/
Changelog
Version 0.12.1
- Fix:
fips-agents patch check,patch <category>, andpatch allnow produce a single-line β error instead of a Python traceback when run against a project whose template type is not in the built-in category set AND ships no.fips-template.yamlmanifest. Today this hits sandbox projects (whose template repo has not yet shipped a manifest); the message names the project type, points at the manifest filename, and links to issue #45 for the schema (#50, #51) - Tests: 9 new tests in
tests/test_patch.pyβ 4 unit cases on the newPatchUnsupportedForProjectTypeexception, 4 integration cases exercising the three CLI entry points against a fake sandbox project, and a future-proofing test confirming that once a sandbox manifest exists,patch checkworks without further CLI changes
Version 0.12.0
- Feature:
fips-agents patchnow reads.fips-template.yamlfrom cloned templates and uses it as the source of truth for patch categories and never-patch lists, falling back to the hardcoded constants when the file is absent or malformed (#45, #48). Each template repo can declare what is template-managed vs user-authored without a CLI release. Companion manifests landed inagent-template,mcp-server-template,gateway-template, andui-templateβ gateway/ui projects, which previously raisedValueErrorfrompatch check, now opt in to patching via their manifest - Feature: New
evalscategory for agent / workflow projects covers the eval harness (evals/discovery.py,evals/assertions.py,evals/mock_factory.py,evals/run_evals.py,evals/__init__.py,evals/README.md) (#44, #46). User-authoredevals/evals.yamlandevals/fixtures/stay inAGENT_NEVER_PATCH - Feature: New
claudecategory for MCP server projects covers.claude/commands/**/*(#42, #43). Agentclaudecategory extended to also include.claude/rules/**/* - Fix: The MCP
corepatterns had a literal-space typo (src/*/__ init__.py) that matched nothing β package__init__.pyfiles were silently unreachable viapatch core. Pattern fixed andsrc/main.py(the entry point) added to the category (#42, #43) - Fix:
_should_never_patchswitched fromPath.matchtofnmatch.fnmatchcaseso a bare"README.md"entry no longer locks out nested READMEs likeevals/README.md(#47, #49). Other patterns behave identically; over-matching**patterns is strictly safer for never-patch - Fix: Several pre-existing pattern gaps filled β MCP
docsnow listsAGENTS.md,CONTRIBUTING.md,DEVELOPMENT_PROCESS.md,OPENSHIFT_DEPLOYMENT.md; MCPbuildnow lists.dockerignore,.gitignore,.gitleaks.toml;AGENT_NEVER_PATCHextended withtools/**,examples/**,prompts/**,rules/**,skills/**,.memoryhub.yaml(#42, #43) - Tests: 48 new tests in
tests/test_patch.pycovering the manifest loader, schema validation, fallback paths, the new categories, the matcher fix, and an integration test that exercisespatch checkend-to-end against a fake template that ships its own manifest
Version 0.11.1
- Fix:
fips-agents createno longer hangs on theCreate GitHub repository?prompt in non-interactive shells (CI, agent-driven, piped input). All sixcreatesubcommands share a single_determine_github_modehelper, sogateway,ui,mcp-server,agent,workflow, andsandboxare fixed together. Non-TTY stdin now falls through to local mode with a one-line hint pointing to--github/--yes; the prompt is also wrapped intry/except click.exceptions.Abortas defense in depth (#40, #41) - Fix: Six
Unexpected error: {e}sites now use{e!r}so a swallowed empty-message exception (the original symptom of #40, whereclick.Abortrendered as a blank message) surfaces its type instead of going silent - Tests: 8 new cases in
TestDetermineGithubModecovering flag short-circuits, gh-missing/unauthenticated,--yes, and the new TTY / non-TTY / aborted-confirm paths
Version 0.11.0
- Feature: New
fips-agents add visioncommand wires multimodal (image input) example client code into existing agent projects (#20, #39). Dropsexamples/vision_client.pyshowing the threeimage_urlURL forms the agent runtime accepts: inlinedata:URIs, remotehttps://URLs, and the internalfile_id:<id>scheme that the agent rewrites to adata:URI server-side via the configuredBytesStore. Image input flows through the agent's existingmodel.endpointβ no separate vision endpoint split. SetMODEL_ENDPOINTandMODEL_NAMEto a vision-capable model (Granite Vision 3.2-2B, LLaVA, Phi-4-Multimodal) before running the agent - Behavior:
add visionenforces a precondition βserver.files.enabledmust betrueinagent.yaml. Thefile_id:<id>URL scheme resolves bytes via theBytesStore, which only exists when files is enabled. The command refuses to apply with an actionable hint pointing the user tofips-agents add filesfirst - Compat: Pairs with
fipsagents>=0.20.0(content-block support landed runtime-side in agent-template #151 / fipsagents 0.20.0) - Tests: 4 new tests in
tests/test_modality.pycovering vision spec shape, end-to-end first-run + idempotency, the files-not-enabled precondition failure, and the not-in-agent-project error path
Version 0.10.0
- Feature: New
tools/modality.pyhelper exposingModalitySpec+apply_modality()β declarative API for composableaddsubcommands that toggle agent.yaml / chart/values.yaml fields, drop in source files, and register pyproject.toml extras. Uses ruamel.yaml round-trip to preserve comments and${VAR:-default}substitutions; tomlkit for TOML edits. Idempotent, with apreconditionhook for cross-modality dependency checks (#37) - Feature: New
fips-agents add filescommand enables file upload + attachment support in existing agent projects. Flipsserver.files.enabled(agent.yaml) andfiles.enabled(chart/values.yaml); the agent template already ships the rest of the surface β storage backends, optional S3 bytes backend, ClamAV virus-scanner sidecar, Docling text extraction, pgvector chunking β so the command only owns the toggles (#19, #38) - Improvement:
add code-executorrefactored onto the newModalitySpechelper. Brittle string-replace onenabled: falseis replaced with structured ruamel.yaml round-trip; behavior preserved - Improvement:
_find_agent_project_root()promoted fromcommands/add.pytotools/project.pyas publicfind_agent_project_root(). Now recognizes both.template-info(template.type=="agent") and legacyagent.yamlpresence - Chore: Pin dev tools to
black>=26,<27andruff>=0.11,<0.12so local environments cannot silently drift past CI's formatter/linter major versions (#36) - Chore: New runtime dependency
ruamel.yaml>=0.18,<0.19(used by the modality helper for comment-preserving YAML edits) - Chore: Descope governance issues #23 (cost tracking), #24 (HITL approval), #25 (compliance audit logging) β OGX (the new name for LlamaStack) handles these well; fips-agents-cli will not duplicate that surface
- Tests: 29 new tests in
tests/test_modality.pycovering yaml toggles (top-level + nested), idempotency, missing-section warnings, source-file drops, pyproject extra add/merge, preconditions, and end-to-end runs ofadd code-executorandadd files. New committedtests/fixtures/agent_project/provides an offline structural snapshot of the agent-template layout (precedent:tests/fixtures/middleware_template/)
Version 0.9.1
- Chore: Realign
tests/formatting with black 26.3.1 to match CI (v0.9.0's release pipeline failed because local black 24.x produced different output than CI's 26.x; no functional change)
Version 0.9.0
- Feature:
fips-agents patchnow supports agent and workflow projects in addition to MCP servers (#12) - Feature: New
patch chartandpatch claudesubcommands for agent/workflow projects (#15) - Feature:
.template-infonow recordstemplate.typeand (for monorepo templates)template.subdirso post-scaffolding commands can route by project type (#13) - Feature: New
find_fips_project_root()walks up to.template-info, replacing the MCP-only fastmcp-dependency probe in patch commands (#14) - Improvement:
_clone_template_for_patch()resolves the monorepo subdir during patching, so glob/compare runs againsttemplates/agent-loop/instead of the monorepo root (#16) - Improvement: Running an MCP-only subcommand inside an agent project (or vice versa) now exits with a clear "available categories" error
- Improvement:
patch allenumerates the project's actual category set instead of assuming MCP layout - Backwards compat: Projects scaffolded before
template.typeexisted default tomcp-server; no migration required - Tests: 20 new tests in
tests/test_patch.pycovering the type-aware patch flow end-to-end against a fake-scaffolded agent project
Version 0.8.2
- Test: New
TestGenerateMiddlewareRealTemplateintegration test renders the real v3.x middleware Jinja2 template against each--hook-typeand the no-flag case, with templates committed undertests/fixtures/middleware_template/so the suite runs offline (#3) - Chore:
scripts/release.shnow constructs the release commit message from the version argument using the project convention (chore: Release fips-agents-cli vX.Y.Zwith optionalβ <summary>); convention documented in CLAUDE.md (#4) - Docs: Drop broken
See Alsolinks from.fips-agents-cli/README.mdin scaffolded MCP projects (#5, fixed infips-agents/mcp-server-template) - Docs: Updated CLAUDE.md release section to reflect the new release-script signature
Version 0.8.1
- Docs: Updated CLAUDE.md current-status line and added release-process notes
- Chore: Repository hardening β added CODEOWNERS and enabled main branch protection
- Chore: Black formatting drift cleanup; removed remaining "framework" language from docs in favor of "toolkit"
- Chore:
.venv/andNEXT_SESSION.mdgitignored
Version 0.8.0
- Feature: New
--vendoredflag oncreate agentcopies fipsagents source instead of PyPI dependency - Feature: New
fips-agents vendorcommand for post-scaffold vendoring of existing projects - Feature:
fips-agents vendor --updaterefreshes vendored source from upstream - Feature:
fips-agents vendor --versionpins to a specific fipsagents release tag - Fix:
customize_agent_projectnow removes monorepo Makefile install line (matching workflow template behavior) - Fix: Added
redeploy.shto agent project customization file list
Version 0.7.0
- Feature: New
addcommand group for composable agent capabilities - Feature:
fips-agents add code-executorwires sandbox code execution into existing agent projects (tool + Helm chart sidecar config) - Improvement: Updated
generategroup description to reflect broader scope beyond MCP
Version 0.6.2
- Fix: Go project scaffolding now updates import paths in all
.gosource files - Fix: Go project scaffolding now updates Helm template references (
chart/templates/*.yaml)
Version 0.6.1
- Chore: Updated all project URLs from
rdwj/tofips-agents/org - Chore: Post-transfer PyPI publishing verification release
Version 0.6.0
- Feature: Added
create sandboxcommand for scaffolding code execution sandbox projects from fips-agents/code-sandbox template - Feature: All template URLs consolidated under
github.com/fips-agents/organization
Version 0.5.1
- Fix: SSE streaming tool call ID tracking by
call_idnot array index
Version 0.5.0
- Feature: Added
create gatewaycommand for scaffolding Go HTTP gateway projects from the gateway-template - Feature: Added
create uicommand for scaffolding chat UI projects from the ui-template - Feature: Go project customization pipeline (
customize_go_project) handles go.mod, Helm charts, Containerfile, Makefile, and static HTML - Fix: Agent scaffolding now replaces
agent-templatein all Helm chart templates, preventing resource name collisions - Fix: Agent scaffolding now replaces
OWNER/REPOplaceholder in Containerfile with actual GitHub repo
Version 0.4.0
- Feature: Added
create agentcommand for scaffolding AI agent projects from the agent-loop template - Feature: New
clone_template_subdir()utility for extracting templates from monorepos - Feature: Agent project customization across pyproject.toml, Helm chart, Makefile, Containerfile, and AGENTS.md
- Improvement: Reorganized documentation into docs/, planning/, and research/ directories
Version 0.3.0
- Feature: Added
--hook-typeoption to middleware generator withbefore_tool,after_tool, andon_errorchoices for v3.x template scaffolding - Fix: Fixed brittle test mocking for GitHub CLI detection in create command tests
Version 0.2.1
- Fix: Update CLI for FastMCP 3.x template compatibility (auth.py replaces loaders.py, updated prompt return types)
- Fix: Reorder
create mcp-serverprecondition checks to run before interactive GitHub prompt, so errors like missing git or existing directories fail fast without prompting first
Version 0.2.0
- Feature: GitHub integration for
create mcp-servercommand - Feature: New
--githubflag to create GitHub repository and push code - Feature: New
--localflag to skip GitHub and create local-only project - Feature: Non-interactive mode (
--yes) for agent/CI workflows - Feature: New
--privateflag to create private GitHub repositories - Feature: New
--orgoption to create repositories in GitHub organizations - Feature: New
--descriptionoption for GitHub repository descriptions - Feature: New
--remote-onlyflag to create GitHub repo without local clone - Feature: Added missing
patch buildsubcommand for updating build/deployment files - Feature: GitHub metadata tracking in
.template-infofile - Feature: New git utilities for remote management (
add_remote,push_to_remote) - Improvement: Auto-detects
ghCLI and prompts user when available - Improvement: Clean git history - customizes project before initial push
Version 0.1.9
- Feature: Added
.fips-agents-clidirectory to ModelCar projects with generation metadata - Feature: ModelCar projects now include
info.jsonwith source, destination, and generator info - Feature: ModelCar projects now include
CLAUDE.mdwith project-specific Claude Code instructions - Improvement: Consistent project metadata structure between MCP server and ModelCar projects
Version 0.1.8
- Feature: Added GitHub Copilot agent template support
- Feature: Added
model-carcommand for creating model car projects - Fix: Subdirectory names now convert hyphens to underscores for valid Python package names
- Fix: Added
module_pathtemplate variable for proper import paths in subdirectory components - Fix: Script generator improvements
- Improvement: Removed download filter for cleaner template handling
- Improvement: Added info file tracking for generated projects
Version 0.1.7
- Critical Fix: Resource generator now automatically extracts URI template parameters (e.g.,
{country_code},{id}) and adds them to function signature - Critical Fix: Generated resources now comply with FastMCP requirement that URI parameters must match function arguments
- Fix: Updated test templates to use
.fnattribute pattern for testing FastMCP decorated functions - Fix: Improved
component_exists()to properly handle subdirectory paths - Fix: Removed obsolete
_preview_prompt_utility.pyfrom template (YAML-based prompts removed) - Improvement: Generated resource tests now pass out of the box
- Improvement: Resource function signatures now include proper type hints and docstring Args sections
Version 0.1.6
- Feature: Added
fips-agents patchcommand for selective template updates without losing custom code - Feature: Resource subdirectory support - organize resources in hierarchies (e.g.,
country-profiles/japan) - Feature:
generate resourcenow supports subdirectory paths for better organization - Improvement: Recursive resource loading from subdirectories with automatic discovery
- Improvement: Patch command shows interactive diffs for files that may be customized
- Improvement: Template version tracking enables smart updates via
.template-infofile - Enhancement: Cleaned up redundant auto-discovery code from template
__init__.pyfiles
Version 0.1.5
- Feature: Added
.template-infofile to track CLI version and template commit hash in generated projects - Improvement: Implemented auto-discovery for tools/resources/prompts/middleware components, eliminating manual registration in
__init__.pyfiles - Improvement: Template components can now be added or removed by simply creating/deleting filesβno registry updates required
Version 0.1.4
- Fix: Fixed Containerfile in template to remove incorrect prompts/ copy line
- Fix: Fixed CLI to correctly update entry point script names for new projects
- Fix: Updated CLI to handle new multi-module template structure (core/, tools/, etc.)
- Fix: Updated fallback project name to match current template (fastmcp-unified-template)
- Improvement: Improved messaging when template uses multi-module structure
Version 0.1.3
- Improvement: Enhanced prompt creation to comply with FastMCP 2.9+ requirements
Version 0.1.2
- Documentation: Updated documentation and improved release management guidance
- Automation: Added
/create-releaseslash command for automated release workflow - Automation: Created
scripts/release.shfor streamlined version management and tagging - Documentation: Added
RELEASE_CHECKLIST.mdwith comprehensive release procedures
Version 0.1.1
- Added
fips-agents generatecommand group - Component generation: tools, resources, prompts, middleware
- Jinja2-based template rendering
- Parameter validation and JSON schema support
- Auto-run pytest on generated components
- Dry-run mode for previewing changes
- Comprehensive error handling and validation
Version 0.1.0 (MVP)
- Initial release
fips-agents create mcp-servercommand- Template cloning and customization
- Git repository initialization
- Comprehensive test suite
- Beautiful CLI output with Rich
