diff --git a/.dockerignore b/.dockerignore index 24d88996..1199c68a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,13 +1,180 @@ node_modules -npm-debug.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +.pnpm-debug.log* + +# Local env files +.env +.env.* +!.env.example + +# Vercel +.vercel + +# TypeScript +*.tsbuildinfo +next-env.d.ts + +# Turborepo +.turbo + +# IDE +.vscode/ +.idea/ +*.swp +*.swo + +# OS +.DS_Store +*.pem + +# Debug +debug +node_debug.log + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage +.grunt + +# Bower dependency directory +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons +build/Release + +# Dependency directories +jspm_packages/ + +# TypeScript cache (already covered above) + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional stylelint cache +.stylelintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# parcel-bundler cache +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist-ssr +*.local + +# Storybook build outputs +.out +.storybook-out + +# Temporary folders +tmp/ +temp/ + +# Git +.git/ +.gitignore +README.md + +# Docker Dockerfile* docker-compose* .dockerignore -.git -.gitignore -README.md -LICENSE -.vscode -.next -*.swp -/scripts \ No newline at end of file + +# CI +.github/ +.gitlab-ci.yml +.travis.yml +.circleci/ + +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Coverage directory used by tools like istanbul +coverage + +# Dependency directories +node_modules/ + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# Project specific +dist/ +build/ +drizzle/migrations/ + +# Documentation +*.md +!DOCKER_README.md +CONTRIBUTING.md +CHANGELOG.md + +# Test files +**/*.test.ts +**/*.test.tsx +**/*.spec.ts +**/*.spec.tsx +__tests__/ +test/ +tests/ +coverage/ + +# Local development +.env.local +.env.development +.env.test \ No newline at end of file diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index dfe07704..00000000 --- a/.gitattributes +++ /dev/null @@ -1,2 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml new file mode 100644 index 00000000..aa3cbfcc --- /dev/null +++ b/.github/workflows/docker-publish.yml @@ -0,0 +1,67 @@ +name: Build and Push to GHCR + +on: + push: + branches: + - main + tags: + - '[0-9]+.[0-9]+.[0-9]+' + - 'v[0-9]+.[0-9]+.[0-9]+' + workflow_dispatch: + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-and-push: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + attestations: write + id-token: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log in to Container Registry + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + type=semver,pattern={{major}} + type=raw,value=latest + + - name: Build and push Docker image + id: push + uses: docker/build-push-action@v5 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + - name: Generate artifact attestation + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}} + subject-digest: ${{ steps.push.outputs.digest }} + push-to-registry: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index 3efbeb1e..f4b3edd2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,43 +1,41 @@ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. -# dependencies -/node_modules -/.pnp -.pnp.* -.yarn/* -!.yarn/patches -!.yarn/plugins -!.yarn/releases -!.yarn/versions - -# testing -/coverage - -# next.js -/.next/ -/out/ - -# production -/build - -# misc -.DS_Store -*.pem +# Dependencies +node_modules +.pnp +.pnp.js + +# Local env files +.env +.env.local +.env.development.local +.env.test.local +.env.production.local + +# Testing +coverage + +# Turbo +.turbo + +# Vercel +.vercel -# debug +# Build Outputs +.next/ +out/ +build +dist + + +# Debug npm-debug.log* yarn-debug.log* yarn-error.log* -.pnpm-debug.log* - -# env files (can opt-in for committing if needed) -.env* -# vercel -.vercel +# Misc +.DS_Store +*.pem -# typescript -*.tsbuildinfo -next-env.d.ts -.windsurfrules -metatool-web.code-workspace +.cursor/ +.vscode/ diff --git a/.npmrc b/.npmrc new file mode 100644 index 00000000..e69de29b diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index fedcdae7..00000000 --- a/.prettierignore +++ /dev/null @@ -1,10 +0,0 @@ -tailwind.config.ts -postcss.config.mjs -next.config.mjs -node_modules/* -dist/* -coverage/* -.gitignore -.prettierignore -.husky -pnpm-lock.yaml diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index e2045995..00000000 --- a/.prettierrc +++ /dev/null @@ -1,9 +0,0 @@ -{ - "singleQuote": true, - "arrowParens": "always", - "trailingComma": "es5", - "tabWidth": 2, - "jsxSingleQuote": true, - "bracketSameLine": true, - "endOfLine": "auto" -} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0d6a22f4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to MetaMCP + +We welcome contributions to MetaMCP! This guide will help you get started. + +## Development Setup + +1. Clone the repository: + ```bash + git clone https://github.com/metatool-ai/metamcp.git + cd metamcp + ``` + +2. Install dependencies: + ```bash + pnpm install + ``` + +3. Set up environment: + ```bash + cp example.env .env + ``` + +4. Start development: + ```bash + pnpm dev + ``` + +## How to Contribute + +1. Fork the repository +2. Create a feature branch: `git checkout -b feature/your-feature-name` +3. Make your changes +4. Test your changes +5. Commit your changes: `git commit -m "Description of changes"` +6. Push to your fork: `git push origin feature/your-feature-name` +7. Open a Pull Request + +## Pull Request Guidelines + +- Provide a clear description of the changes +- Explain how to test (human test is fine) + +## Issues + +- Use GitHub Issues to report bugs or request features +- Search existing issues before creating new ones +- Provide detailed information and reproduction steps for bugs + +## License + +By contributing to MetaMCP, you agree that your contributions will be licensed under the MIT License. \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 190a86cb..cc347cd8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,65 +1,108 @@ -FROM node:20-alpine AS base +# Use the official uv image as base +FROM ghcr.io/astral-sh/uv:debian AS base + +# Install Node.js and npm +RUN apt-get update && apt-get install -y \ + curl \ + gnupg \ + && curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \ + && apt-get install -y nodejs \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/* RUN npm i -g corepack@latest - -# Install pnpm -RUN corepack enable && corepack prepare pnpm@10.8.0 --activate +# Enable corepack for pnpm +RUN corepack enable && corepack prepare pnpm@10.12.0 --activate # Install dependencies only when needed FROM base AS deps WORKDIR /app -# Files needed for pnpm install -COPY package.json pnpm-lock.yaml* ./ -RUN pnpm install --frozen-lockfile +ENV NEXT_TELEMETRY_DISABLED 1 -# Rebuild the source code only when needed -FROM base AS builder -WORKDIR /app -COPY --from=deps /app/node_modules ./node_modules -COPY . . +# Copy root package files +COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./ +COPY turbo.json ./ -# Disable Next.js telemetry during the build -ENV NEXT_TELEMETRY_DISABLED 1 +# Copy package.json files from all workspaces +COPY apps/frontend/package.json ./apps/frontend/ +COPY apps/backend/package.json ./apps/backend/ +COPY packages/eslint-config/package.json ./packages/eslint-config/ +COPY packages/trpc/package.json ./packages/trpc/ +COPY packages/typescript-config/package.json ./packages/typescript-config/ +COPY packages/zod-types/package.json ./packages/zod-types/ -RUN pnpm build:next +# Install dependencies +RUN pnpm install --frozen-lockfile -# Migration stage -FROM base AS migrator +# Builder stage +FROM base AS builder WORKDIR /app +# Copy node_modules from deps stage COPY --from=deps /app/node_modules ./node_modules +COPY --from=deps /app/apps/frontend/node_modules ./apps/frontend/node_modules +COPY --from=deps /app/apps/backend/node_modules ./apps/backend/node_modules +COPY --from=deps /app/packages ./packages + +# Copy source code COPY . . -ENV NODE_ENV production -CMD ["pnpm", "drizzle-kit", "migrate"] +# Build all packages and apps +RUN pnpm build -# Production image, copy all the files and run next +# Production runner stage FROM base AS runner WORKDIR /app -ENV NODE_ENV production -ENV NEXT_TELEMETRY_DISABLED 1 - -RUN addgroup --system --gid 1001 nodejs -RUN adduser --system --uid 1001 nextjs - -COPY --from=builder /app/public ./public +# OCI image labels +LABEL org.opencontainers.image.source="https://github.com/metatool-ai/metamcp" +LABEL org.opencontainers.image.description="MetaMCP - aggregates MCP servers into a unified MetaMCP" +LABEL org.opencontainers.image.licenses="MIT" +LABEL org.opencontainers.image.title="MetaMCP" +LABEL org.opencontainers.image.vendor="metatool-ai" -# Set the correct permission for prerender cache -RUN mkdir .next -RUN chown nextjs:nodejs .next +# Install curl for health checks +RUN apt-get update && apt-get install -y curl postgresql-client && apt-get clean && rm -rf /var/lib/apt/lists/* -# Automatically leverage output traces to reduce image size -COPY --from=builder /app/drizzle.config.ts ./ -COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./ -COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static +# Create non-root user with proper home directory +RUN addgroup --system --gid 1001 nodejs +RUN adduser --system --uid 1001 --home /home/nextjs nextjs && \ + mkdir -p /home/nextjs/.cache/node/corepack && \ + chown -R nextjs:nodejs /home/nextjs + +# Copy built applications +COPY --from=builder --chown=nextjs:nodejs /app/apps/frontend/.next ./apps/frontend/.next +COPY --from=builder --chown=nextjs:nodejs /app/apps/frontend/package.json ./apps/frontend/ +COPY --from=builder --chown=nextjs:nodejs /app/apps/backend/dist ./apps/backend/dist +COPY --from=builder --chown=nextjs:nodejs /app/apps/backend/package.json ./apps/backend/ +COPY --from=builder --chown=nextjs:nodejs /app/apps/backend/drizzle ./apps/backend/drizzle +COPY --from=builder --chown=nextjs:nodejs /app/apps/backend/drizzle.config.ts ./apps/backend/ + +# Copy built packages +COPY --from=builder --chown=nextjs:nodejs /app/packages ./packages +COPY --from=builder --chown=nextjs:nodejs /app/node_modules ./node_modules +COPY --from=builder --chown=nextjs:nodejs /app/package.json ./ +COPY --from=builder --chown=nextjs:nodejs /app/pnpm-workspace.yaml ./ + +# Install production dependencies only +RUN pnpm install --prod + +# Install drizzle-kit locally in backend for migrations +RUN cd apps/backend && pnpm add drizzle-kit@0.31.1 + +# Copy startup script +COPY --chown=nextjs:nodejs docker-entrypoint.sh ./ +RUN chmod +x docker-entrypoint.sh USER nextjs -EXPOSE 3000 +# Expose frontend port (Next.js) +EXPOSE 12008 -ENV PORT 3000 -ENV HOSTNAME "0.0.0.0" +# Health check +HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \ + CMD curl -f http://localhost:12008/health || exit 1 -CMD ["node", "server.js"] +# Start both backend and frontend +CMD ["./docker-entrypoint.sh"] \ No newline at end of file diff --git a/LICENSE b/LICENSE index 5469257f..d7707332 100644 --- a/LICENSE +++ b/LICENSE @@ -1,660 +1,7 @@ -# GNU AFFERO GENERAL PUBLIC LICENSE +Copyright 2024 MetaMCP, James Zhang -Version 3, 19 November 2007 +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the β€œSoftware”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -Copyright (C) 2007 Free Software Foundation, Inc. - +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - -## Preamble - -The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - -The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains -free software for all its users. - -When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - -Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - -A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - -The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - -An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing -under this license. - -The precise terms and conditions for copying, distribution and -modification follow. - -## TERMS AND CONDITIONS - -### 0. Definitions. - -"This License" refers to version 3 of the GNU Affero General Public -License. - -"Copyright" also means copyright-like laws that apply to other kinds -of works, such as semiconductor masks. - -"The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - -To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of -an exact copy. The resulting work is called a "modified version" of -the earlier work or a work "based on" the earlier work. - -A "covered work" means either the unmodified Program or a work based -on the Program. - -To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - -To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user -through a computer network, with no transfer of a copy, is not -conveying. - -An interactive user interface displays "Appropriate Legal Notices" to -the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -### 1. Source Code. - -The "source code" for a work means the preferred form of the work for -making modifications to it. "Object code" means any non-source form of -a work. - -A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - -The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - -The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - -The Corresponding Source need not include anything that users can -regenerate automatically from other parts of the Corresponding Source. - -The Corresponding Source for a work in source code form is that same -work. - -### 2. Basic Permissions. - -All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - -You may make, run and propagate covered works that you do not convey, -without conditions so long as your license otherwise remains in force. -You may convey covered works to others for the sole purpose of having -them make modifications exclusively for you, or provide you with -facilities for running those works, provided that you comply with the -terms of this License in conveying all material for which you do not -control copyright. Those thus making or running the covered works for -you must do so exclusively on your behalf, under your direction and -control, on terms that prohibit them from making any copies of your -copyrighted material outside their relationship with you. - -Conveying under any other circumstances is permitted solely under the -conditions stated below. Sublicensing is not allowed; section 10 makes -it unnecessary. - -### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - -No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - -When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such -circumvention is effected by exercising rights under this License with -respect to the covered work, and you disclaim any intention to limit -operation or modification of the work as a means of enforcing, against -the work's users, your or third parties' legal rights to forbid -circumvention of technological measures. - -### 4. Conveying Verbatim Copies. - -You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -### 5. Conveying Modified Source Versions. - -You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these -conditions: - -- a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. -- b) The work must carry prominent notices stating that it is - released under this License and any conditions added under - section 7. This requirement modifies the requirement in section 4 - to "keep intact all notices". -- c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. -- d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - -A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -### 6. Conveying Non-Source Forms. - -You may convey a covered work in object code form under the terms of -sections 4 and 5, provided that you also convey the machine-readable -Corresponding Source under the terms of this License, in one of these -ways: - -- a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. -- b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the Corresponding - Source from a network server at no charge. -- c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. -- d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. -- e) Convey the object code using peer-to-peer transmission, - provided you inform other peers where the object code and - Corresponding Source of the work are being offered to the general - public at no charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - -A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, -family, or household purposes, or (2) anything designed or sold for -incorporation into a dwelling. In determining whether a product is a -consumer product, doubtful cases shall be resolved in favor of -coverage. For a particular product received by a particular user, -"normally used" refers to a typical or common use of that class of -product, regardless of the status of the particular user or of the way -in which the particular user actually uses, or expects or is expected -to use, the product. A product is a consumer product regardless of -whether the product has substantial commercial, industrial or -non-consumer uses, unless such uses represent the only significant -mode of use of the product. - -"Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to -install and execute modified versions of a covered work in that User -Product from a modified version of its Corresponding Source. The -information must suffice to ensure that the continued functioning of -the modified object code is in no case prevented or interfered with -solely because modification has been made. - -If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - -The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or -updates for a work that has been modified or installed by the -recipient, or for the User Product in which it has been modified or -installed. Access to a network may be denied when the modification -itself materially and adversely affects the operation of the network -or violates the rules and protocols for communication across the -network. - -Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -### 7. Additional Terms. - -"Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders -of that material) supplement the terms of this License with terms: - -- a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or -- b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or -- c) Prohibiting misrepresentation of the origin of that material, - or requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or -- d) Limiting the use for publicity purposes of names of licensors - or authors of the material; or -- e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or -- f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions - of it) with contractual assumptions of liability to the recipient, - for any liability that these contractual assumptions directly - impose on those licensors and authors. - -All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - -Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; the -above requirements apply either way. - -### 8. Termination. - -You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -### 9. Acceptance Not Required for Having Copies. - -You are not required to accept this License in order to receive or run -a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -### 10. Automatic Licensing of Downstream Recipients. - -Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - -An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - -You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -### 11. Patents. - -A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - -A contributor's "essential patent claims" are all patent claims owned -or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - -Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - -In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - -If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - -A patent license is "discriminatory" if it does not include within the -scope of its coverage, prohibits the exercise of, or is conditioned on -the non-exercise of one or more of the rights that are specifically -granted under this License. You may not convey a covered work if you -are a party to an arrangement with a third party that is in the -business of distributing software, under which you make payment to the -third party based on the extent of your activity of conveying the -work, and under which the third party grants, to any of the parties -who would receive the covered work from you, a discriminatory patent -license (a) in connection with copies of the covered work conveyed by -you (or copies made from those copies), or (b) primarily for and in -connection with specific products or compilations that contain the -covered work, unless you entered into that arrangement, or that patent -license was granted, prior to 28 March 2007. - -Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -### 12. No Surrender of Others' Freedom. - -If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under -this License and any other pertinent obligations, then as a -consequence you may not convey it at all. For example, if you agree to -terms that obligate you to collect a royalty for further conveying -from those to whom you convey the Program, the only way you could -satisfy both those terms and this License would be to refrain entirely -from conveying the Program. - -### 13. Remote Network Interaction; Use with the GNU General Public License. - -Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your -version supports such interaction) an opportunity to receive the -Corresponding Source of your version by providing access to the -Corresponding Source from a network server at no charge, through some -standard or customary means of facilitating copying of software. This -Corresponding Source shall include the Corresponding Source for any -work covered by version 3 of the GNU General Public License that is -incorporated pursuant to the following paragraph. - -Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - -### 14. Revised Versions of this License. - -The Free Software Foundation may publish revised and/or new versions -of the GNU Affero General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever -published by the Free Software Foundation. - -If the Program specifies that a proxy can decide which future versions -of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - -Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -### 15. Disclaimer of Warranty. - -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT -WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE -DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR -CORRECTION. - -### 16. Limitation of Liability. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR -CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES -ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT -NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR -LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM -TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER -PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -### 17. Interpretation of Sections 15 and 16. - -If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - -END OF TERMS AND CONDITIONS - -## How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively state -the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as - published by the Free Software Foundation, either version 3 of the - License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper -mail. - -If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for -the specific requirements. - -You should also get your employer (if you work as a programmer) or -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. For more information on this, and how to apply and follow -the GNU AGPL, see . \ No newline at end of file +THE SOFTWARE IS PROVIDED β€œAS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 7ea518e4..80dbb0a2 100644 --- a/README.md +++ b/README.md @@ -1,230 +1,160 @@ -# MetaMCP (Unified middleware MCP to manage all your MCPs) +# πŸš€ MetaMCP (Aggregate MCP servers & apply middlewares; host & emit unified MCP servers out) -[![](https://dcbadge.limes.pink/api/server/mNsyat7mFX)](https://discord.gg/mNsyat7mFX) - -MetaMCP is the unified middleware MCP to manage all your MCPs. It uses a GUI fullstack app (this repo) and a local MCP proxy to achieve this. (see our latest npm repo [mcp-server-metamcp](https://github.com/metatool-ai/mcp-server-metamcp)) - -A few feature highlights: - -- GUI app to manage multiple MCP server integrations all together. -- Support ANY MCP clients (e.g., Claude Desktop, Cursor, etc.) because MetaMCP is a MCP server. -- Support prompts, resources, tools under MCP. -- Support multi-workspace: e.g., activate a workspace of DB1 or switch to DB2 in another workspace, preventing polluting context of DB1 to your MCP Client. -- Tool level toggle on/off - -The app is also self hostable, free and open source. There is also a cloud version. You can try how this app works using cloud version but I actually encourage you to self host if you are familiar with docker: it will provide unlimited access with lower latency, full private operations on your end. - -Check out demo videos at https://metamcp.com/. Here is an overview screenshot. +
-![MetaMCP Overview Screenshot](screenshot.png) -![MetaMCP Tool Management Screenshot](tool_management.png) +[![](https://dcbadge.limes.pink/api/server/mNsyat7mFX)](https://discord.gg/mNsyat7mFX) -## Verified Platform +
-- [x] Windows (after MCP official typescript SDK 1.8.0, which we updated accordingly, it works) https://github.com/metatool-ai/metatool-app/issues/15 -- [x] Mac -- [x] Linux +**MetaMCP** is a powerful MCP proxy that lets you dynamically aggregate MCP servers into a unified MCP server, and apply middlewares. MetaMCP itself is a MCP server so it can be easily plugged into **ANY** MCP clients. -## Installation +![MetaMCP Diagram](metamcp.svg) -To get started with this self hostable version of MetaMCP App, the eastiest way is to clone the repository and use Docker Compose to run it. +## 🎯 Use Cases +- πŸ”„ **One-click server switching** - Save and switch MCP server configs for Claude Desktop, Cursor, or custom agents +- πŸ” **Enhanced MCP inspector** - Debug with saved server configurations +- πŸ”— **Unified server aggregation** - Join multiple servers for simplified agent development +- ⚑ **Dynamic tool management** - Quick toggles to enable/disable servers and tools +- πŸ› οΈ **Middleware support** - Apply logging, error handling, and custom transformations +- 🎯 **Dynamic search rules** - Apply search rules and return different toolsets for agent builders -```bash -git clone https://github.com/metatool-ai/metatool-app.git -cd metatool-app -cp example.env .env -docker compose up --build -d -``` +Generally developers can use MetaMCP as **infrastructure** to host dynamically composed MCP servers through a unified endpoint, and build agents on top of it. -Then open http://localhost:12005 in your browser to open MetaMCP App. +Quick demo video: https://youtu.be/Cf6jVd2saAs -It is recommended to have npx (node.js based mcp) and uvx (python based mcp) installed globally. -To install uv check: https://docs.astral.sh/uv/getting-started/installation/ +![MetaMCP Screenshot](metamcp_screenshot.png) -### Default Remote Mode SSE endpoint for MetaMCP +## πŸ“– Concepts -The recommended way to connect to MetaMCP is via the SSE endpoint: +### πŸ–₯️ **MCP Server** +A MCP server configuration that tells MetaMCP how to start a MCP server. -``` -http://localhost:12007/sse with Authorization: Bearer -``` - -Alternatively, if you cannot set headers, you can use this URL-based endpoint: - -``` -http://localhost:12007/api-key//sse +```json +"HackerNews": { + "type": "STDIO", + "command": "uvx", + "args": ["mcp-hn"] +} ``` -You can get the API key from the MetaMCP App's API Keys page. +### 🏷️ **MetaMCP Namespace** +- Group one or more MCP servers into a namespace +- Enable/disable MCP servers or at tool level +- Apply middlewares to MCP requests and responses -### For Local Access +### 🌐 **MetaMCP Endpoint** +- Create endpoints and assign namespace to endpoints +- Multiple MCP servers in the namespace will be aggregated and emitted as a MetaMCP endpoint +- Choose auth level and strategy +- Host through **SSE** or **Streamable HTTP** transports -You can still use these methods even if your workspace is in Default Remote Mode. +### βš™οΈ **Middleware** +- Intercepts and transforms MCP requests and responses at namespace level +- **Built-in example**: "Filter inactive tools" - optimizes tool context for LLMs +- **Future ideas**: tool logging, error traces, validation, scanning -#### Claude Desktop Configuration +### πŸ” **Inspector** +Similar to the official MCP inspector, but with **saved server configs** - MetaMCP automatically creates configurations so you can debug MetaMCP endpoints immediately. -For Claude Desktop, the config json should look like this: +## πŸš€ Quick Start -```json -{ - "mcpServers": { - "MetaMCP": { - "command": "npx", - "args": ["-y", "@metamcp/mcp-server-metamcp@latest"], - "env": { - "METAMCP_API_KEY": "", - "METAMCP_API_BASE_URL": "http://localhost:12005" - } - } - } -} -``` +### **🐳 Run with Docker Compose (Recommended)** -#### Cursor Configuration - -For Cursor, env vars aren't easy to get typed in so you may use args instead: +Clone repo, prepare `.env`, and start with docker compose: ```bash -npx -y @metamcp/mcp-server-metamcp@latest --metamcp-api-key --metamcp-api-base-url http://localhost:12005 +git clone https://github.com/metatool-ai/metamcp.git +cd metamcp +cp example.env .env +docker compose up --build -d ``` -#### Windows Configuration +### **πŸ’» Local Development** -For Windows, you can use the following command for Cursor: +Still recommend running postgres through docker for easy setup: ```bash -cmd /c npx -y @metamcp/mcp-server-metamcp@latest --metamcp-api-key --metamcp-api-base-url http://localhost:12005 -``` - -Or configure it using json: - -```json -{ - "mcpServers": { - "MetaMCP": { - "command": "cmd", - "args": [ - "/c", - "npx", - "-y", - "@metamcp/mcp-server-metamcp@latest" - ], - "env": { - "METAMCP_API_KEY": "", - "METAMCP_API_BASE_URL": "http://localhost:12005" - } - } - } -} +pnpm install +pnpm dev ``` -#### Standalone SSE Server +## πŸ”Œ MCP Protocol Compatibility -You can also use the following command to start a standalone SSE server: - -```bash -mcp-server-metamcp --metamcp-api-key --transport sse --port 12006 -``` +- βœ… **Tools, Resources, and Prompts** supported +- βœ… **OAuth-enabled MCP servers** tested for 03-26 version -Then use following json configuration: +If you have questions, feel free to leave **GitHub issues** or **PRs**. -```json -{ - "mcpServers": { - "MetaMCP": { - "url": "http://localhost:12006" - } - } -} -``` +## ❄️ Cold Start Problem and Custom Dockerfile -#### Smithery Windows Configuration +⚠️ **Cold start issue** for hosting `stdio` type MCP servers: +- First run will be slow as package managers (uvx, npx) install dependencies +- Happens again on docker restart -You can also use Smithery to run MCPs in docker on cloud for max compatibility: +πŸ› οΈ **Solution**: Customize the Dockerfile to add dependencies or pre-install packages to reduce cold start time. -```bash -smithery run @metatool-ai/mcp-server-metamcp --config '{"metamcpApiKey":""}' -``` +## πŸ” Authentication -Or configure it in your Claude Desktop configuration file: +- πŸ›‘οΈ **Better Auth** for frontend and backend (trpc procedures) +- πŸͺ **Session cookies** enforce internal MCP proxy connections +- πŸ”‘ **API key auth** for external access via `Authorization: Bearer ` header -```json -{ - "mcpServers": { - "MetaMCP": { - "command": "smithery", - "args": [ - "run", - "@metatool-ai/mcp-server-metamcp", - "--config", - "{\"metamcpApiKey\":\"\"}" - ] - } - } -} -``` +## πŸ—οΈ Architecture -You can get the API key from the MetaMCP App's API Keys page. +- **Frontend**: Next.js +- **Backend**: Express.js with tRPC, hosting MCPs through TS SDK and internal proxy +- **Auth**: Better Auth +- **Structure**: Standalone monorepo with Turborepo and Docker publishing -## Architecture Overview +### πŸ“Š Sequence Diagram -Note that prompts and resources are also covered similar to tools. +*Note: Prompts and resources follow similar patterns to tools.* ```mermaid sequenceDiagram participant MCPClient as MCP Client (e.g., Claude Desktop) - participant MetaMCPMCP as MetaMCP MCP Server - participant MetaMCPApp as MetaMCP App - participant MCPServers as Installed MCP Servers in MetaMCP App + participant MetaMCP as MetaMCP Server + participant MCPServers as Installed MCP Servers - MCPClient ->> MetaMCPMCP: Request list tools - MetaMCPMCP ->> MetaMCPApp: Get tools configuration & status - MetaMCPApp ->> MetaMCPMCP: Return tools configuration & status + MCPClient ->> MetaMCP: Request list tools loop For each listed MCP Server - MetaMCPMCP ->> MCPServers: Request list_tools - MCPServers ->> MetaMCPMCP: Return list of tools + MetaMCP ->> MCPServers: Request list_tools + MCPServers ->> MetaMCP: Return list of tools end - MetaMCPMCP ->> MetaMCPMCP: Aggregate tool lists - MetaMCPMCP ->> MCPClient: Return aggregated list of tools + MetaMCP ->> MetaMCP: Aggregate tool lists & apply middleware + MetaMCP ->> MCPClient: Return aggregated list of tools - MCPClient ->> MetaMCPMCP: Call tool - MetaMCPMCP ->> MCPServers: call_tool to target MCP Server - MCPServers ->> MetaMCPMCP: Return tool response - MetaMCPMCP ->> MCPClient: Return tool response + MCPClient ->> MetaMCP: Call tool + MetaMCP ->> MCPServers: call_tool to target MCP Server + MCPServers ->> MetaMCP: Return tool response + MetaMCP ->> MCPClient: Return tool response ``` -## Basic HTTP Authentication (Optional) - -MetaMCP App includes optional basic HTTP authentication to protect your self-hosted instance. To enable it: +## πŸ—ΊοΈ Roadmap -1. Set the following environment variables in your `.env` file: - ```bash - BASIC_AUTH_USERNAME=your-username - BASIC_AUTH_PASSWORD=your-secure-password - ``` +**Potential next steps:** -2. Restart your application: - ```bash - docker compose down - docker compose up --build -d - ``` +- [ ] πŸ”Œ Headless Admin API access +- [ ] πŸ” Dynamically apply search rules on MetaMCP endpoints +- [ ] πŸ› οΈ More middlewares +- [ ] πŸ’¬ Chat/Agent Playground +- [ ] πŸ§ͺ Testing & Evaluation for MCP tool selection optimization +- [ ] ⚑ Dynamically generate MCP servers -When enabled, all routes will require basic HTTP authentication except for: -- Static assets (`/_next/static`, `/_next/image`, `/favicon.ico`) -- API routes (`/api/*`) - these use their own API key authentication -- Other public paths (you can customize this in `middleware.ts`) +## 🀝 Contributing -If you don't set these environment variables, the authentication will be disabled and the app will work as before. +We welcome contributions! See details at **[CONTRIBUTING.md](CONTRIBUTING.md)** -**Security Note**: Make sure to use a strong password and consider using HTTPS in production environments. +## πŸ“„ License +**MIT** -## License +Would appreciate if you mentioned with back links if your projects use the code. -GNU AGPL v3 +## πŸ™ Credits -## Credits -- Used some oauth codes in https://github.com/modelcontextprotocol/inspector -- (Deprecated) Demo video uses MCP Client [5ire](https://5ire.app/) +Some code inspired by: +- [MCP Inspector](https://github.com/modelcontextprotocol/inspector) +- [MCP Proxy Server](https://github.com/adamwattis/mcp-proxy-server) diff --git a/app/(sidebar-layout)/(container)/api-keys/page.tsx b/app/(sidebar-layout)/(container)/api-keys/page.tsx deleted file mode 100644 index 40334685..00000000 --- a/app/(sidebar-layout)/(container)/api-keys/page.tsx +++ /dev/null @@ -1,247 +0,0 @@ -'use client'; - -import { Copy, Eye, EyeOff, Plus, Trash2 } from 'lucide-react'; -import { useState } from 'react'; -import useSWR from 'swr'; - -import { - createApiKey, - deleteApiKey, - getProjectApiKeys, -} from '@/app/actions/api-keys'; -import { Button } from '@/components/ui/button'; -import { - Dialog, - DialogContent, - DialogDescription, - DialogFooter, - DialogHeader, - DialogTitle, -} from '@/components/ui/dialog'; -import { Input } from '@/components/ui/input'; -import { Label } from '@/components/ui/label'; -import { useProjects } from '@/hooks/use-projects'; -import { useToast } from '@/hooks/use-toast'; -import { ApiKey } from '@/types/api-key'; - -export default function ApiKeysPage() { - const { currentProject } = useProjects(); - const { - data: apiKeys, - error, - isLoading, - mutate, - } = useSWR( - currentProject?.uuid ? `${currentProject?.uuid}/api-keys` : null, - () => getProjectApiKeys(currentProject?.uuid || '') - ); - const [revealed, setRevealed] = useState(false); - const [isCreateDialogOpen, setIsCreateDialogOpen] = useState(false); - const [newKeyName, setNewKeyName] = useState(''); - const [isCreating, setIsCreating] = useState(false); - const [keyToDelete, setKeyToDelete] = useState(null); - const [isDeleting, setIsDeleting] = useState(false); - const { toast } = useToast(); - - const copyApiKey = async (apiKey: string) => { - await navigator.clipboard.writeText(apiKey); - toast({ - title: 'API Key copied', - description: 'The API key has been copied to your clipboard.', - }); - }; - - const toggleReveal = () => { - setRevealed(!revealed); - }; - - const maskApiKey = (key: string) => { - return `${key.slice(0, 5)}${'β€’'.repeat(key.length - 5)}`; - }; - - const handleCreateApiKey = async () => { - try { - if (!currentProject?.uuid) { - return; - } - setIsCreating(true); - await createApiKey(currentProject.uuid, newKeyName); - await mutate(); - setIsCreateDialogOpen(false); - setNewKeyName(''); - toast({ - title: 'API Key created', - description: 'Your new API key has been created successfully.', - }); - } catch (error) { - toast({ - title: 'Error', - description: - error instanceof Error ? error.message : 'Failed to create API key', - variant: 'destructive', - }); - } finally { - setIsCreating(false); - } - }; - - const handleDeleteApiKey = async () => { - if (!currentProject?.uuid || !keyToDelete?.uuid) { - return; - } - try { - setIsDeleting(true); - await deleteApiKey(currentProject?.uuid, keyToDelete.uuid); - await mutate(); - setKeyToDelete(null); - toast({ - title: 'API Key deleted', - description: 'Your API key has been deleted successfully.', - }); - } catch (error) { - toast({ - title: 'Error', - description: - error instanceof Error ? error.message : 'Failed to delete API key', - variant: 'destructive', - }); - } finally { - setIsDeleting(false); - } - }; - - return ( -
-
-

API Keys

- -
- -
- {isLoading ? ( -
Loading...
- ) : error ? ( -
- {error instanceof Error - ? error.message - : 'Failed to fetch API keys'} -
- ) : ( -
-
- Your API keys are used to authenticate requests to the MetaMCP - API. Keep them secure and do not share them with others. -
- {apiKeys && apiKeys.length === 0 && ( -
- No API keys yet. Create one to get started. -
- )} - {apiKeys && - apiKeys.map((apiKey) => ( -
- {apiKey.name && ( -
{apiKey.name}
- )} -
- - {revealed ? apiKey.api_key : maskApiKey(apiKey.api_key)} - - - - -
-
- ))} -
- )} -
- - - - - Create API Key - - Create a new API key for your project. You can optionally give it - a name to help identify its purpose. - - -
-
- - setNewKeyName(e.target.value)} - /> -
-
- - - - - - - - !open && setKeyToDelete(null)}> - - - Delete API Key - - Are you sure you want to delete this API key - {keyToDelete?.name ? ` "${keyToDelete.name}"` : ''}? This action - cannot be undone. - - - - - - - - -
- ); -} diff --git a/app/(sidebar-layout)/(container)/custom-mcp-servers/[uuid]/page.tsx b/app/(sidebar-layout)/(container)/custom-mcp-servers/[uuid]/page.tsx deleted file mode 100644 index f2fb14de..00000000 --- a/app/(sidebar-layout)/(container)/custom-mcp-servers/[uuid]/page.tsx +++ /dev/null @@ -1,403 +0,0 @@ -'use client'; - -import { ArrowLeft, Check, ChevronsUpDown, Pencil, Trash2 } from 'lucide-react'; -import Link from 'next/link'; -import { useRouter } from 'next/navigation'; -import { use } from 'react'; -import { useEffect, useState } from 'react'; -import { useForm } from 'react-hook-form'; -import useSWR from 'swr'; - -import { - deleteCustomMcpServerByUuid, - getCustomMcpServerByUuid, - toggleCustomMcpServerStatus, - updateCustomMcpServer, -} from '@/app/actions/custom-mcp-servers'; -import { Button } from '@/components/ui/button'; -import { - Command, - CommandEmpty, - CommandGroup, - CommandInput, - CommandItem, - CommandList, -} from '@/components/ui/command'; -import { - Dialog, - DialogContent, - DialogHeader, - DialogTitle, - DialogTrigger, -} from '@/components/ui/dialog'; -import { - Form, - FormControl, - FormField, - FormItem, - FormLabel, - FormMessage, -} from '@/components/ui/form'; -import { Input } from '@/components/ui/input'; -import { - Popover, - PopoverContent, - PopoverTrigger, -} from '@/components/ui/popover'; -import { Switch } from '@/components/ui/switch'; -import { Textarea } from '@/components/ui/textarea'; -import { McpServerStatus } from '@/db/schema'; -import { useCodes } from '@/hooks/use-codes'; -import { useProfiles } from '@/hooks/use-profiles'; -import { CustomMcpServer } from '@/types/custom-mcp-server'; - -export default function CustomMcpServerDetailPage({ - params, -}: { - params: Promise<{ uuid: string }>; -}) { - const { currentProfile } = useProfiles(); - const { uuid } = use(params); - const router = useRouter(); - const [isEditing, setIsEditing] = useState(false); - const [openCombobox, setOpenCombobox] = useState(false); - - const form = useForm({ - defaultValues: { - name: '', - description: '', - additionalArgs: '', - env: '', - code_uuid: '', - }, - }); - - const { codes } = useCodes(); - - const { - data: customMcpServer, - error, - mutate, - } = useSWR( - uuid && currentProfile?.uuid - ? ['getCustomMcpServerByUuid', uuid, currentProfile?.uuid] - : null, - () => getCustomMcpServerByUuid(currentProfile?.uuid || '', uuid!) - ); - - useEffect(() => { - if (customMcpServer) { - form.reset({ - name: customMcpServer.name, - description: customMcpServer.description || '', - additionalArgs: customMcpServer.additionalArgs.join(' '), - env: Object.entries(customMcpServer.env) - .map(([key, value]) => `${key}=${value}`) - .join('\n'), - code_uuid: customMcpServer.code_uuid || '', - }); - } - }, [customMcpServer, form]); - - const onSubmit = async (data: { - name: string; - description: string; - additionalArgs: string; - env: string; - code_uuid: string; - }) => { - if (!customMcpServer || !currentProfile?.uuid) return; - - // Process args and env before submission - const processedData = { - ...data, - additionalArgs: - data.additionalArgs.trim().split(/\s+/).map((arg) => arg.trim()) || [], - env: - Object.fromEntries( - data.env - .split('\n') - .filter((line) => line.includes('=')) - .map((line) => { - const [key, ...values] = line.split('='); - return [key.trim(), values.join('=').trim()]; - }) - ) || {}, - code_uuid: data.code_uuid, - }; - - await updateCustomMcpServer( - currentProfile.uuid, - customMcpServer.uuid, - processedData - ); - await mutate(); - setIsEditing(false); - }; - - const handleDelete = async () => { - if (!customMcpServer || !currentProfile?.uuid) return; - if (confirm('Are you sure you want to delete this Custom MCP server?')) { - await deleteCustomMcpServerByUuid( - currentProfile.uuid, - customMcpServer.uuid - ); - router.push('/custom-mcp-servers'); - } - }; - - if (error) return
Failed to load Custom MCP server
; - if (!customMcpServer) return
Loading...
; - - return ( -
-
- - -
- - - - - - - Edit Custom MCP Server - -
- - ( - - Name - - - - - - )} - /> - ( - - Description - -