Project Files

.pydev-tools

_ast

describe.py

do_work.py

docstrings.py

extract_function.py

extract.py

legacy_handler_2.py

legacy_handler_3.py

legacy_handler.py

migration.py

reference.py

rename.py

workspace_description.md

prompt_examples

dependency_version_migration.txt

hotfix_rework.txt

new_project.txt

performance_optimization.txt

refactory.txt

security_hardening.txt

source_tree_analysis.txt

test_coverage_expansion.txt

scripts

e2e_runPytest_test.cjs

setupVenv.mjs

smokeNew6Tools.ts

smokeNewTools.ts

verify_testfile_fix.ts

verifySetupVenv.ts

skills

pydev-mcp.md

src

tools

_profiling_worker_main.py

analyzeImportsAndDependencies.ts

buildPythonPackage.ts

checkForBugs.ts

checkForBugsInFile.ts

createProjectStructure.ts

createTestFileTool.ts

editTextFile.ts

editTextFileByLine.ts

findFiles.ts

generateRequirementsTxtTool.ts

getSetupStatusTool.ts

getWorkspaceRootTool.ts

inspectEnvironmentTool.ts

installModule.ts

listDirectory.ts

listTools.ts

profileProject.ts

pydevAuditDocstringsTool.ts

pydevDescribeWorkspaceTool.ts

pydevExtractFunctionTool.ts

pydevGenerateReferenceTool.ts

pydevMigrationAuditTool.ts

pydevSafeRenameTool.ts

readTextFile.ts

runLinterAndFormatter.ts

runLinterAndFormatterInFile.ts

runProjectCoverage.ts

runPython.ts

runPythonFile.ts

runPythonFileInteractive.ts

runPythonInteractive.ts

runRepl.ts

runTests.ts

runWithDebuggerTool.ts

saveTextFile.ts

scanProjectSecurity.ts

searchDirectory.ts

setupVenvTool.ts

switchPythonVersion.ts

typeCheckProjectTool.ts

uninstallModule.ts

config.ts

index.ts

test

run_tests.cjs

tools.test.cjs

manifest.json

package-lock.json

package.json

professor_headache.jpg

README.md

setup-venv.sh

tsconfig.json

src / tools / pydevDescribeWorkspaceTool.ts

import { tool } from "@lmstudio/sdk";
import { z } from "zod";

import { runAstHelper } from "../utils/astTools";
import { getToolDefinition } from "../utils/toolRegistry";

const TOOL_DEFINITION = getToolDefinition("pydev_describe_workspace")!;

export const pydevDescribeWorkspaceTool = tool({
  name: TOOL_DEFINITION.name,
  description: `${TOOL_DEFINITION.description} Returns a high-level overview of the project including file purposes (from README/docstrings), dependency direction, and top imports — instant repo context without reading every line.`,
  parameters: {
    includeOverview: z
      .boolean()
      .optional()
      .describe("Whether to include the high-level README/docstring overview (default: true)."),
  },
  implementation: async ({ includeOverview }) => {
    // describe.py always writes a JSON report to <root>/.pydev_workspace.json; the helper
    // reads it back and returns it. includeOverview is accepted for API symmetry but the report
    // includes the overview by default.
    // describe.py <target_path> -- scan the workspace root (".") so README.md and top-level
    // imports are found relative to the project root.
    return runAstHelper("describe.py", [process.cwd()], { timeoutSeconds: 60 });
  },
});