Cursor rule

1---
2description: project structure
3globs: 
4alwaysApply: false
5---
6# Repository Structure
7 
8This document provides an overview of the directory structure for this repository.
9```
10/
11├── .github/                     # GitHub specific configurations
12│   ├── ISSUE_TEMPLATE/          # Templates for creating GitHub issues
13│   │   ├── bug_report.yml       # Template for bug reports
14│   │   ├── config.yml           # Configuration for issue templates
15│   │   └── feature_request.yml  # Template for feature requests
16│   └── workflows/               # GitHub Actions workflows
17│       ├── main.yml             # Main CI/CD workflow (e.g., testing, linting)
18│       └── release.yml          # Workflow for creating releases
19├── .git/                        # Git version control data (usually hidden)
20├── .vscode/                     # VS Code editor configurations
21├── modelcontextprotocol/        # Core package for the Model Context Protocol implementation
22│   ├── node_modules/            # Project dependencies (managed by npm/pnpm/yarn)
23│   ├── scripts/                 # Utility scripts for the package
24│   │   └── publish              # Script for publishing the package
25│   ├── src/                     # Source code for the modelcontextprotocol package
26│   │   ├── index.ts             # Main entry point for the package
27│   │   └── test/                # Unit tests for the package
28│   │       └── index.test.ts    # Tests for the main entry point
29│   ├── .gitignore               # Specifies intentionally untracked files that Git should ignore
30│   ├── .prettierrc              # Configuration file for the Prettier code formatter
31│   ├── eslint.config.mjs        # Configuration file for the ESLint linter
32│   ├── jest.config.ts           # Configuration file for the Jest testing framework
33│   ├── package-lock.json        # Records exact versions of dependencies (npm)
34│   ├── package.json             # Defines package metadata, dependencies, and scripts
35│   ├── pnpm-lock.yaml           # Records exact versions of dependencies (pnpm)
36│   ├── README.md                # README specific to the modelcontextprotocol package
37│   └── tsconfig.json            # TypeScript compiler options for this package
38├── typescript/                  # TypeScript specific implementations or toolkits using the protocol
39│   ├── examples/                # Example usage of the TypeScript toolkit
40│   │   ├── ai-sdk/              # Example using the AI SDK integration
41│   │   │   ├── .env.template    # Template for environment variables
42│   │   │   ├── index.ts         # Example script demonstrating usage
43│   │   │   ├── package.json     # Dependencies for the example
44│   │   │   ├── README.md        # README for the ai-sdk example
45│   │   │   └── tsconfig.json    # TypeScript configuration for the example
46│   │   └── langchain/           # Example using the Langchain integration
47│   │       ├── .env.template    # Template for environment variables
48│   │       ├── index.ts         # Example script demonstrating usage
49│   │       ├── package.json     # Dependencies for the example
50│   │       ├── README.md        # README for the langchain example
51│   │       └── tsconfig.json    # TypeScript configuration for the example
52│   ├── node_modules/            # Project dependencies (managed by npm/pnpm/yarn)
53│   ├── scripts/                 # Utility scripts for the TypeScript packages/workspace
54│   │   └── publish              # Script for publishing the package(s)
55│   ├── src/                     # Source code for the TypeScript toolkit/packages
56│   │   ├── ai-sdk/              # Integration layer for the AI SDK
57│   │   │   ├── index.ts         # Entry point for the AI SDK integration
58│   │   │   └── toolkit.ts       # Toolkit implementation specific to AI SDK
59│   │   ├── langchain/           # Integration layer for Langchain
60│   │   │   ├── index.ts         # Entry point for the Langchain integration
61│   │   │   └── toolkit.ts       # Toolkit implementation specific to Langchain
62│   │   ├── modelcontextprotocol/# Re-export or specific implementation related to the core protocol
63│   │   │   ├── index.ts         # Entry point
64│   │   │   └── toolkit.ts       # Toolkit implementation
65│   │   ├── shared/              # Shared utilities and components for TypeScript packages
66│   │   │   ├── api.ts           # API definitions or clients
67│   │   │   ├── configuration.ts # Configuration handling logic
68│   │   │   ├── functions.ts     # Utility functions
69│   │   │   ├── parameters.ts    # Parameter definitions or handling
70│   │   │   ├── prompts.ts       # Prompt templates or management
71│   │   │   └── tools.ts         # Tool definitions or handling
72│   │   └── test/                # Tests for the TypeScript code
73│   │       └── shared/          # Tests for the shared components
74│   │           ├── configuration.test.ts # Tests for configuration logic
75│   │           └── functions.test.ts     # Tests for utility functions
76│   ├── .gitignore               # Specifies intentionally untracked files that Git should ignore
77│   ├── .prettierrc              # Configuration file for the Prettier code formatter
78│   ├── .vscode/                 # VS Code editor configurations specific to the typescript directory
79│   ├── eslint.config.mjs        # Configuration file for the ESLint linter
80│   ├── jest.config.ts           # Configuration file for the Jest testing framework
81│   ├── package-lock.json        # Records exact versions of dependencies (npm)
82│   ├── package.json             # Defines package metadata, dependencies, and scripts (likely for the workspace)
83│   ├── pnpm-lock.yaml           # Records exact versions of dependencies (pnpm)
84│   ├── pnpm-workspace.yaml      # Defines the pnpm workspace configuration
85│   ├── README.md                # README specific to the TypeScript part of the repository
86│   ├── template.env             # Template for environment variables
87│   ├── tsconfig.json            # Base TypeScript compiler options for the workspace
88│   └── tsup.config.ts           # Configuration for the tsup bundler
89├── .gitignore                   # Specifies intentionally untracked files that Git should ignore at the root level
90├── LICENSE                      # Repository license information
91├── package-lock.json            # Records exact versions of root-level dependencies (if any, potentially for dev tools)
92├── package.json                 # Root package.json, might define workspace root or global dev dependencies
93├── README.md                    # Main README file for the repository
94└── SECURITY.md                  # Security policy and reporting instructions
95```
96