Skip to content

lsfusion/mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lsfusion-mcp

An extensible MCP server hosting multiple tools for lsFusion development. Ships with RAG search tools, syntax validation, and mandatory guidance.

Transports:

  • STDIO for local development / desktop MCP clients.
  • Streamable HTTP for production via Uvicorn (mounted at /mcp).

Core Tools

  • lsfusion_get_guidance(): Fetch mandatory brief and rules.
  • lsfusion_retrieve_docs(query: string, type?: "language" | "paradigm" | "how-to" | "brief" | "rules"): Official documentation search (the five doc-folder sourceTypes from the OpenAI Vector Store; English content only).
  • lsfusion_report_feedback(report): Submit one anonymous, depersonalized reinforcement-quality signal (the feedback-loop sink) — classified by signal_type (doc gap, expectation-mismatch, unclear eval error, missing capability, RAG miss, other). The agent calls it — per the get_guidance workflow rule and only with user consent — when a task hit action-affecting friction. Server-side: anti-abuse caps, best-effort redaction, server-computed dedup_fingerprint, append to the reports event stream. Gated by FEEDBACK_ENABLED. Returns {report_id, status, dedup_fingerprint}. See MCP-FEEDBACK-PLAN.md.

Quickstart (local)

python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

export OPENAI_API_KEY=sk-... RAG_VECTOR_STORE_ID=vs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# STDIO transport
python server.py stdio

# HTTP transport
python server.py http --host 0.0.0.0 --port 8000

Claude Desktop / MCP Inspector (STDIO)

mcp install server.py
mcp dev server.py

Adding new tools

Create a new module under tools/ and register it with @mcp.tool() in server.py (or build an auto-discovery if you prefer). Keep tool signatures simple and JSON-serializable.

Contract / output for lsfusion_retrieve_docs

Returns an array of objects:

{
  "docs": [
    { "source": "documentation-language", "text": "....", "score": 0.73 },
    { "source": "documentation-paradigm", "text": "....", "score": 0.69 }
  ]
}

Sorted by score descending. Structured output is enabled.

Environment variables

  • OPENAI_API_KEY — OpenAI API key (required).
  • RAG_VECTOR_STORE_ID — OpenAI Vector Store id that lsfusion_retrieve_docs searches against (required). Must match the store populated by the ragIngestDocs Jenkins pipeline.
  • EMBEDDING_MODEL — OpenAI embedding model (default text-embedding-3-large).
  • MCP_SERVER_VERSION — build identifier (image digest / git sha) stamped into every event log line (default unknown).
  • LOG_DIR — directory for dated JSONL event files. Empty (default) ⇒ event logs go to stderr only. Set it to a writable (uid 10001) bind-mount to also append retrieval-YYYYMMDD.jsonl (Phase A2).
  • QUERY_LOG_MAX_CHARS / ERROR_LOG_MAX_CHARS — caps on the verbatim query / error text stored in logs (default 2000 / 500).

Event logging (retrieve_docs)

Every lsfusion_retrieve_docs call emits one structured JSON line (best-effort — a logging failure never breaks the tool). Envelope {schema_version, event, ts (ISO-8601 UTC ms), server_version, ok} plus {query (capped), type, n_requested, n_results, top_score, latency_ms, results:[{rank, source, file_id, filename, score}]} — no chunk text; error_class/error_message on failure. Written to stderr (keeps the STDIO transport's stdout protocol channel clean; Docker's json-file captures stderr anyway), and additionally to a dated file when LOG_DIR is set. See MCP-FEEDBACK-PLAN.md.

Docker

Build and run:

docker build -t lsfusion/mcp:latest .
docker run --rm -p 8000:8000 \
  -e OPENAI_API_KEY=$OPENAI_API_KEY \
  -e RAG_VECTOR_STORE_ID=$RAG_VECTOR_STORE_ID \
  lsfusion/mcp:latest

Or via Compose:

docker compose up --build

Production secrets (where to store keys)

Do not hardcode secrets. Options:

  1. Kubernetes Secrets + external secret store

    • Store secrets in AWS Secrets Manager / GCP Secret Manager / HashiCorp Vault.
    • Sync into K8s as Secret via External Secrets Operator.
    • Mount as env vars in the Deployment:
      env:
        - name: OPENAI_API_KEY
          valueFrom: { secretKeyRef: { name: mcp-secrets, key: openai } }
        - name: RAG_VECTOR_STORE_ID
          valueFrom: { configMapKeyRef: { name: mcp-config, key: rag_vector_store_id } }
  2. Docker Swarm / Compose secrets

    • Use secrets: and mount files into the container, then export into env at entrypoint:
      services:
        mcp:
          image: lsfusion/mcp:latest
          secrets: [openai_key]
          environment:
            - RAG_VECTOR_STORE_ID
      secrets:
        openai_key: { file: ./secrets/openai_key.txt }
    • Read them in an entrypoint script:
      export OPENAI_API_KEY="$(cat /run/secrets/openai_key)"
      exec python server.py http --host 0.0.0.0 --port 8000
  3. Cloud run / App services (ECS, Cloud Run, App Service)

    • Inject as environment variables wired to a managed secret store (e.g., AWS Parameter Store / Secrets Manager).
    • Rotate periodically; grant least-privilege IAM.
  4. CI/CD (GitHub Actions)

    • Store in Actions Secrets.
    • At build/deploy time pass them into the container as env vars or bake only into the runtime environment (never into the image).

This app reads credentials from environment variables, so your orchestrator should inject them from a secure store. Prefer secret stores over committing .env files.

Hardening checklist

  • Run as non-root (done in Dockerfile).
  • Keep logs to stdout/stderr; in STDIO mode, avoid extra prints (MCP uses stdio).
  • Set request timeouts and retries in your MCP client / reverse proxy.
  • Add health endpoint (optional) and readiness checks on /mcp handshake.

HTTP transport configuration (FastMCP)

FastMCP reads host/port from environment variables:

  • MCP_HOST (default: 127.0.0.1)
  • MCP_PORT (default: 8000)

Examples:

Local run

export OPENAI_API_KEY=sk-... RAG_VECTOR_STORE_ID=vs_xxxx
export MCP_HOST=0.0.0.0 MCP_PORT=8000
python server.py http

Docker

docker run --rm -p 8000:8000 \  -e OPENAI_API_KEY=$OPENAI_API_KEY \  -e RAG_VECTOR_STORE_ID=$RAG_VECTOR_STORE_ID \  -e MCP_HOST=0.0.0.0 \  -e MCP_PORT=8000 \  ghcr.io/<org>/<repo>/lsfusion-mcp:latest

About

MCP server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors