@ibm/ibmi-mcp-server
v0.1.0
Published
A production-grade TypeScript template for building robust Model Context Protocol (MCP) servers, featuring built-in observability with OpenTelemetry, advanced error handling, comprehensive utilities, and a modular architecture.
Readme
IBM i MCP Server
The Model Context Protocol (MCP) server for IBM i systems.
Quick Start
# Install dependencies
npm install
# Build
npm run build
# Run server (HTTP mode)
npm run start:http
# Run server (stdio mode)
npm run start:stdio
# Run tests
npm testConfiguration
Create a .env file in the root of the monorepo (parent directory):
cp ../.env.example ../.envThe server will automatically detect configuration in:
- Current working directory (for production deployments)
- Parent directory (for monorepo development)
- Server directory (for local overrides)
Tool Configuration
By default, the server loads SQL tools from ../tools/. Override with:
TOOLS_YAML_PATH=../tools npm run start:httpOr set in your .env file:
TOOLS_YAML_PATH=toolsDocumentation
See the root README for complete documentation and deployment guides.
Development
This is the main server package within the monorepo. All server development happens here.
- Source:
src/ - Tests:
tests/ - Scripts:
scripts/ - Build Output:
dist/
Available Scripts
npm run build- Build the servernpm run rebuild- Clean and rebuildnpm run start:http- Start in HTTP modenpm run start:stdio- Start in stdio modenpm test- Run testsnpm run test:watch- Run tests in watch modenpm run test:coverage- Run tests with coveragenpm run lint- Lint codenpm run format- Format code with Prettiernpm run validate- Validate tool configurations
Architecture
See CLAUDE.md for architectural standards and development guidelines.
Monorepo Structure
This server is part of a monorepo:
../tools/- SQL tool YAML configurations../agents/- Agent implementations and examples../apps/- Deployment configurations (Docker, Gateway, n8n)
