# IBM i MCP Server

> Production-grade TypeScript MCP server for IBM i database operations with advanced SQL tools, authentication, and observability features.

## Docs

- [Agent Development Overview](https://ibm-d95bab6e.mintlify.app/agents/overview.md): Build specialized AI agents for IBM i systems using the MCP server and custom toolsets.
- [Agent Integration](https://ibm-d95bab6e.mintlify.app/cli/agent-integration.md): Use the IBM i CLI in AI agent workflows, shell scripts, and CI/CD pipelines with structured output and semantic exit codes.
- [Command Reference](https://ibm-d95bab6e.mintlify.app/cli/commands.md): Complete reference for all IBM i CLI commands, options, and usage examples.
- [Configuration](https://ibm-d95bab6e.mintlify.app/cli/configuration.md): Configure multi-system connections, output defaults, and credential management for the IBM i CLI.
- [Getting Started](https://ibm-d95bab6e.mintlify.app/cli/getting-started.md): Set up the IBM i CLI, configure your first system connection, and run your first query in under 5 minutes.
- [Output Formats](https://ibm-d95bab6e.mintlify.app/cli/output-formats.md): Table, JSON, CSV, markdown, and NDJSON output formats for the IBM i CLI.
- [IBM i CLI](https://ibm-d95bab6e.mintlify.app/cli/overview.md): A lightweight command-line interface for querying, exploring, and managing IBM i systems directly from your terminal.
- [YAML Tool Execution](https://ibm-d95bab6e.mintlify.app/cli/yaml-tools.md): Run YAML-defined SQL tools from the command line with automatic parameter mapping.
- [IBM Bob](https://ibm-d95bab6e.mintlify.app/clients/bob.md): Configure IBM i MCP Server with IBM Bob, IBM's AI-powered development assistant
- [Claude Code](https://ibm-d95bab6e.mintlify.app/clients/claude-code.md): Configure IBM i MCP Server with Claude Code CLI tool
- [Claude Desktop](https://ibm-d95bab6e.mintlify.app/clients/claude-desktop.md): Configure IBM i MCP Server with Claude Desktop app for macOS and Windows
- [Cline](https://ibm-d95bab6e.mintlify.app/clients/cline.md): Configure IBM i MCP Server with Cline VSCode extension
- [Cursor](https://ibm-d95bab6e.mintlify.app/clients/cursor.md): Configure IBM i MCP Server with Cursor AI-first code editor
- [Gemini CLI](https://ibm-d95bab6e.mintlify.app/clients/gemini-cli.md): Configure IBM i MCP Server with Google's Gemini CLI
- [Client Integration Overview](https://ibm-d95bab6e.mintlify.app/clients/overview.md): Connect the IBM i MCP Server to Claude Desktop, VSCode, Cursor, and 10+ other MCP-compatible clients
- [VSCode (Copilot Chat)](https://ibm-d95bab6e.mintlify.app/clients/vscode.md): Configure IBM i MCP Server with VSCode through GitHub Copilot Chat
- [Server Architecture](https://ibm-d95bab6e.mintlify.app/concepts/architecture.md): Understand how the IBM i MCP Server transforms SQL queries into AI-accessible tools and integrates with IBM i systems.
- [Understanding MCP](https://ibm-d95bab6e.mintlify.app/concepts/mcp-overview.md): A practical introduction to the Model Context Protocol (MCP) for IBM i professionals—what it is, why it matters, and how it works.
- [Configuration Reference](https://ibm-d95bab6e.mintlify.app/configuration.md): Complete guide to configuring the IBM i MCP Server with environment variables, authentication modes, and deployment options.
- [Docker & Podman](https://ibm-d95bab6e.mintlify.app/deployment/docker.md): Run the IBM i MCP Server using pre-built container images with Docker or Podman.
- [OpenShift](https://ibm-d95bab6e.mintlify.app/deployment/openshift.md): Deploy the IBM i MCP Server to Red Hat OpenShift using Kustomize and source-to-image builds.
- [Deployment Overview](https://ibm-d95bab6e.mintlify.app/deployment/overview.md): Deploy the IBM i MCP Server using container images, Docker Compose, or OpenShift with Kustomize.
- [IBM i MCP Server](https://ibm-d95bab6e.mintlify.app/index.md): Connect AI agents to IBM i systems through secure, YAML-configured SQL tools with enterprise authentication and observability.
- [Quick Start Guide](https://ibm-d95bab6e.mintlify.app/quickstart.md): Get your IBM i MCP Server running in under 15 minutes with step-by-step setup instructions.
- [IBM i Authentication](https://ibm-d95bab6e.mintlify.app/server-config/ibmi-auth.md): Complete guide to IBM i HTTP authentication with token-based access, RSA encryption, and per-user connection pooling.
- [Setup Mapepire](https://ibm-d95bab6e.mintlify.app/setup-mapepire.md): Complete guide to installing and configuring Mapepire server on IBM i for MCP database connectivity
- [Built-in Tools](https://ibm-d95bab6e.mintlify.app/sql-tools/built-in-tools.md): Reference for the built-in TypeScript tools that ship with the IBM i MCP Server — schema discovery, query validation, SQL execution, and DDL generation with zero configuration.
- [Output Formats](https://ibm-d95bab6e.mintlify.app/sql-tools/output-formats.md): Configure table styles, row limits, and result formatting for SQL tool outputs
- [SQL Tools Overview](https://ibm-d95bab6e.mintlify.app/sql-tools/overview.md): Learn how YAML-defined SQL tools enable rapid development of IBM i database operations without writing TypeScript code.
- [SQL Tools Examples Guide](https://ibm-d95bab6e.mintlify.app/sql-tools/parameter-guide.md): Practical examples and patterns for using parameters in SQL tools with validation, constraints, and best practices.
- [Sources Reference](https://ibm-d95bab6e.mintlify.app/sql-tools/sources.md): Complete reference for configuring database connection sources in YAML SQL tools.
- [Tools Reference](https://ibm-d95bab6e.mintlify.app/sql-tools/tools.md): Complete reference for defining SQL tools including parameters, validation, security, and response formatting.
- [Toolsets Reference](https://ibm-d95bab6e.mintlify.app/sql-tools/toolsets.md): Complete reference for organizing SQL tools into logical groups using toolsets.
- [Using Default Tools](https://ibm-d95bab6e.mintlify.app/sql-tools/using-default-tools.md): Comprehensive guide to starting the MCP server with pre-built SQL tools for IBM i operations.

## Optional

- [GitHub Repository](https://github.com/IBM/ibmi-mcp-server.git)
- [IBM i Resources](https://www.ibm.com/docs/en/i)
- [MCP Specification](https://modelcontextprotocol.io/specification)