Update documentation (#52)

Author: acmlau

CONTRIBUTING.md

@@ -52,7 +52,7 @@ For detailed technical information, development workflow, and troubleshooting, s
 - [ ] Read [DEVELOPMENT.md](DEVELOPMENT.md) and set up your environment
 - [ ] Create tests for new functionality
 - [ ] Ensure all tests pass locally
-- [ ] Follow [integ/README.md](/tests/integ/README.md) to run integration tests
+- [ ] Follow [integ/README.md](https://github.com/aws/aws-mcp-proxy/blob/main/tests/integ/README.md) to run integration tests
 - [ ] Run code quality tools (`ruff`, `pyright`, `pre-commit`)
 - [ ] Update documentation if needed
 

DEVELOPMENT.md

@@ -106,7 +106,7 @@ npx @modelcontextprotocol/inspector uv run \
   aws_mcp_proxy/server.py \
   --endpoint <your-endpoint>
 ```
-Then click "Connect" in the opened browser window to interact with the server.
+A browser window will open automatically outside of your terminal window. Navigate to the browser window. Then click "Connect" in the opened browser window to interact with the server.
 
 #### Advanced Options
 ```bash
@@ -391,6 +391,6 @@ uv run aws_mcp_proxy/server.py --endpoint <endpoint>
 ---
 
 For questions or issues not covered in this guide, please:
-1. Check existing [GitHub Issues](../../issues)
+1. Check existing [GitHub Issues](https://github.com/aws/aws-mcp-proxy/issues)
 2. Review the [MCP Specification](https://spec.modelcontextprotocol.io/)
 3. Create a new issue with detailed information about your problem

README.md

@@ -1,6 +1,6 @@
 # AWS MCP Proxy
 
-AWS MCP Proxy Server
+This README provides an overview and configuration information for the AWS MCP Proxy Server. You can use this project to set up and deploy to a configured AWS MCP Proxy Server.
 
 ## Overview
 
@@ -19,7 +19,7 @@ The proxy handles [SigV4](https://docs.aws.amazon.com/IAM/latest/UserGuide/refer
 
 ### Using PyPi
 
-*Note: will work after publishing to PyPi*
+*Note: The following command should run successfully after first publishing to PyPi.*
 
 ```
 # Run the server