intelligencebank/ib-api-doc-mcp-server
3.1
If you are the rightful owner of ib-api-doc-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
A Model Context Protocol (MCP) server that provides tools for retrieving documentation from Postman collections and generating AI actions.
IB API Documentation
A Model Context Protocol (MCP) server that provides tools for retrieving documentation from Postman collections and generating AI actions.
Features
- List and search Postman collections
- Navigate collection structures
- Get detailed request information | - Comprehensive response example handling: | - List available response examples | - Get request details (focused on request information) | - Get detailed response example information | - Efficient workflow for accessing example data
- Generate code actions from Postman requests
- Optional integration with multiple AI frameworks
- TypeScript/JavaScript code generation
Documentation
- - Detailed information about server tools and data structures
- - Server setup and configuration options
- - Examples and templates for using the tools
- - How to update your MCP server installation
Installation
- Clone the repository:
git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc
- Install dependencies:
npm install
- Build the server:
npm run build
- Configure the server following the
Usage
See the guide for detailed usage instructions and examples.
Development
Development Workflow
- Set up development environment:
# Clone and set up the repository
git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc
npm install
- Configure development server:
- Create a development configuration in your MCP settings file
- Point it to your local development build
- Include all tools in the alwaysAllow array
- Development cycle:
# Make code changes
npm run build # Build the changes
# Reload VSCode window to pick up new build
# Test using the development server configuration
# Repeat until satisfied with changes
- Before committing:
- Test all affected functionality
- Update documentation if needed
- Follow the git workflow below
Git Workflow
- Before starting development:
git pull origin main
npm install # If dependencies have changed
- During development:
- The
.gitignorefile is configured to exclude:- Build artifacts (
build/,dist/) - Dependencies (
node_modules/) - Environment files (
.env*) - IDE files (
.vscode/,.idea/) - Logs and debug files
- System files (
.DS_Store,Thumbs.db)
- Build artifacts (
- Committing changes:
git add . # Stage changes (respects .gitignore)
git commit -m "type: description
- Bullet points for specific changes
- Another change"
- Pushing changes:
git pull origin main # Get latest changes
git push origin main # Push your changes
Development Server
To run the server in development mode with automatic reloading:
npm run watch
To inspect the server's capabilities:
npm run inspector
License
Private - IntelligenceBank © 2024
