| Name | alation-ai-agent-mcp JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | Alation Agent SDK with MCP support |
| upload_time | 2025-08-20 20:53:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
alation
ai agent sdk
alation agent python sdk
alation ai agent sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MCP Integration
The SDK includes built-in support for the Model Context Protocol (MCP), which enables AI models to retrieve knowledge from Alation during inference.
This package provides an MCP server that exposes Alation Data Catalog capabilities to AI agents with support for multiple transport modes.
## Overview
The MCP integration enables:
- Running an MCP-compatible server that provides access to Alation's context capabilities
- Making Alation metadata accessible to any MCP client
- **NEW**: HTTP mode with OAuth authentication for web-based integrations
- Traditional STDIO mode for direct MCP client connections (like Claude Desktop)
## Transport Modes
### STDIO Mode (Default)
- **Use case**: Direct integration with MCP clients like Claude Desktop, Cursor, etc.
- **Authentication**: Environment variables (refresh token or service account)
- **Connection**: Standard input/output communication
- **Best for**: Local development, desktop applications
### HTTP Mode (New)
- **Use case**: Web-based applications, hosted services, microservice architectures
- **Authentication**: OAuth bearer tokens per request
- **Connection**: RESTful HTTP API with MCP-over-HTTP protocol
- **Best for**: Azure Copilot, LibreChat, VS Code
## Quick Reference
### STDIO Mode (Traditional MCP)
```bash
# Start server for MCP clients (Claude Desktop, Cursor, etc.)
start-alation-mcp-server
# With custom configuration
start-alation-mcp-server \
--disabled-tools "TOOL1,TOOL2" \
--enabled-beta-tools "LINEAGE"
```
### HTTP Mode (Web API)
```bash
# Start HTTP server
start-alation-mcp-server --transport http --host 0.0.0.0 --port 8000
# Production configuration
start-alation-mcp-server \
--transport http \
--host 0.0.0.0 \
--port 8000 \
--external-url https://your-domain.com
```
**Need more details?** See the complete [HTTP Mode Guide](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/http_mode.md) for web applications and API integrations.
## Prerequisites
- Python 3.10 or higher
- Access to an Alation Data Catalog instance
- A valid refresh token or client_id and secret. For more details, refer to the [Authentication Guide](https://github.com/Alation/alation-ai-agent-sdk/blob/main/guides/authentication.md).
## Setup
### Environment Variables
Set up your environment variables based on the transport mode you plan to use:
```bash
export ALATION_BASE_URL="https://your-alation-instance.com"
# For authentication (required for both modes)
export ALATION_AUTH_METHOD="user_account"
export ALATION_USER_ID="12345"
export ALATION_REFRESH_TOKEN="your-refresh-token"
# Alternatively, for service account authentication
export ALATION_AUTH_METHOD="service_account"
export ALATION_CLIENT_ID="your-client-id"
export ALATION_CLIENT_SECRET="your-client-secret"
# Optional configuration
export ALATION_DISABLED_TOOLS="tool1,tool2" # Disable specific tools
export ALATION_ENABLED_BETA_TOOLS="LINEAGE" # Enable beta tools
# For HTTP mode only
export MCP_EXTERNAL_URL="https://your-lb.com" # External URL for OAuth (production deployments)
```
### Method 1: Using `uvx` or `pipx` (Quickest)
#### STDIO Mode (Default)
The quickest way to try out the server in STDIO mode is using `pipx` or `uvx`:
```bash
# Using uvx (recommended)
uvx --from alation-ai-agent-mcp start-alaiton-mcp-server
# Using pipx
pipx run alation-ai-agent-mcp
```
#### HTTP Mode
To run the server in HTTP mode with OAuth authentication:
```bash
# Using uvx (recommended)
uvx --from alation-ai-agent-mcp start-alaiton-mcp-server --transport http --host 0.0.0.0 --port 8000
# Using pipx
pipx run alation-ai-agent-mcp --transport http --host 0.0.0.0 --port 8000
```
### Method 2: Using pip
1. Install the package: ```pip install alation-ai-agent-mcp```
2. Run the server:
#### STDIO Mode (Default)
```bash
# Option A: Using entry point
start-alation-mcp-server
# Option B: Using Python module
python -m alation_ai_agent_mcp
```
#### HTTP Mode
```bash
# Option A: Using entry point
start-alation-mcp-server --transport http --host 0.0.0.0 --port 8000
# Option B: Using Python module
python -m alation_ai_agent_mcp --transport http --host 0.0.0.0 --port 8000
```
### Advanced HTTP Mode Configuration
For production deployments, you can configure additional options:
```bash
# Full HTTP mode configuration
start-alation-mcp-server \
--transport http \
--host 0.0.0.0 \
--port 8000 \
--external-url https://your-load-balancer.com \
--disabled-tools "TOOL1,TOOL2" \
--enabled-beta-tools "LINEAGE"
```
**HTTP Mode Options:**
- `--host`: Host to bind the server to (default: 127.0.0.1)
- `--port`: Port to bind the server to (default: 8000)
- `--external-url`: External URL for OAuth callbacks (for load balancers/proxies)
- `--disabled-tools`: Comma-separated list of tools to disable
- `--enabled-beta-tools`: Comma-separated list of beta tools to enable
> **Note**:
> - **STDIO Mode**: Starts an MCP server using stdin/stdout. Connect to MCP clients like Claude Desktop, Cursor, or test with MCP Inspector.
> - **HTTP Mode**: Starts a web server with OAuth authentication. Access via HTTP API calls or integrate with web applications.
### Transport Mode Usage Examples
#### STDIO Mode - MCP Clients
Please refer to our guides for specific examples of STDIO mode integration:
- [Using with Claude Desktop](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/claude_desktop.md)
- [Testing with MCP Inspector](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/testing_with_mcp_inspector.md)
- [Integrating with LibreChat](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/librechat.md)
- [Integration with Code Editors](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/code_editors.md)
#### HTTP Mode - Web Applications
When running in HTTP mode, the server exposes RESTful endpoints compatible with the MCP-over-HTTP protocol:
```bash
# Example: List available tools
curl -H "Authorization: Bearer YOUR_TOKEN" \
http://localhost:8000/mcp
```
**Authentication for HTTP Mode:**
- Requires valid Alation access tokens as Bearer tokens
- Tokens are validated against your Alation instance
- Each request is authenticated independently
## Debugging and Development
### Using MCP Inspector (STDIO Mode)
To debug the server in STDIO mode, you can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector):
First clone and build the server:
```bash
git clone https://github.com/Alation/alation-ai-agent-sdk.git
cd python/dist-mcp
# Create a virtual environment
python -m venv venv
# Activate the virtual environment
# On macOS/Linux:
source venv/bin/activate
# On Windows:
venv\Scripts\activate
# Install dependencies
pip3 install pdm
pdm install
```
> Make sure you run the npx command from the active venv terminal
Run the MCP inspector:
```bash
npx @modelcontextprotocol/inspector python3 alation_ai_agent_mcp/server.py
```
### Testing HTTP Mode
For testing HTTP mode locally:
1. Start the server in HTTP mode:
```bash
start-alation-mcp-server --transport http --host 127.0.0.1 --port 8000
```
2. Test with a valid token (replace with your Alation access token):
```bash
curl -H "Authorization: Bearer YOUR_ALATION_ACCESS_TOKEN" \
http://localhost:8000/mcp
```
### Build using Docker
Build the server:
```bash
docker build -t alation-mcp-server .
```
Run in STDIO mode (default):
```bash
docker run --rm alation-mcp-server
```
Run in HTTP mode:
```bash
docker run --rm -p 8000:8000 alation-mcp-server --transport http --host 0.0.0.0 --port 8000
```
## Use Cases
### STDIO Mode
- **Claude Desktop integration**: Direct connection to Claude Desktop app
- **Local development**: Testing and development on local machines
- **Code editors**: Integration with Cursor, VS Code with MCP extensions
- **Command-line tools**: Integration with CLI applications that support MCP
### HTTP Mode
- **Web applications**: RESTful API integration for web apps
- **Microservices**: Part of a larger microservice architecture
- **Load balanced deployments**: Multiple server instances behind a load balancer
- **Cloud native**: Containerized deployments in Kubernetes or similar platforms
- **Third-party integrations**: API integration with external systems
Raw data
{
"_id": null,
"home_page": null,
"name": "alation-ai-agent-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "\"Jagannath (Jags) Saragadam\" <jags.saragadam@alation.com>, Lucy Eun <lucy.eun@alation.com>, Ashwin Kumar Muruganandam <ashwin-kumar.muruganandam@alation.com>, Adam Talmadge <adam.talmadge@alation.com>",
"keywords": "Alation, AI Agent SDK, Alation Agent Python SDK, Alation AI Agent SDK",
"author": null,
"author_email": "\"Jagannath (Jags) Saragadam\" <jags.saragadam@alation.com>, Lucy Eun <lucy.eun@alation.com>, Ashwin Kumar Muruganandam <ashwin-kumar.muruganandam@alation.com>, Adam Talmadge <adam.talmadge@alation.com>",
"download_url": "https://files.pythonhosted.org/packages/ff/04/7a7c11ac84437cf0dfc38c98a04fc833be54cb69fb4063e49567c8dc0ce2/alation_ai_agent_mcp-0.8.1.tar.gz",
"platform": null,
"description": "# MCP Integration\n\nThe SDK includes built-in support for the Model Context Protocol (MCP), which enables AI models to retrieve knowledge from Alation during inference.\n\nThis package provides an MCP server that exposes Alation Data Catalog capabilities to AI agents with support for multiple transport modes.\n\n## Overview\n\nThe MCP integration enables:\n\n- Running an MCP-compatible server that provides access to Alation's context capabilities\n- Making Alation metadata accessible to any MCP client\n- **NEW**: HTTP mode with OAuth authentication for web-based integrations\n- Traditional STDIO mode for direct MCP client connections (like Claude Desktop)\n\n## Transport Modes\n\n### STDIO Mode (Default)\n- **Use case**: Direct integration with MCP clients like Claude Desktop, Cursor, etc.\n- **Authentication**: Environment variables (refresh token or service account)\n- **Connection**: Standard input/output communication\n- **Best for**: Local development, desktop applications\n\n### HTTP Mode (New)\n- **Use case**: Web-based applications, hosted services, microservice architectures\n- **Authentication**: OAuth bearer tokens per request\n- **Connection**: RESTful HTTP API with MCP-over-HTTP protocol\n- **Best for**: Azure Copilot, LibreChat, VS Code\n\n## Quick Reference\n\n### STDIO Mode (Traditional MCP)\n```bash\n# Start server for MCP clients (Claude Desktop, Cursor, etc.)\nstart-alation-mcp-server\n\n# With custom configuration \nstart-alation-mcp-server \\\n --disabled-tools \"TOOL1,TOOL2\" \\\n --enabled-beta-tools \"LINEAGE\"\n```\n\n### HTTP Mode (Web API)\n```bash\n# Start HTTP server\nstart-alation-mcp-server --transport http --host 0.0.0.0 --port 8000\n\n# Production configuration\nstart-alation-mcp-server \\\n --transport http \\\n --host 0.0.0.0 \\\n --port 8000 \\\n --external-url https://your-domain.com\n```\n\n**Need more details?** See the complete [HTTP Mode Guide](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/http_mode.md) for web applications and API integrations.\n\n## Prerequisites\n\n- Python 3.10 or higher\n- Access to an Alation Data Catalog instance\n- A valid refresh token or client_id and secret. For more details, refer to the [Authentication Guide](https://github.com/Alation/alation-ai-agent-sdk/blob/main/guides/authentication.md).\n\n## Setup\n\n### Environment Variables\n\nSet up your environment variables based on the transport mode you plan to use:\n\n```bash\nexport ALATION_BASE_URL=\"https://your-alation-instance.com\"\n\n# For authentication (required for both modes)\nexport ALATION_AUTH_METHOD=\"user_account\"\nexport ALATION_USER_ID=\"12345\"\nexport ALATION_REFRESH_TOKEN=\"your-refresh-token\"\n\n# Alternatively, for service account authentication\nexport ALATION_AUTH_METHOD=\"service_account\"\nexport ALATION_CLIENT_ID=\"your-client-id\"\nexport ALATION_CLIENT_SECRET=\"your-client-secret\"\n\n# Optional configuration\nexport ALATION_DISABLED_TOOLS=\"tool1,tool2\" # Disable specific tools\nexport ALATION_ENABLED_BETA_TOOLS=\"LINEAGE\" # Enable beta tools\n\n# For HTTP mode only\nexport MCP_EXTERNAL_URL=\"https://your-lb.com\" # External URL for OAuth (production deployments)\n```\n\n### Method 1: Using `uvx` or `pipx` (Quickest)\n\n#### STDIO Mode (Default)\nThe quickest way to try out the server in STDIO mode is using `pipx` or `uvx`:\n\n```bash\n# Using uvx (recommended)\nuvx --from alation-ai-agent-mcp start-alaiton-mcp-server\n\n# Using pipx\npipx run alation-ai-agent-mcp\n```\n\n#### HTTP Mode\nTo run the server in HTTP mode with OAuth authentication:\n\n```bash\n# Using uvx (recommended) \nuvx --from alation-ai-agent-mcp start-alaiton-mcp-server --transport http --host 0.0.0.0 --port 8000\n\n# Using pipx\npipx run alation-ai-agent-mcp --transport http --host 0.0.0.0 --port 8000\n```\n\n### Method 2: Using pip\n\n1. Install the package: ```pip install alation-ai-agent-mcp```\n\n2. Run the server:\n\n#### STDIO Mode (Default)\n```bash\n# Option A: Using entry point\nstart-alation-mcp-server\n\n# Option B: Using Python module\npython -m alation_ai_agent_mcp\n```\n\n#### HTTP Mode\n```bash\n# Option A: Using entry point\nstart-alation-mcp-server --transport http --host 0.0.0.0 --port 8000\n\n# Option B: Using Python module \npython -m alation_ai_agent_mcp --transport http --host 0.0.0.0 --port 8000\n```\n\n### Advanced HTTP Mode Configuration\n\nFor production deployments, you can configure additional options:\n\n```bash\n# Full HTTP mode configuration\nstart-alation-mcp-server \\\n --transport http \\\n --host 0.0.0.0 \\\n --port 8000 \\\n --external-url https://your-load-balancer.com \\\n --disabled-tools \"TOOL1,TOOL2\" \\\n --enabled-beta-tools \"LINEAGE\"\n```\n\n**HTTP Mode Options:**\n- `--host`: Host to bind the server to (default: 127.0.0.1)\n- `--port`: Port to bind the server to (default: 8000) \n- `--external-url`: External URL for OAuth callbacks (for load balancers/proxies)\n- `--disabled-tools`: Comma-separated list of tools to disable\n- `--enabled-beta-tools`: Comma-separated list of beta tools to enable\n\n> **Note**: \n> - **STDIO Mode**: Starts an MCP server using stdin/stdout. Connect to MCP clients like Claude Desktop, Cursor, or test with MCP Inspector.\n> - **HTTP Mode**: Starts a web server with OAuth authentication. Access via HTTP API calls or integrate with web applications.\n\n### Transport Mode Usage Examples\n\n#### STDIO Mode - MCP Clients\nPlease refer to our guides for specific examples of STDIO mode integration:\n- [Using with Claude Desktop](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/claude_desktop.md)\n- [Testing with MCP Inspector](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/testing_with_mcp_inspector.md)\n- [Integrating with LibreChat](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/librechat.md)\n- [Integration with Code Editors](https://github.com/Alation/alation-ai-agent-sdk/tree/main/guides/mcp/code_editors.md)\n\n#### HTTP Mode - Web Applications\n\nWhen running in HTTP mode, the server exposes RESTful endpoints compatible with the MCP-over-HTTP protocol:\n\n```bash\n# Example: List available tools\ncurl -H \"Authorization: Bearer YOUR_TOKEN\" \\\n http://localhost:8000/mcp\n```\n\n**Authentication for HTTP Mode:**\n- Requires valid Alation access tokens as Bearer tokens\n- Tokens are validated against your Alation instance\n- Each request is authenticated independently\n\n## Debugging and Development\n\n### Using MCP Inspector (STDIO Mode)\n\nTo debug the server in STDIO mode, you can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector):\n\nFirst clone and build the server:\n```bash\ngit clone https://github.com/Alation/alation-ai-agent-sdk.git\ncd python/dist-mcp\n\n# Create a virtual environment\npython -m venv venv\n\n# Activate the virtual environment\n# On macOS/Linux:\nsource venv/bin/activate\n# On Windows:\nvenv\\Scripts\\activate\n\n# Install dependencies\npip3 install pdm\npdm install\n```\n\n> Make sure you run the npx command from the active venv terminal\n\nRun the MCP inspector:\n```bash\nnpx @modelcontextprotocol/inspector python3 alation_ai_agent_mcp/server.py\n```\n\n### Testing HTTP Mode\n\nFor testing HTTP mode locally:\n\n1. Start the server in HTTP mode:\n```bash\nstart-alation-mcp-server --transport http --host 127.0.0.1 --port 8000\n```\n\n2. Test with a valid token (replace with your Alation access token):\n```bash\ncurl -H \"Authorization: Bearer YOUR_ALATION_ACCESS_TOKEN\" \\\n http://localhost:8000/mcp\n```\n\n### Build using Docker\n\nBuild the server:\n```bash\ndocker build -t alation-mcp-server .\n```\n\nRun in STDIO mode (default):\n```bash\ndocker run --rm alation-mcp-server\n```\n\nRun in HTTP mode:\n```bash\ndocker run --rm -p 8000:8000 alation-mcp-server --transport http --host 0.0.0.0 --port 8000\n```\n\n## Use Cases\n\n### STDIO Mode\n- **Claude Desktop integration**: Direct connection to Claude Desktop app\n- **Local development**: Testing and development on local machines\n- **Code editors**: Integration with Cursor, VS Code with MCP extensions\n- **Command-line tools**: Integration with CLI applications that support MCP\n\n### HTTP Mode \n- **Web applications**: RESTful API integration for web apps\n- **Microservices**: Part of a larger microservice architecture\n- **Load balanced deployments**: Multiple server instances behind a load balancer\n- **Cloud native**: Containerized deployments in Kubernetes or similar platforms\n- **Third-party integrations**: API integration with external systems",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "Alation Agent SDK with MCP support",
"version": "0.8.1",
"project_urls": {
"Documentation": "https://github.com/Alation/alation-ai-agent-sdk/blob/main/python/dist-mcp/README.md",
"Homepage": "https://github.com/Alation/alation-ai-agent-sdk/tree/main/python/dist-mcp",
"Issues": "https://github.com/Alation/alation-ai-agent-sdk/issues"
},
"split_keywords": [
"alation",
" ai agent sdk",
" alation agent python sdk",
" alation ai agent sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b09d1ca68b9d8172823cb96e482c48a1bde5b8f88e46c39af508676d41c1e032",
"md5": "5717cd3bfc4ecdc902c3272cba684b0b",
"sha256": "72b2adc3f2199c468ba3d01c575adcafaefeded8920528ddd625244d12683782"
},
"downloads": -1,
"filename": "alation_ai_agent_mcp-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5717cd3bfc4ecdc902c3272cba684b0b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 21632,
"upload_time": "2025-08-20T20:52:58",
"upload_time_iso_8601": "2025-08-20T20:52:58.942672Z",
"url": "https://files.pythonhosted.org/packages/b0/9d/1ca68b9d8172823cb96e482c48a1bde5b8f88e46c39af508676d41c1e032/alation_ai_agent_mcp-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ff047a7c11ac84437cf0dfc38c98a04fc833be54cb69fb4063e49567c8dc0ce2",
"md5": "320a4b8e51ac6305f5bbcc63502178f3",
"sha256": "4b5dc2c3b7acb5a06df168aee97dc5e5cf33d305706bf17a3abdfcde70795932"
},
"downloads": -1,
"filename": "alation_ai_agent_mcp-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "320a4b8e51ac6305f5bbcc63502178f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23685,
"upload_time": "2025-08-20T20:53:00",
"upload_time_iso_8601": "2025-08-20T20:53:00.297506Z",
"url": "https://files.pythonhosted.org/packages/ff/04/7a7c11ac84437cf0dfc38c98a04fc833be54cb69fb4063e49567c8dc0ce2/alation_ai_agent_mcp-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 20:53:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alation",
"github_project": "alation-ai-agent-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "alation-ai-agent-mcp"
}
