Skip to content

Doc: added deployment readme #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

abhinavmathur-atlan
Copy link
Collaborator

@abhinavmathur-atlan abhinavmathur-atlan commented Jun 20, 2025

Changes Made

  1. Created a new DEPLOYMENT.md file that includes:
    -Instructions for when and how to use SSE (Server-Sent Events)
    -Guidelines for implementing HTTPS streaming
    -Documentation on Streamable interface usage
    -Standard I/O (stdio) implementation details
  2. Updated the main README.md to:
    -Add a reference link to the new deployment documentation
    -Improve navigation to the streaming options section
  3. Closes Issue - [DOCS] Start parameters #76

@SatabrataPaul-GitAc SatabrataPaul-GitAc changed the title added deployment readme added deployment readme ( #76 ) Jun 30, 2025
@SatabrataPaul-GitAc SatabrataPaul-GitAc changed the title added deployment readme ( #76 ) Doc: added deployment readme Jun 30, 2025
@abhinavmathur-atlan abhinavmathur-atlan requested a review from Hk669 July 7, 2025 13:10
## Deployment

For information on running the server in different environments (stdio, SSE, or streamable HTTP), see the [deployment guide](../deployment/Readme.md).

## Production Deployment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this outside the deployment?

@@ -0,0 +1,46 @@
## Deployment Guide for Atlan MCP Server

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it a new folder for this readme? It should be in the docs folder only

Copy link
Collaborator Author

@abhinavmathur-atlan abhinavmathur-atlan Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will move it to docs
Created the folder because it was in the issue doc
#76 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants