mukaddamzaid commited on
Commit
6ec5ed4
1 Parent(s): 7984c85

feat: add Apache License and update README

Browse files

- Added Apache License 2.0 to the project.
- Updated README to reflect the new project name and description, emphasizing the integration with Model Context Protocol (MCP).

Files changed (2) hide show
  1. LICENSE +190 -0
  2. README.md +12 -87
LICENSE ADDED
@@ -0,0 +1,190 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2025 Zaid Mukaddam
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
README.md CHANGED
@@ -1,84 +1,27 @@
1
- <a href="https://ai-sdk-starter-xai.vercel.app">
2
- <h1 align="center">Vercel x xAI Chatbot</h1>
3
  </a>
4
 
5
  <p align="center">
6
- An open-source AI chatbot app template built with Next.js, the AI SDK by Vercel, and xAI.
7
  </p>
8
 
9
  <p align="center">
10
  <a href="#features"><strong>Features</strong></a> 路
11
- <a href="#deploy-your-own"><strong>Deploy Your Own</strong></a> 路
12
- <a href="#running-locally"><strong>Running Locally</strong></a> 路
13
  <a href="#mcp-server-configuration"><strong>MCP Configuration</strong></a> 路
14
- <a href="#authors"><strong>Authors</strong></a>
15
  </p>
16
  <br/>
17
 
18
  ## Features
19
 
20
  - Streaming text responses powered by the [AI SDK by Vercel](https://sdk.vercel.ai/docs), allowing multiple AI providers to be used interchangeably with just a few lines of code.
21
- - Built-in tool integration for extending AI capabilities (demonstrated with a weather tool example).
22
- - Support for [Model Context Protocol (MCP)](https://modelcontextprotocol.io) servers to expand available tools.
23
  - Multiple MCP transport types (SSE and stdio) for connecting to various tool providers.
 
24
  - Reasoning model support.
25
  - [shadcn/ui](https://ui.shadcn.com/) components for a modern, responsive UI powered by [Tailwind CSS](https://tailwindcss.com).
26
  - Built with the latest [Next.js](https://nextjs.org) App Router.
27
 
28
- ## Deploy Your Own
29
-
30
- You can deploy your own version to Vercel by clicking the button below:
31
-
32
- [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?project-name=Vercel+x+xAI+Chatbot&repository-name=ai-sdk-starter-xai&repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-sdk-starter-xai&demo-title=Vercel+x+xAI+Chatbot&demo-url=https%3A%2F%2Fai-sdk-starter-xai.labs.vercel.dev%2F&demo-description=A+simple+chatbot+application+built+with+Next.js+that+uses+xAI+via+the+AI+SDK+and+the+Vercel+Marketplace&products=[{%22type%22:%22integration%22,%22protocol%22:%22ai%22,%22productSlug%22:%22grok%22,%22integrationSlug%22:%22xai%22}])
33
-
34
- ## Running Locally
35
-
36
- 1. Clone the repository and install dependencies:
37
-
38
- ```bash
39
- npm install
40
- # or
41
- yarn install
42
- # or
43
- pnpm install
44
- ```
45
-
46
- 2. Install the [Vercel CLI](https://vercel.com/docs/cli):
47
-
48
- ```bash
49
- npm i -g vercel
50
- # or
51
- yarn global add vercel
52
- # or
53
- pnpm install -g vercel
54
- ```
55
-
56
- Once installed, link your local project to your Vercel project:
57
-
58
- ```bash
59
- vercel link
60
- ```
61
-
62
- After linking, pull your environment variables:
63
-
64
- ```bash
65
- vercel env pull
66
- ```
67
-
68
- This will create a `.env.local` file with all the necessary environment variables.
69
-
70
- 3. Run the development server:
71
-
72
- ```bash
73
- npm run dev
74
- # or
75
- yarn dev
76
- # or
77
- pnpm dev
78
- ```
79
-
80
- 4. Open [http://localhost:3000](http://localhost:3000) to view your new AI chatbot application.
81
-
82
  ## MCP Server Configuration
83
 
84
  This application supports connecting to Model Context Protocol (MCP) servers to access their tools. You can add and manage MCP servers through the settings icon in the chat interface.
@@ -100,8 +43,8 @@ If you select SSE transport:
100
  #### stdio Configuration
101
 
102
  If you select stdio transport:
103
- 1. Enter the command to execute (e.g., `node`)
104
- 2. Enter the command arguments (e.g., `src/mcp-server.js --port 3001`)
105
  - You can enter space-separated arguments or paste a JSON array
106
  3. Click "Add Server"
107
 
@@ -111,28 +54,10 @@ If you select stdio transport:
111
 
112
  You can use any MCP-compatible server with this application. Here are some examples:
113
 
114
- - [Composio](https://composio.dev) - Provides search, code interpreter, and other tools
115
- - Any local MCP server using stdio transport
116
- - [Any other third-party MCP server]
117
-
118
- ### Installing Required Dependencies
119
-
120
- If you're running the project locally and encounter issues with MCP integration, make sure to install the required dependencies:
121
-
122
- ```bash
123
- npm run install-mcp
124
- # or
125
- yarn install-mcp
126
- # or
127
- pnpm run install-mcp
128
- ```
129
-
130
- ### Creating Your Own MCP Server
131
-
132
- For information on creating your own MCP server, refer to the [Model Context Protocol documentation](https://modelcontextprotocol.io).
133
-
134
- ## Authors
135
 
136
- This repository is maintained by the [Vercel](https://vercel.com) team and community contributors.
137
 
138
- Contributions are welcome! Feel free to open issues or submit pull requests to enhance functionality or fix bugs.
 
1
+ <a href="https://mcp.scira.ai">
2
+ <h1 align="center">Scira MCP Chat</h1>
3
  </a>
4
 
5
  <p align="center">
6
+ An open-source AI chatbot app powered by Model Context Protocol (MCP), built with Next.js and the AI SDK by Vercel.
7
  </p>
8
 
9
  <p align="center">
10
  <a href="#features"><strong>Features</strong></a> 路
 
 
11
  <a href="#mcp-server-configuration"><strong>MCP Configuration</strong></a> 路
 
12
  </p>
13
  <br/>
14
 
15
  ## Features
16
 
17
  - Streaming text responses powered by the [AI SDK by Vercel](https://sdk.vercel.ai/docs), allowing multiple AI providers to be used interchangeably with just a few lines of code.
18
+ - Full integration with [Model Context Protocol (MCP)](https://modelcontextprotocol.io) servers to expand available tools and capabilities.
 
19
  - Multiple MCP transport types (SSE and stdio) for connecting to various tool providers.
20
+ - Built-in tool integration for extending AI capabilities.
21
  - Reasoning model support.
22
  - [shadcn/ui](https://ui.shadcn.com/) components for a modern, responsive UI powered by [Tailwind CSS](https://tailwindcss.com).
23
  - Built with the latest [Next.js](https://nextjs.org) App Router.
24
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  ## MCP Server Configuration
26
 
27
  This application supports connecting to Model Context Protocol (MCP) servers to access their tools. You can add and manage MCP servers through the settings icon in the chat interface.
 
43
  #### stdio Configuration
44
 
45
  If you select stdio transport:
46
+ 1. Enter the command to execute (e.g., `npx`)
47
+ 2. Enter the command arguments (e.g., `-y @modelcontextprotocol/server-google-maps`)
48
  - You can enter space-separated arguments or paste a JSON array
49
  3. Click "Add Server"
50
 
 
54
 
55
  You can use any MCP-compatible server with this application. Here are some examples:
56
 
57
+ - [Composio](https://composio.dev/mcp) - Provides search, code interpreter, and other tools
58
+ - [Zapier MCP](https://zapier.com/mcp) - Provides access to Zapier tools
59
+ - Any MCP server using stdio transport with npx and python3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
 
61
+ ## License
62
 
63
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.