Refactor Axiom 2.0 documentation by adding web search capability using Tavily MCP, and updating MCP server configuration details in chainlit.md and README.md
Browse files- .github/README.md +7 -7
- chainlit.md +3 -4
.github/README.md
CHANGED
@@ -5,27 +5,27 @@
|
|
5 |
Axiom 2.0 is an **advanced AI Agent** built to assist developers in navigating the complex landscape of modern AI and software development. Leveraging the **OpenAI Agents SDK**, **Model Context Protocol (MCP)**, Chainlit, and Gemini models, Axiom 2.0 specializes in generating accurate, production-ready code and providing expert guidance across areas like agent architectures, RAG systems, authentication, vector databases, and full-stack development.
|
6 |
|
7 |
Axiom 2.0 is an upgrade of Axiom 1.0, it has the following more features:
|
8 |
-
1. **
|
9 |
-
2. **
|
10 |
-
3. **Vast Library Database:** It has access to a vast library database (**2000+** libraries, frameworks, and tools) unlike it's predecessor, Axiom 1.0 which had only 20 libraries documentation.
|
11 |
|
12 |
## Features
|
13 |
|
14 |
* 🤖 **Interactive Chat Interface:** Built with Chainlit for a smooth conversational experience.
|
15 |
* 📚 **Advanced Documentation Access:** Utilizes a dedicated MCP server to retrieve and apply technical information from various sources, ensuring code and explanations are accurate and up-to-date.
|
16 |
-
* 🧠 **Strategic Planning:** Employs a **Sequential Thinking MCP** tool to break down complex requests, plan code architecture, and structure its responses effectively.
|
17 |
* 🧪 **Two Modes:**
|
18 |
1. **Agent Mode:** Ideal for complex tasks like end-to-end projects and full-stack development.
|
19 |
2. **Assistant Mode:** Suited for quick information retrieval and answering questions.
|
|
|
20 |
* 📦 **Containerized Deployment:** Includes a `Dockerfile` for easy deployment to platforms like Hugging Face Spaces or Docker environments.
|
21 |
|
|
|
22 |
## How it Works
|
23 |
|
24 |
Axiom 2.0 operates using the OpenAI Agents SDK. MCP servers are integrated as specialized tools:
|
25 |
|
26 |
-
1. **Configuration (`mcp.json`):** The `mcp.json` file in the project root defines the MCP servers (like the
|
27 |
2. **Agent Initialization:** When the Chainlit application starts, it reads `mcp.json`, initializes the specified `MCPServerStdio` instances, and attempts to start their underlying processes.
|
28 |
-
3. **Response Integration:** The MCP server performs its task (e.g., searching documentation,
|
29 |
|
30 |
## Prerequisites
|
31 |
|
@@ -87,7 +87,7 @@ The `-w` flag enables auto-reloading during development. For production, omit `-
|
|
87 |
```
|
88 |
|
89 |
2. **Run the Docker container:**
|
90 |
-
Map the container's port 7860 (where Chainlit runs) to a port on your host machine (e.g., 7860).
|
91 |
```bash
|
92 |
docker run -p 7860:7860 -p 8082:8082 axiom-2.0
|
93 |
```
|
|
|
5 |
Axiom 2.0 is an **advanced AI Agent** built to assist developers in navigating the complex landscape of modern AI and software development. Leveraging the **OpenAI Agents SDK**, **Model Context Protocol (MCP)**, Chainlit, and Gemini models, Axiom 2.0 specializes in generating accurate, production-ready code and providing expert guidance across areas like agent architectures, RAG systems, authentication, vector databases, and full-stack development.
|
6 |
|
7 |
Axiom 2.0 is an upgrade of Axiom 1.0, it has the following more features:
|
8 |
+
1. **Production-Ready Code Focus:** Axiom 2.0's primary goal is to generate production-quality, modular, efficient, scalable, and readable code, including end-to-end projects and full-stack applications.
|
9 |
+
2. **Vast Library Database:** It has access to a vast library database (**2000+** libraries, frameworks, and tools) unlike it's predecessor, Axiom 1.0 which had only 20 libraries documentation.
|
|
|
10 |
|
11 |
## Features
|
12 |
|
13 |
* 🤖 **Interactive Chat Interface:** Built with Chainlit for a smooth conversational experience.
|
14 |
* 📚 **Advanced Documentation Access:** Utilizes a dedicated MCP server to retrieve and apply technical information from various sources, ensuring code and explanations are accurate and up-to-date.
|
|
|
15 |
* 🧪 **Two Modes:**
|
16 |
1. **Agent Mode:** Ideal for complex tasks like end-to-end projects and full-stack development.
|
17 |
2. **Assistant Mode:** Suited for quick information retrieval and answering questions.
|
18 |
+
* 🧠 **Web Search:** It uses Tavily MCP server to search the web and extract content from URLs.
|
19 |
* 📦 **Containerized Deployment:** Includes a `Dockerfile` for easy deployment to platforms like Hugging Face Spaces or Docker environments.
|
20 |
|
21 |
+
|
22 |
## How it Works
|
23 |
|
24 |
Axiom 2.0 operates using the OpenAI Agents SDK. MCP servers are integrated as specialized tools:
|
25 |
|
26 |
+
1. **Configuration (`mcp.json`):** The `mcp.json` file in the project root defines the MCP servers (like the Context7 and Tavily servers).
|
27 |
2. **Agent Initialization:** When the Chainlit application starts, it reads `mcp.json`, initializes the specified `MCPServerStdio` instances, and attempts to start their underlying processes.
|
28 |
+
3. **Response Integration:** The MCP server performs its task (e.g., searching documentation, searching web) and sends the result back to the agent via the SDK. The agent then uses this information to formulate its final response to the user.
|
29 |
|
30 |
## Prerequisites
|
31 |
|
|
|
87 |
```
|
88 |
|
89 |
2. **Run the Docker container:**
|
90 |
+
Map the container's port 7860 (where Chainlit runs) to a port on your host machine (e.g., 7860).
|
91 |
```bash
|
92 |
docker run -p 7860:7860 -p 8082:8082 axiom-2.0
|
93 |
```
|
chainlit.md
CHANGED
@@ -3,18 +3,17 @@
|
|
3 |
Axiom 2.0 is an **advanced AI Agent** built to assist developers in navigating the complex landscape of modern AI and software development. Leveraging the **OpenAI Agents SDK**, **Model Context Protocol (MCP)**, Chainlit, and Gemini models, Axiom 2.0 specializes in generating accurate, production-ready code and providing expert guidance across areas like agent architectures, RAG systems, authentication, vector databases, and full-stack development.
|
4 |
|
5 |
Axiom 2.0 is an upgrade of Axiom 1.0, it has the following more features:
|
6 |
-
1. **
|
7 |
-
2. **
|
8 |
-
3. **Vast Library Database:** It has access to a vast library database (**2000+** libraries, frameworks, and tools) unlike it's predecessor, Axiom 1.0 which had only 20 libraries documentation.
|
9 |
|
10 |
## Features
|
11 |
|
12 |
* 🤖 **Interactive Chat Interface:** Built with Chainlit for a smooth conversational experience.
|
13 |
* 📚 **Advanced Documentation Access:** Utilizes a dedicated MCP server to retrieve and apply technical information from various sources, ensuring code and explanations are accurate and up-to-date.
|
14 |
-
* 🧠 **Strategic Planning:** Employs a **Sequential Thinking MCP** tool to break down complex requests, plan code architecture, and structure its responses effectively.
|
15 |
* 🧪 **Two Modes:**
|
16 |
1. **Agent Mode:** Ideal for complex tasks like end-to-end projects and full-stack development.
|
17 |
2. **Assistant Mode:** Suited for quick information retrieval and answering questions.
|
|
|
18 |
* 📦 **Containerized Deployment:** Includes a `Dockerfile` for easy deployment to platforms like Hugging Face Spaces or Docker environments.
|
19 |
|
20 |
## Project Code
|
|
|
3 |
Axiom 2.0 is an **advanced AI Agent** built to assist developers in navigating the complex landscape of modern AI and software development. Leveraging the **OpenAI Agents SDK**, **Model Context Protocol (MCP)**, Chainlit, and Gemini models, Axiom 2.0 specializes in generating accurate, production-ready code and providing expert guidance across areas like agent architectures, RAG systems, authentication, vector databases, and full-stack development.
|
4 |
|
5 |
Axiom 2.0 is an upgrade of Axiom 1.0, it has the following more features:
|
6 |
+
1. **Production-Ready Code Focus:** Axiom 2.0's primary goal is to generate production-quality, modular, efficient, scalable, and readable code, including end-to-end projects and full-stack applications.
|
7 |
+
2. **Vast Library Database:** It has access to a vast library database (**2000+** libraries, frameworks, and tools) unlike it's predecessor, Axiom 1.0 which had only 20 libraries documentation.
|
|
|
8 |
|
9 |
## Features
|
10 |
|
11 |
* 🤖 **Interactive Chat Interface:** Built with Chainlit for a smooth conversational experience.
|
12 |
* 📚 **Advanced Documentation Access:** Utilizes a dedicated MCP server to retrieve and apply technical information from various sources, ensuring code and explanations are accurate and up-to-date.
|
|
|
13 |
* 🧪 **Two Modes:**
|
14 |
1. **Agent Mode:** Ideal for complex tasks like end-to-end projects and full-stack development.
|
15 |
2. **Assistant Mode:** Suited for quick information retrieval and answering questions.
|
16 |
+
* 🧠 **Web Search:** It uses Tavily MCP server to search the web and extract content from URLs.
|
17 |
* 📦 **Containerized Deployment:** Includes a `Dockerfile` for easy deployment to platforms like Hugging Face Spaces or Docker environments.
|
18 |
|
19 |
## Project Code
|