Skip to content

Commit 59adfdc

Browse files
committed
initial commit
0 parents  commit 59adfdc

28 files changed

Lines changed: 6222 additions & 0 deletions

.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# EditorConfig helps maintain consistent coding styles
2+
# https://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
[*.{js,ts,json,yml,yaml,md}]
13+
indent_style = space
14+
indent_size = 2
15+
16+
[*.md]
17+
trim_trailing_whitespace = false
18+
19+
[Makefile]
20+
indent_style = tab

.env.example

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Pinecone Read-Only MCP Configuration
2+
3+
# Required: Your Pinecone API key
4+
PINECONE_API_KEY=your-pinecone-api-key-here
5+
6+
# Optional: Pinecone index name (default: rag-hybrid)
7+
PINECONE_INDEX_NAME=rag-hybrid
8+
9+
# Optional: Reranking model (default: bge-reranker-v2-m3)
10+
PINECONE_RERANK_MODEL=bge-reranker-v2-m3
11+
12+
# Optional: Default number of results to return (default: 10)
13+
PINECONE_TOP_K=10
14+
15+
# Optional: Logging level (default: INFO)
16+
# Options: DEBUG, INFO, WARNING, ERROR, CRITICAL
17+
PINECONE_READ_ONLY_MCP_LOG_LEVEL=INFO
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## To Reproduce
13+
Steps to reproduce the behavior:
14+
1. Run command '...'
15+
2. Use configuration '...'
16+
3. Execute query '...'
17+
4. See error
18+
19+
## Expected Behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
## Actual Behavior
23+
A clear and concise description of what actually happened.
24+
25+
## Error Messages
26+
```
27+
Paste any error messages or logs here
28+
```
29+
30+
## Environment
31+
- OS: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
32+
- Node.js version: [e.g., 18.19.0]
33+
- Package version: [e.g., 0.1.0]
34+
- Installation method: [e.g., npm, yarn, pnpm, global]
35+
36+
## Configuration
37+
```json
38+
// Your configuration (remove sensitive data like API keys)
39+
{
40+
"index_name": "...",
41+
"rerank_model": "..."
42+
}
43+
```
44+
45+
## Additional Context
46+
Add any other context about the problem here.
47+
48+
## Possible Solution
49+
If you have ideas on how to fix the issue, please share them here.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Problem/Motivation
13+
Is your feature request related to a problem? Please describe.
14+
Example: I'm always frustrated when [...]
15+
16+
## Proposed Solution
17+
Describe the solution you'd like to see implemented.
18+
19+
## Alternatives Considered
20+
Describe any alternative solutions or features you've considered.
21+
22+
## Use Cases
23+
Describe specific use cases for this feature:
24+
1. Use case 1...
25+
2. Use case 2...
26+
27+
## Example Usage
28+
If applicable, provide example code or configuration showing how this feature would be used:
29+
30+
```typescript
31+
// Example usage
32+
```
33+
34+
## Additional Context
35+
Add any other context, screenshots, or examples about the feature request here.
36+
37+
## Are you willing to contribute?
38+
- [ ] Yes, I can help implement this feature
39+
- [ ] Yes, I can help test this feature
40+
- [ ] No, just suggesting the idea

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Pull Request
2+
3+
## Description
4+
Provide a clear and concise description of what this PR does.
5+
6+
Fixes # (issue number)
7+
8+
## Type of Change
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code quality improvement
14+
- [ ] Performance improvement
15+
16+
## Changes Made
17+
- Change 1
18+
- Change 2
19+
- Change 3
20+
21+
## Testing
22+
Describe the tests you ran to verify your changes:
23+
- [ ] All existing tests pass
24+
- [ ] Added new tests for changes
25+
- [ ] Manual testing performed
26+
27+
### Test Configuration
28+
- Node.js version:
29+
- OS:
30+
31+
## Checklist
32+
- [ ] My code follows the project's style guidelines
33+
- [ ] I have performed a self-review of my code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] I have made corresponding changes to the documentation
36+
- [ ] My changes generate no new warnings or errors
37+
- [ ] I have added tests that prove my fix is effective or that my feature works
38+
- [ ] New and existing unit tests pass locally with my changes
39+
- [ ] Any dependent changes have been merged and published
40+
41+
## Code Quality
42+
- [ ] `npm run typecheck` passes
43+
- [ ] `npm run lint` passes
44+
- [ ] `npm run format:check` passes
45+
- [ ] `npm test` passes
46+
47+
## Screenshots (if applicable)
48+
Add screenshots to help explain your changes.
49+
50+
## Additional Notes
51+
Add any additional notes or context about the PR here.

.github/dependabot.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 10
8+
reviewers:
9+
- "iTinkerBell"
10+
labels:
11+
- "dependencies"
12+
- "automated"
13+
14+
- package-ecosystem: "github-actions"
15+
directory: "/"
16+
schedule:
17+
interval: "monthly"
18+
open-pull-requests-limit: 5
19+
reviewers:
20+
- "iTinkerBell"
21+
labels:
22+
- "ci"
23+
- "automated"

.github/workflows/ci.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [18.x, 20.x, 22.x]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Setup Node.js ${{ matrix.node-version }}
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: ${{ matrix.node-version }}
23+
cache: 'npm'
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Type check
29+
run: npm run typecheck
30+
31+
- name: Lint
32+
run: npm run lint
33+
34+
- name: Check formatting
35+
run: npm run format:check
36+
37+
- name: Build
38+
run: npm run build
39+
40+
- name: Run tests
41+
run: npm test
42+
43+
quality:
44+
runs-on: ubuntu-latest
45+
steps:
46+
- uses: actions/checkout@v4
47+
48+
- name: Setup Node.js
49+
uses: actions/setup-node@v4
50+
with:
51+
node-version: '20.x'
52+
cache: 'npm'
53+
54+
- name: Install dependencies
55+
run: npm ci
56+
57+
- name: Security audit
58+
run: npm audit --audit-level=moderate
59+
continue-on-error: true

.github/workflows/codeql.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches: [ "main" ]
8+
schedule:
9+
- cron: '0 0 * * 1'
10+
11+
jobs:
12+
analyze:
13+
name: Analyze
14+
runs-on: ubuntu-latest
15+
permissions:
16+
actions: read
17+
contents: read
18+
security-events: write
19+
20+
strategy:
21+
fail-fast: false
22+
matrix:
23+
language: [ 'javascript' ]
24+
25+
steps:
26+
- name: Checkout repository
27+
uses: actions/checkout@v4
28+
29+
- name: Initialize CodeQL
30+
uses: github/codeql-action/init@v3
31+
with:
32+
languages: ${{ matrix.language }}
33+
34+
- name: Autobuild
35+
uses: github/codeql-action/autobuild@v3
36+
37+
- name: Perform CodeQL Analysis
38+
uses: github/codeql-action/analyze@v3

.github/workflows/publish.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Publish to npm
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
test:
9+
uses: ./.github/workflows/ci.yml
10+
11+
publish:
12+
runs-on: ubuntu-latest
13+
needs: test
14+
permissions:
15+
contents: read
16+
id-token: write
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: '20.x'
24+
registry-url: 'https://registry.npmjs.org'
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Build
31+
run: npm run build
32+
33+
- name: Publish to npm
34+
run: npm publish --provenance --access public
35+
env:
36+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Dependencies
2+
node_modules/
3+
.pnp
4+
.pnp.js
5+
6+
# Build outputs
7+
dist/
8+
build/
9+
*.tsbuildinfo
10+
11+
# Environment
12+
.env
13+
.env.local
14+
.env.*.local
15+
16+
# Logs
17+
logs/
18+
*.log
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
pnpm-debug.log*
23+
lerna-debug.log*
24+
25+
# Testing
26+
coverage/
27+
28+
# IDE
29+
.vscode/
30+
.idea/
31+
*.swp
32+
*.swo
33+
*~
34+
.DS_Store
35+
36+
# Runtime
37+
*.pid
38+
*.seed
39+
*.pid.lock
40+
41+
# Misc
42+
.npmrc
43+
44+
# Scripts
45+
scripts/*.bat
46+
scripts/*.sh

0 commit comments

Comments
 (0)